WorkspaceProps
Properties for defining a Workspace.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-pai-workspace
Initializer
import { WorkspaceProps } from '@alicloud/ros-cdk-pai'
const workspaceProps: WorkspaceProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
description |
string | @alicloud/ros-cdk-core.IResolvable |
Property description: Workspace description, no more than 80 characters. |
envTypes |
@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] |
Property envTypes: Environments contained in the workspace: - Simple mode only production environment (prod). |
workspaceName |
string | @alicloud/ros-cdk-core.IResolvable |
Property workspaceName: The workspace name. |
displayName |
string | @alicloud/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
public readonly description: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property description: Workspace description, no more than 80 characters.
envTypesRequired
public readonly envTypes: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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).
workspaceNameRequired
public readonly workspaceName: string | IResolvable;
- Type: string | @alicloud/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.
displayNameOptional
public readonly displayName: string | IResolvable;
- Type: string | @alicloud/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.