WorkspaceResource

• Implements: IWorkspaceResource

This class encapsulates and extends the ROS resource type ALIYUN::PAI::WorkspaceResource.

Initializers

import ros_cdk_pai
ros_cdk_pai.WorkspaceResource(
  scope: Construct,
  id: str,
  env_type: typing.Union[str, IResolvable],
  resource_type: typing.Union[str, IResolvable],
  workspace_id: typing.Union[str, IResolvable],
  workspace_resource_name: typing.Union[str, IResolvable],
  group_name: typing.Union[str, IResolvable] = None,
  is_default: typing.Union[bool, IResolvable] = None,
  spec: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

env_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property envType: Environment type, possible values: - dev: Development environment.

• prod: Production environment.

resource_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceType: The resource types.

Valid values: MaxCompute ECS Lingjun ACS FLINK

workspace_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceId: The ID of the workspace to which the workspace belongs.

workspace_resource_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceResourceName: The resource name.

group_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property groupName: Resource group name.

If you want to obtain a resource group name, see ListResources.

is_default^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property isDefault: Whether it is the default resource, each resource type has a default resource.

Possible values:

• true: is the default resource.
• false: Not the default resource.

spec^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property spec: Resource configuration, required for public resource groups of DLC, enter the content: {"clusterType": "share"}.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_pai
ros_cdk_pai.WorkspaceResource.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute CreateTime: Create UTC time in ISO8601 format.

attr_env_type^Required

attr_env_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EnvType: Environment type, possible values:.

attr_group_name^Required

attr_group_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute GroupName: Resource group name.

If you want to obtain a resource group name, see ListResources.

attr_is_default^Required

attr_is_default: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute IsDefault: Whether it is the default resource, each resource type has a default resource.

attr_resource_id^Required

attr_resource_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ResourceId: The resource ID.

attr_resource_type^Required

attr_resource_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ResourceType: Resource type, possible values:.

attr_spec^Required

attr_spec: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Spec: Resource configuration, required for public resource groups of DLC, enter the content.

attr_workspace_id^Required

attr_workspace_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WorkspaceId: The ID of the workspace to which the workspace belongs.

attr_workspace_resource_name^Required

attr_workspace_resource_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WorkspaceResourceName: The resource name.

props^Required

props: WorkspaceResourceProps

• Type: WorkspaceResourceProps