Skip to content

Workspace

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Workspace, which is used to create a workspace.

Initializers 

import ros_cdk_pai
ros_cdk_pai.Workspace(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

descriptionRequired

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

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

env_typesRequired

  • 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

  • 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

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

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_pai
ros_cdk_pai.Workspace.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_admin_names ros_cdk_core.IResolvable Attribute AdminNames: List of administrator account names.
attr_creator ros_cdk_core.IResolvable Attribute Creator: The user ID of the creator.
attr_description ros_cdk_core.IResolvable Attribute Description: Workspace description, no more than 80 characters.
attr_display_name ros_cdk_core.IResolvable Attribute DisplayName: It is recommended that you name the workspace based on the business attribute to identify the purpose of the workspace.
attr_env_types ros_cdk_core.IResolvable Attribute EnvTypes: Environments contained in the workspace:.
attr_extra_infos ros_cdk_core.IResolvable Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
attr_owner ros_cdk_core.IResolvable Attribute Owner: Workspace owner ID, displayed when Verbose is true.
attr_users ros_cdk_core.IResolvable Attribute Users: List of users.
attr_workspace_id ros_cdk_core.IResolvable Attribute WorkspaceId: The ID of the workspace.
attr_workspace_name ros_cdk_core.IResolvable Attribute WorkspaceName: The workspace name.

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_admin_namesRequired 

attr_admin_names: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AdminNames: List of administrator account names.

attr_creatorRequired 

attr_creator: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Creator: The user ID of the creator.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: Workspace description, no more than 80 characters.

attr_display_nameRequired 

attr_display_name: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_env_typesRequired 

attr_env_types: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnvTypes: Environments contained in the workspace:.

attr_extra_infosRequired 

attr_extra_infos: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).

attr_ownerRequired 

attr_owner: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Owner: Workspace owner ID, displayed when Verbose is true.

attr_usersRequired 

attr_users: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Users: List of users.

attr_workspace_idRequired 

attr_workspace_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute WorkspaceId: The ID of the workspace.

attr_workspace_nameRequired 

attr_workspace_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute WorkspaceName: The workspace name.