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.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

ecsSpec^Required

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

Property ecsSpec: The ECS specification of the instance.

---

imageUrl^Required

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

Property imageUrl: The mirror address.

---

instanceName^Required

• 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.

---

accessibility^Optional

• 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.

---

datasets^Optional

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

Property datasets: A collection of datasets.

---

environmentVariables^Optional

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

Property environmentVariables: Environment variable.

---

labels^Optional

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

Property labels: User-defined labels.

---

saveImage^Optional

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

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

---

userVpc^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR UserVpcProperty

Property userVpc: User vpc configuration.

---

workspaceId^Optional

• 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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• 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.

x^Required

• 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.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrAccessibility^Required

public IResolvable getAttrAccessibility();

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

Attribute Accessibility: Whether the workspace is visible to others.

---

attrDatasets^Required

public IResolvable getAttrDatasets();

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

Attribute Datasets: A collection of datasets.

---

attrEcsSpec^Required

public IResolvable getAttrEcsSpec();

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

Attribute EcsSpec: The ECS specification of the instance.

---

attrEnvironmentVariables^Required

public IResolvable getAttrEnvironmentVariables();

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

Attribute EnvironmentVariables: Environment variable.

---

attrImageUrl^Required

public IResolvable getAttrImageUrl();

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

Attribute ImageUrl: The mirror address.

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

Attribute InstanceId: The first ID of the resource.

---

attrInstanceName^Required

public IResolvable getAttrInstanceName();

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

Attribute InstanceName: The instance name.

---

attrInstanceUrl^Required

public IResolvable getAttrInstanceUrl();

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

Attribute InstanceUrl: The instance address.

---

attrJupyterlabUrl^Required

public IResolvable getAttrJupyterlabUrl();

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

Attribute JupyterlabUrl: The jupyterlab address.

---

attrLabels^Required

public IResolvable getAttrLabels();

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

Attribute Labels: User-defined labels.

---

attrPaymentType^Required

public IResolvable getAttrPaymentType();

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

Attribute PaymentType: The payment type of the resource.

---

attrTerminalUrl^Required

public IResolvable getAttrTerminalUrl();

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

Attribute TerminalUrl: The terminal address.

---

attrUserVpc^Required

public IResolvable getAttrUserVpc();

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

Attribute UserVpc: User vpc configuration.

---

attrWebIdeUrl^Required

public IResolvable getAttrWebIdeUrl();

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

Attribute WebIDEUrl: The web IDE address.

---

attrWorkspaceId^Required

public IResolvable getAttrWorkspaceId();

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

Attribute WorkspaceId: The Id of the workspace.

---