Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::PaiDswApi::Instance.

Initializers

import ros_cdk_paidswapi
ros_cdk_paidswapi.Instance(
  scope: Construct,
  id: str,
  ecs_spec: typing.Union[str, IResolvable],
  image_url: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  accessibility: typing.Union[str, IResolvable] = None,
  datasets: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DatasetsProperty]]] = None,
  environment_variables: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  labels: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LabelsProperty]]] = None,
  save_image: typing.Union[bool, IResolvable] = None,
  user_vpc: typing.Union[IResolvable, UserVpcProperty] = None,
  workspace_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

ecs_spec^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ecsSpec: The ECS specification of the instance.

image_url^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property imageUrl: The mirror address.

instance_name^Required

• Type: typing.Union[str, 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: typing.Union[str, 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: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DatasetsProperty]]]

Property datasets: A collection of datasets.

environment_variables^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property environmentVariables: Environment variable.

labels^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LabelsProperty]]]

Property labels: User-defined labels.

save_image^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

user_vpc^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, UserVpcProperty]

Property userVpc: User vpc configuration.

workspace_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceId: The Id of the workspace.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_paidswapi
ros_cdk_paidswapi.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_accessibility^Required

attr_accessibility: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Accessibility: Whether the workspace is visible to others.

attr_datasets^Required

attr_datasets: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Datasets: A collection of datasets.

attr_ecs_spec^Required

attr_ecs_spec: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EcsSpec: The ECS specification of the instance.

attr_environment_variables^Required

attr_environment_variables: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EnvironmentVariables: Environment variable.

attr_image_url^Required

attr_image_url: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ImageUrl: The mirror address.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceId: The first ID of the resource.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceName: The instance name.

attr_instance_url^Required

attr_instance_url: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceUrl: The instance address.

attr_jupyterlab_url^Required

attr_jupyterlab_url: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute JupyterlabUrl: The jupyterlab address.

attr_labels^Required

attr_labels: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Labels: User-defined labels.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PaymentType: The payment type of the resource.

attr_terminal_url^Required

attr_terminal_url: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TerminalUrl: The terminal address.

attr_user_vpc^Required

attr_user_vpc: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute UserVpc: User vpc configuration.

attr_web_ide_url^Required

attr_web_ide_url: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WebIDEUrl: The web IDE address.

attr_workspace_id^Required

attr_workspace_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WorkspaceId: The Id of the workspace.

props^Required

props: InstanceProps

• Type: InstanceProps