Workspace

• Implements: @alicloud/ros-cdk-pai.datasource.IWorkspace

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)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: WorkspaceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

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

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 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: string | IResolvable;

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

Attribute AdminNames: List of administrator account names.

attrCreator^Required

public readonly attrCreator: string | IResolvable;

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

Attribute Creator: The user ID of the creator.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

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

Attribute Description: The description of the workspace.

attrDisplayName^Required

public readonly attrDisplayName: string | IResolvable;

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

Attribute DisplayName: The display name of the workspace.

attrEnvTypes^Required

public readonly attrEnvTypes: string | IResolvable;

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

Attribute EnvTypes: The environments of the workspace.

attrExtraInfos^Required

public readonly attrExtraInfos: string | IResolvable;

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

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

attrIsDefault^Required

public readonly attrIsDefault: string | IResolvable;

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

Attribute IsDefault: Default Workspace.

attrUsers^Required

public readonly attrUsers: string | IResolvable;

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

Attribute Users: List of users.

attrWorkspaceId^Required

public readonly attrWorkspaceId: string | IResolvable;

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

Attribute WorkspaceId: The first ID of the resource.

attrWorkspaceName^Required

public readonly attrWorkspaceName: string | IResolvable;

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

Attribute WorkspaceName: The name of the workspace.

props^Required

public readonly props: WorkspaceProps;

• Type: WorkspaceProps