Workspace

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Workspace, which is used to create a 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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No 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.

---

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

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

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

---

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

Name	Description
isConstruct	Return whether the given object is a Construct.

---

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

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

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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 IResolvable getAttrAdminNames();

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

Attribute AdminNames: List of administrator account names.

---

attrCreator^Required

public IResolvable getAttrCreator();

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

Attribute Creator: The user ID of the creator.

---

attrDescription^Required

public IResolvable getAttrDescription();

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

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

---

attrDisplayName^Required

public IResolvable getAttrDisplayName();

• Type: 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 IResolvable getAttrEnvTypes();

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

Attribute EnvTypes: Environments contained in the workspace:.

---

attrExtraInfos^Required

public IResolvable getAttrExtraInfos();

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

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

---

attrOwner^Required

public IResolvable getAttrOwner();

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

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

---

attrUsers^Required

public IResolvable getAttrUsers();

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

Attribute Users: List of users.

---

attrWorkspaceId^Required

public IResolvable getAttrWorkspaceId();

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

Attribute WorkspaceId: The ID of the workspace.

---

attrWorkspaceName^Required

public IResolvable getAttrWorkspaceName();

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

Attribute WorkspaceName: The workspace name.

---