Skip to content

IWorkspace

Represents a Workspace.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_admin_names typing.Union[str, ros_cdk_core.IResolvable] Attribute AdminNames: List of administrator account names.
attr_creator typing.Union[str, ros_cdk_core.IResolvable] Attribute Creator: The user ID of the creator.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: Workspace description, no more than 80 characters.
attr_display_name typing.Union[str, 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 typing.Union[str, ros_cdk_core.IResolvable] Attribute EnvTypes: Environments contained in the workspace:.
attr_extra_infos typing.Union[str, ros_cdk_core.IResolvable] Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
attr_owner typing.Union[str, ros_cdk_core.IResolvable] Attribute Owner: Workspace owner ID, displayed when Verbose is true.
attr_users typing.Union[str, ros_cdk_core.IResolvable] Attribute Users: List of users.
attr_workspace_id typing.Union[str, ros_cdk_core.IResolvable] Attribute WorkspaceId: The ID of the workspace.
attr_workspace_name typing.Union[str, ros_cdk_core.IResolvable] Attribute WorkspaceName: The workspace name.
props WorkspaceProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

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.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_admin_namesRequired

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

Attribute AdminNames: List of administrator account names.


attr_creatorRequired

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

Attribute Creator: The user ID of the creator.


attr_descriptionRequired

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

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


attr_display_nameRequired

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

Attribute EnvTypes: Environments contained in the workspace:.


attr_extra_infosRequired

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

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


attr_ownerRequired

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

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


attr_usersRequired

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

Attribute Users: List of users.


attr_workspace_idRequired

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

Attribute WorkspaceId: The ID of the workspace.


attr_workspace_nameRequired

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

Attribute WorkspaceName: The workspace name.


propsRequired

props: WorkspaceProps