Skip to content

Workspace

This class encapsulates and extends the ROS resource type ALIYUN::PAI::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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc 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

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

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.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
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 object Attribute AdminNames: List of administrator account names.
AttrCreator object Attribute Creator: The user ID of the creator.
AttrDescription object Attribute Description: Workspace description, no more than 80 characters.
AttrDisplayName object Attribute DisplayName: It is recommended that you name the workspace based on the business attribute to identify the purpose of the workspace.
AttrEnvTypes object Attribute EnvTypes: Environments contained in the workspace:.
AttrExtraInfos object Attribute ExtraInfos: Additional information, currently including TenantId (tenant ID).
AttrOwner object Attribute Owner: Workspace owner ID, displayed when Verbose is true.
AttrUsers object Attribute Users: List of users.
AttrWorkspaceId object Attribute WorkspaceId: The ID of the workspace.
AttrWorkspaceName object Attribute WorkspaceName: The workspace name.
Props WorkspaceProps No description.

NodeRequired

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

The construct tree node associated with this construct.


EnvRequired

public IResourceEnvironment Env { get; }
  • Type: AlibabaCloud.SDK.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.


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 object AttrAdminNames { get; }
  • Type: object

Attribute AdminNames: List of administrator account names.


AttrCreatorRequired

public object AttrCreator { get; }
  • Type: object

Attribute Creator: The user ID of the creator.


AttrDescriptionRequired

public object AttrDescription { get; }
  • Type: object

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


AttrDisplayNameRequired

public object AttrDisplayName { get; }
  • Type: object

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 object AttrEnvTypes { get; }
  • Type: object

Attribute EnvTypes: Environments contained in the workspace:.


AttrExtraInfosRequired

public object AttrExtraInfos { get; }
  • Type: object

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


AttrOwnerRequired

public object AttrOwner { get; }
  • Type: object

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


AttrUsersRequired

public object AttrUsers { get; }
  • Type: object

Attribute Users: List of users.


AttrWorkspaceIdRequired

public object AttrWorkspaceId { get; }
  • Type: object

Attribute WorkspaceId: The ID of the workspace.


AttrWorkspaceNameRequired

public object AttrWorkspaceName { get; }
  • Type: object

Attribute WorkspaceName: The workspace name.


PropsRequired

public WorkspaceProps Props { get; }