Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::PaiDswApi::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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrAccessibility();

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

Attribute Accessibility: Whether the workspace is visible to others.

attrDatasets^Required

public java.lang.Object getAttrDatasets();

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

Attribute Datasets: A collection of datasets.

attrEcsSpec^Required

public java.lang.Object getAttrEcsSpec();

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

Attribute EcsSpec: The ECS specification of the instance.

attrEnvironmentVariables^Required

public java.lang.Object getAttrEnvironmentVariables();

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

Attribute EnvironmentVariables: Environment variable.

attrImageUrl^Required

public java.lang.Object getAttrImageUrl();

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

Attribute ImageUrl: The mirror address.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The first ID of the resource.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

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

Attribute InstanceName: The instance name.

attrInstanceUrl^Required

public java.lang.Object getAttrInstanceUrl();

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

Attribute InstanceUrl: The instance address.

attrJupyterlabUrl^Required

public java.lang.Object getAttrJupyterlabUrl();

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

Attribute JupyterlabUrl: The jupyterlab address.

attrLabels^Required

public java.lang.Object getAttrLabels();

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

Attribute Labels: User-defined labels.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: The payment type of the resource.

attrTerminalUrl^Required

public java.lang.Object getAttrTerminalUrl();

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

Attribute TerminalUrl: The terminal address.

attrUserVpc^Required

public java.lang.Object getAttrUserVpc();

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

Attribute UserVpc: User vpc configuration.

attrWebIdeUrl^Required

public java.lang.Object getAttrWebIdeUrl();

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

Attribute WebIDEUrl: The web IDE address.

attrWorkspaceId^Required

public java.lang.Object getAttrWorkspaceId();

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

Attribute WorkspaceId: The Id of the workspace.

props^Required

public InstanceProps getProps();

• Type: InstanceProps