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 { Instance } from '@alicloud/ros-cdk-paidswapi'
new Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	InstanceProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: InstanceProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Instance } from '@alicloud/ros-cdk-paidswapi'
Instance.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

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

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrAccessibility^Required

public readonly attrAccessibility: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Accessibility: Whether the workspace is visible to others.

---

attrDatasets^Required

public readonly attrDatasets: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Datasets: A collection of datasets.

---

attrEcsSpec^Required

public readonly attrEcsSpec: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EcsSpec: The ECS specification of the instance.

---

attrEnvironmentVariables^Required

public readonly attrEnvironmentVariables: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentVariables: Environment variable.

---

attrImageUrl^Required

public readonly attrImageUrl: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageUrl: The mirror address.

---

attrInstanceId^Required

public readonly attrInstanceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The first ID of the resource.

---

attrInstanceName^Required

public readonly attrInstanceName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: The instance name.

---

attrInstanceUrl^Required

public readonly attrInstanceUrl: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceUrl: The instance address.

---

attrJupyterlabUrl^Required

public readonly attrJupyterlabUrl: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute JupyterlabUrl: The jupyterlab address.

---

attrLabels^Required

public readonly attrLabels: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Labels: User-defined labels.

---

attrPaymentType^Required

public readonly attrPaymentType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The payment type of the resource.

---

attrTerminalUrl^Required

public readonly attrTerminalUrl: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute TerminalUrl: The terminal address.

---

attrUserVpc^Required

public readonly attrUserVpc: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute UserVpc: User vpc configuration.

---

attrWebIdeUrl^Required

public readonly attrWebIdeUrl: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute WebIDEUrl: The web IDE address.

---

attrWorkspaceId^Required

public readonly attrWorkspaceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceId: The Id of the workspace.

---