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 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
ecs_spec typing.Union[str, ros_cdk_core.IResolvable] Property ecsSpec: The ECS specification of the instance.
image_url typing.Union[str, ros_cdk_core.IResolvable] Property imageUrl: The mirror address.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The instance name.
accessibility typing.Union[str, ros_cdk_core.IResolvable] Property accessibility: Whether the workspace is visible to others.
datasets typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DatasetsProperty]]] Property datasets: A collection of datasets.
environment_variables typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property environmentVariables: Environment variable.
labels typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LabelsProperty]]] Property labels: User-defined labels.
save_image typing.Union[bool, ros_cdk_core.IResolvable] Property saveImage: Whether to close the instance after saving the environment.
user_vpc typing.Union[ros_cdk_core.IResolvable, UserVpcProperty] Property userVpc: User vpc configuration.
workspace_id typing.Union[str, ros_cdk_core.IResolvable] Property workspaceId: The Id of the workspace.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ecs_specRequired

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

Property ecsSpec: The ECS specification of the instance.

image_urlRequired

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

Property imageUrl: The mirror address.

instance_nameRequired

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

accessibilityOptional

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

datasetsOptional

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

Property datasets: A collection of datasets.

environment_variablesOptional

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

Property environmentVariables: Environment variable.

labelsOptional

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

Property labels: User-defined labels.

save_imageOptional

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

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

user_vpcOptional

Property userVpc: User vpc configuration.

workspace_idOptional

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

Property workspaceId: The Id of the workspace.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_accessibility ros_cdk_core.IResolvable Attribute Accessibility: Whether the workspace is visible to others.
attr_datasets ros_cdk_core.IResolvable Attribute Datasets: A collection of datasets.
attr_ecs_spec ros_cdk_core.IResolvable Attribute EcsSpec: The ECS specification of the instance.
attr_environment_variables ros_cdk_core.IResolvable Attribute EnvironmentVariables: Environment variable.
attr_image_url ros_cdk_core.IResolvable Attribute ImageUrl: The mirror address.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The first ID of the resource.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The instance name.
attr_instance_url ros_cdk_core.IResolvable Attribute InstanceUrl: The instance address.
attr_jupyterlab_url ros_cdk_core.IResolvable Attribute JupyterlabUrl: The jupyterlab address.
attr_labels ros_cdk_core.IResolvable Attribute Labels: User-defined labels.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The payment type of the resource.
attr_terminal_url ros_cdk_core.IResolvable Attribute TerminalUrl: The terminal address.
attr_user_vpc ros_cdk_core.IResolvable Attribute UserVpc: User vpc configuration.
attr_web_ide_url ros_cdk_core.IResolvable Attribute WebIDEUrl: The web IDE address.
attr_workspace_id ros_cdk_core.IResolvable Attribute WorkspaceId: The Id of the workspace.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_accessibilityRequired 

attr_accessibility: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Accessibility: Whether the workspace is visible to others.

attr_datasetsRequired 

attr_datasets: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Datasets: A collection of datasets.

attr_ecs_specRequired 

attr_ecs_spec: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EcsSpec: The ECS specification of the instance.

attr_environment_variablesRequired 

attr_environment_variables: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnvironmentVariables: Environment variable.

attr_image_urlRequired 

attr_image_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageUrl: The mirror address.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The first ID of the resource.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The instance name.

attr_instance_urlRequired 

attr_instance_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceUrl: The instance address.

attr_jupyterlab_urlRequired 

attr_jupyterlab_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute JupyterlabUrl: The jupyterlab address.

attr_labelsRequired 

attr_labels: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Labels: User-defined labels.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The payment type of the resource.

attr_terminal_urlRequired 

attr_terminal_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TerminalUrl: The terminal address.

attr_user_vpcRequired 

attr_user_vpc: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserVpc: User vpc configuration.

attr_web_ide_urlRequired 

attr_web_ide_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute WebIDEUrl: The web IDE address.

attr_workspace_idRequired 

attr_workspace_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute WorkspaceId: The Id of the workspace.