Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::PaiDswApi::Instance, which is used to create a Data Science Workshop (DSW) instance.

Initializers 

import com.aliyun.ros.cdk.paidswapi.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ecsSpec(java.lang.String)
    .ecsSpec(IResolvable)
    .imageUrl(java.lang.String)
    .imageUrl(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
//  .accessibility(java.lang.String)
//  .accessibility(IResolvable)
//  .datasets(IResolvable)
//  .datasets(java.util.List<IResolvable)
//  .datasets(DatasetsProperty>)
//  .environmentVariables(IResolvable)
//  .environmentVariables(java.util.Map<java.lang.String, java.lang.Object>)
//  .labels(IResolvable)
//  .labels(java.util.List<IResolvable)
//  .labels(LabelsProperty>)
//  .saveImage(java.lang.Boolean)
//  .saveImage(IResolvable)
//  .userVpc(IResolvable)
//  .userVpc(UserVpcProperty)
//  .workspaceId(java.lang.String)
//  .workspaceId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
ecsSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ecsSpec: The ECS specification of the instance.
imageUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageUrl: The mirror address.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The instance name.
accessibility java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accessibility: Whether the workspace is visible to others.
datasets com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDatasetsProperty> Property datasets: A collection of datasets.
environmentVariables com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property environmentVariables: Environment variable.
labels com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLabelsProperty> Property labels: User-defined labels.
saveImage java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property saveImage: Whether to close the instance after saving the environment.
userVpc com.aliyun.ros.cdk.core.IResolvable OR UserVpcProperty Property userVpc: User vpc configuration.
workspaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workspaceId: The Id of the workspace.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

ecsSpecRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ecsSpec: The ECS specification of the instance.

imageUrlRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageUrl: The mirror address.

instanceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The instance name.

Format requirements:

  • Can only contain letters, numbers and underscores (_).
  • It cannot exceed 27 characters.

accessibilityOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accessibility: Whether the workspace is visible to others.

Valid values:

  • PUBLIC: Visible to all users of the workspace.
  • PRIVATE: Only visible to yourself and the administrator of the workspace.

datasetsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDatasetsProperty>

Property datasets: A collection of datasets.

environmentVariablesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property environmentVariables: Environment variable.

labelsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLabelsProperty>

Property labels: User-defined labels.

saveImageOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property saveImage: Whether to close the instance after saving the environment.

userVpcOptional

Property userVpc: User vpc configuration.

workspaceIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property workspaceId: The Id of the workspace.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.paidswapi.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAccessibility com.aliyun.ros.cdk.core.IResolvable Attribute Accessibility: Whether the workspace is visible to others.
attrDatasets com.aliyun.ros.cdk.core.IResolvable Attribute Datasets: A collection of datasets.
attrEcsSpec com.aliyun.ros.cdk.core.IResolvable Attribute EcsSpec: The ECS specification of the instance.
attrEnvironmentVariables com.aliyun.ros.cdk.core.IResolvable Attribute EnvironmentVariables: Environment variable.
attrImageUrl com.aliyun.ros.cdk.core.IResolvable Attribute ImageUrl: The mirror address.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The first ID of the resource.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: The instance name.
attrInstanceUrl com.aliyun.ros.cdk.core.IResolvable Attribute InstanceUrl: The instance address.
attrJupyterlabUrl com.aliyun.ros.cdk.core.IResolvable Attribute JupyterlabUrl: The jupyterlab address.
attrLabels com.aliyun.ros.cdk.core.IResolvable Attribute Labels: User-defined labels.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The payment type of the resource.
attrTerminalUrl com.aliyun.ros.cdk.core.IResolvable Attribute TerminalUrl: The terminal address.
attrUserVpc com.aliyun.ros.cdk.core.IResolvable Attribute UserVpc: User vpc configuration.
attrWebIdeUrl com.aliyun.ros.cdk.core.IResolvable Attribute WebIDEUrl: The web IDE address.
attrWorkspaceId com.aliyun.ros.cdk.core.IResolvable Attribute WorkspaceId: The Id of the workspace.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAccessibilityRequired 

public IResolvable getAttrAccessibility();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Accessibility: Whether the workspace is visible to others.

attrDatasetsRequired 

public IResolvable getAttrDatasets();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Datasets: A collection of datasets.

attrEcsSpecRequired 

public IResolvable getAttrEcsSpec();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EcsSpec: The ECS specification of the instance.

attrEnvironmentVariablesRequired 

public IResolvable getAttrEnvironmentVariables();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnvironmentVariables: Environment variable.

attrImageUrlRequired 

public IResolvable getAttrImageUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ImageUrl: The mirror address.

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The first ID of the resource.

attrInstanceNameRequired 

public IResolvable getAttrInstanceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: The instance name.

attrInstanceUrlRequired 

public IResolvable getAttrInstanceUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceUrl: The instance address.

attrJupyterlabUrlRequired 

public IResolvable getAttrJupyterlabUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute JupyterlabUrl: The jupyterlab address.

attrLabelsRequired 

public IResolvable getAttrLabels();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Labels: User-defined labels.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The payment type of the resource.

attrTerminalUrlRequired 

public IResolvable getAttrTerminalUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TerminalUrl: The terminal address.

attrUserVpcRequired 

public IResolvable getAttrUserVpc();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UserVpc: User vpc configuration.

attrWebIdeUrlRequired 

public IResolvable getAttrWebIdeUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute WebIDEUrl: The web IDE address.

attrWorkspaceIdRequired 

public IResolvable getAttrWorkspaceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute WorkspaceId: The Id of the workspace.