Skip to content

WorkspaceProps

Properties for defining a Workspace.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-pai-workspace

Initializer 

import ros_cdk_pai
ros_cdk_pai.WorkspaceProps(
  description: typing.Union[str, IResolvable],
  env_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  workspace_name: typing.Union[str, IResolvable],
  display_name: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Workspace description, no more than 80 characters.
env_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property envTypes: Environments contained in the workspace: - Simple mode only production environment (prod).
workspace_name typing.Union[str, ros_cdk_core.IResolvable] Property workspaceName: The workspace name.
display_name typing.Union[str, ros_cdk_core.IResolvable] Property displayName: It is recommended that you name the workspace based on the business attribute to identify the purpose of the workspace.

descriptionRequired 

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

Property description: Workspace description, no more than 80 characters.

env_typesRequired 

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

Property envTypes: Environments contained in the workspace: - Simple mode only production environment (prod).

  • Standard mode includes development environment (dev) and production environment (prod).

workspace_nameRequired 

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

Property workspaceName: The workspace name.

The format is as follows:

  • 3 to 23 characters in length and can contain letters, underscores, or numbers.
  • Must start with a large or small letter.
  • Unique in the current region.

display_nameOptional 

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

Property displayName: It is recommended that you name the workspace based on the business attribute to identify the purpose of the workspace.

If not configured, the default value is the workspace name. The format is as follows:

  • 3 to 23 characters in length and can contain letters, underscores, or numbers.
  • Must start with a large or small letter.
  • Unique in the current region.