Skip to content

Workspace

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Workspace, which is used to create a workspace.

Initializers 

import { Workspace } from '@alicloud/ros-cdk-pai'
new 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.

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

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

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • 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: Workspace description, no more than 80 characters.
attrDisplayName @alicloud/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 @alicloud/ros-cdk-core.IResolvable Attribute EnvTypes: Environments contained in the workspace:.
attrExtraInfos @alicloud/ros-cdk-core.IResolvable Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
attrOwner @alicloud/ros-cdk-core.IResolvable Attribute Owner: Workspace owner ID, displayed when Verbose is true.
attrUsers @alicloud/ros-cdk-core.IResolvable Attribute Users: List of users.
attrWorkspaceId @alicloud/ros-cdk-core.IResolvable Attribute WorkspaceId: The ID of the workspace.
attrWorkspaceName @alicloud/ros-cdk-core.IResolvable Attribute WorkspaceName: The workspace name.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAdminNamesRequired 

public readonly attrAdminNames: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AdminNames: List of administrator account names.

attrCreatorRequired 

public readonly attrCreator: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Creator: The user ID of the creator.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrDisplayNameRequired 

public readonly attrDisplayName: IResolvable;
  • Type: @alicloud/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.

attrEnvTypesRequired 

public readonly attrEnvTypes: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvTypes: Environments contained in the workspace:.

attrExtraInfosRequired 

public readonly attrExtraInfos: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrOwnerRequired 

public readonly attrOwner: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrUsersRequired 

public readonly attrUsers: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Users: List of users.

attrWorkspaceIdRequired 

public readonly attrWorkspaceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceId: The ID of the workspace.

attrWorkspaceNameRequired 

public readonly attrWorkspaceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute WorkspaceName: The workspace name.