Skip to content

WorkspaceProps

Properties for defining a Workspace.

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

Initializer 

import com.aliyun.ros.cdk.pai.WorkspaceProps;
WorkspaceProps.builder()
    .description(java.lang.String)
    .description(IResolvable)
    .envTypes(IResolvable)
    .envTypes(java.util.List<java.lang.String)
    .envTypes(IResolvable>)
    .workspaceName(java.lang.String)
    .workspaceName(IResolvable)
//  .displayName(java.lang.String)
//  .displayName(IResolvable)
    .build();

Properties

Name Type Description
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Workspace description, no more than 80 characters.
envTypes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property envTypes: Environments contained in the workspace: - Simple mode only production environment (prod).
workspaceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workspaceName: The workspace name.
displayName java.lang.String OR com.aliyun.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 java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

envTypesRequired 

public java.lang.Object getEnvTypes();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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 java.lang.Object getWorkspaceName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDisplayName();
  • Type: java.lang.String OR com.aliyun.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.