Skip to content

Workspace

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Pai;
new Workspace(Construct Scope, string Id, WorkspaceProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props WorkspaceProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • Type: bool

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

private string ToString()

Returns a string representation of this construct.

Synthesize

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

SessionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Pai;
Workspace.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrAdminNames AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute AdminNames: List of administrator account names.
AttrCreator AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Creator: The user ID of the creator.
AttrDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Description: Workspace description, no more than 80 characters.
AttrDisplayName AlibabaCloud.SDK.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 AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EnvTypes: Environments contained in the workspace:.
AttrExtraInfos AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
AttrOwner AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Owner: Workspace owner ID, displayed when Verbose is true.
AttrUsers AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Users: List of users.
AttrWorkspaceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute WorkspaceId: The ID of the workspace.
AttrWorkspaceName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute WorkspaceName: The workspace name.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAdminNamesRequired

public IResolvable AttrAdminNames { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute AdminNames: List of administrator account names.


AttrCreatorRequired

public IResolvable AttrCreator { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Creator: The user ID of the creator.


AttrDescriptionRequired

public IResolvable AttrDescription { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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


AttrDisplayNameRequired

public IResolvable AttrDisplayName { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrEnvTypes { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EnvTypes: Environments contained in the workspace:.


AttrExtraInfosRequired

public IResolvable AttrExtraInfos { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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


AttrOwnerRequired

public IResolvable AttrOwner { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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


AttrUsersRequired

public IResolvable AttrUsers { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Users: List of users.


AttrWorkspaceIdRequired

public IResolvable AttrWorkspaceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute WorkspaceId: The ID of the workspace.


AttrWorkspaceNameRequired

public IResolvable AttrWorkspaceName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute WorkspaceName: The workspace name.