Skip to content

IWorkspace

Represents a Workspace.

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node for this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
attrAdminNames string | @alicloud/ros-cdk-core.IResolvable Attribute AdminNames: List of administrator account names.
attrCreator string | @alicloud/ros-cdk-core.IResolvable Attribute Creator: The user ID of the creator.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: Workspace description, no more than 80 characters.
attrDisplayName string | @alicloud/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.
attrEnvTypes string | @alicloud/ros-cdk-core.IResolvable Attribute EnvTypes: Environments contained in the workspace:.
attrExtraInfos string | @alicloud/ros-cdk-core.IResolvable Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
attrOwner string | @alicloud/ros-cdk-core.IResolvable Attribute Owner: Workspace owner ID, displayed when Verbose is true.
attrUsers string | @alicloud/ros-cdk-core.IResolvable Attribute Users: List of users.
attrWorkspaceId string | @alicloud/ros-cdk-core.IResolvable Attribute WorkspaceId: The ID of the workspace.
attrWorkspaceName string | @alicloud/ros-cdk-core.IResolvable Attribute WorkspaceName: The workspace name.
props WorkspaceProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node for this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


attrAdminNamesRequired

public readonly attrAdminNames: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AdminNames: List of administrator account names.


attrCreatorRequired

public readonly attrCreator: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Creator: The user ID of the creator.


attrDescriptionRequired

public readonly attrDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrDisplayNameRequired

public readonly attrDisplayName: string | IResolvable;
  • Type: string | @alicloud/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.


attrEnvTypesRequired

public readonly attrEnvTypes: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EnvTypes: Environments contained in the workspace:.


attrExtraInfosRequired

public readonly attrExtraInfos: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrOwnerRequired

public readonly attrOwner: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrUsersRequired

public readonly attrUsers: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Users: List of users.


attrWorkspaceIdRequired

public readonly attrWorkspaceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceId: The ID of the workspace.


attrWorkspaceNameRequired

public readonly attrWorkspaceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceName: The workspace name.


propsRequired

public readonly props: WorkspaceProps;