Workspace

This class encapsulates and extends the ROS resource type DATASOURCE::PAI::Workspace, which is used to query the information about a Platform for AI (PAI) workspace.

Initializers

import { datasource } from '@alicloud/ros-cdk-pai'
new datasource.Workspace(scope: Construct, id: string, props: WorkspaceProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	WorkspaceProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: WorkspaceProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { datasource } from '@alicloud/ros-cdk-pai'
datasource.Workspace.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrAdminNames	@alicloud/ros-cdk-core.IResolvable	Attribute AdminNames: List of administrator account names.
attrCreator	@alicloud/ros-cdk-core.IResolvable	Attribute Creator: The user ID of the creator.
attrDescription	@alicloud/ros-cdk-core.IResolvable	Attribute Description: The description of the workspace.
attrDisplayName	@alicloud/ros-cdk-core.IResolvable	Attribute DisplayName: The display name of the workspace.
attrEnvTypes	@alicloud/ros-cdk-core.IResolvable	Attribute EnvTypes: The environments of the workspace.
attrExtraInfos	@alicloud/ros-cdk-core.IResolvable	Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
attrIsDefault	@alicloud/ros-cdk-core.IResolvable	Attribute IsDefault: Default Workspace.
attrUsers	@alicloud/ros-cdk-core.IResolvable	Attribute Users: List of users.
attrWorkspaceId	@alicloud/ros-cdk-core.IResolvable	Attribute WorkspaceId: The first ID of the resource.
attrWorkspaceName	@alicloud/ros-cdk-core.IResolvable	Attribute WorkspaceName: The name of the workspace.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrAdminNames^Required

public readonly attrAdminNames: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute AdminNames: List of administrator account names.

---

attrCreator^Required

public readonly attrCreator: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Creator: The user ID of the creator.

---

attrDescription^Required

public readonly attrDescription: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the workspace.

---

attrDisplayName^Required

public readonly attrDisplayName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute DisplayName: The display name of the workspace.

---

attrEnvTypes^Required

public readonly attrEnvTypes: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvTypes: The environments of the workspace.

---

attrExtraInfos^Required

public readonly attrExtraInfos: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrIsDefault^Required

public readonly attrIsDefault: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute IsDefault: Default Workspace.

---

attrUsers^Required

public readonly attrUsers: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Users: List of users.

---

attrWorkspaceId^Required

public readonly attrWorkspaceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceId: The first ID of the resource.

---

attrWorkspaceName^Required

public readonly attrWorkspaceName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceName: The name of the workspace.

---