Workspace

• Implements: IWorkspace

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Workspace.

Initializers

import com.aliyun.ros.cdk.pai.Workspace;
Workspace.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

description^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

envTypes^Required

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

workspaceName^Required

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

displayName^Optional

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.pai.Workspace;
Workspace.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAdminNames^Required

public java.lang.Object getAttrAdminNames();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AdminNames: List of administrator account names.

attrCreator^Required

public java.lang.Object getAttrCreator();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Creator: The user ID of the creator.

attrDescription^Required

public java.lang.Object getAttrDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrDisplayName^Required

public java.lang.Object getAttrDisplayName();

• Type: java.lang.String OR com.aliyun.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.

attrEnvTypes^Required

public java.lang.Object getAttrEnvTypes();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EnvTypes: Environments contained in the workspace:.

attrExtraInfos^Required

public java.lang.Object getAttrExtraInfos();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrOwner^Required

public java.lang.Object getAttrOwner();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUsers^Required

public java.lang.Object getAttrUsers();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Users: List of users.

attrWorkspaceId^Required

public java.lang.Object getAttrWorkspaceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WorkspaceId: The ID of the workspace.

attrWorkspaceName^Required

public java.lang.Object getAttrWorkspaceName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WorkspaceName: The workspace name.

props^Required

public WorkspaceProps getProps();

• Type: WorkspaceProps