Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-paidswapi-instance

Initializer

import ros_cdk_paidswapi
ros_cdk_paidswapi.InstanceProps(
  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
)

Properties

Name Type 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.

ecs_specRequired

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

Property ecsSpec: The ECS specification of the instance.


image_urlRequired

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

Property imageUrl: The mirror address.


instance_nameRequired

instance_name: typing.Union[str, IResolvable]
  • 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

accessibility: typing.Union[str, IResolvable]
  • 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

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

Property datasets: A collection of datasets.


environment_variablesOptional

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

Property environmentVariables: Environment variable.


labelsOptional

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

Property labels: User-defined labels.


save_imageOptional

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

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


user_vpcOptional

user_vpc: typing.Union[IResolvable, UserVpcProperty]

Property userVpc: User vpc configuration.


workspace_idOptional

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

Property workspaceId: The Id of the workspace.