WorkspaceResourceFlink
- Implements: IWorkspaceResourceFlink
This class encapsulates and extends the ROS resource type ALIYUN::PAI::WorkspaceResourceFlink.
Initializers
import ros_cdk_pai
ros_cdk_pai.WorkspaceResourceFlink(
scope: Construct,
id: str,
group_name: typing.Union[str, IResolvable],
resources: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcesProperty]]],
workspace_id: typing.Union[str, IResolvable],
is_default: typing.Union[bool, IResolvable] = None,
option: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
group_name | typing.Union[str, ros_cdk_core.IResolvable] | Property groupName: Resource group name. |
resources | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ResourcesProperty]]] | Property resources: Resource List. |
workspace_id | typing.Union[str, ros_cdk_core.IResolvable] | Property workspaceId: The ID of the workspace to which the workspace belongs. |
is_default | typing.Union[bool, ros_cdk_core.IResolvable] | Property isDefault: Indicates whether it is the default resource. |
option | typing.Union[str, ros_cdk_core.IResolvable] | Property option: Create behavior that supports the following values: - CreateAndAttach: Create resource and bind to workspace - Attach: bind resource to workspace. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
group_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property groupName: Resource group name.
If you want to obtain a resource group name, see [ListResources].
resourcesRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ResourcesProperty]]]
Property resources: Resource List.
workspace_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property workspaceId: The ID of the workspace to which the workspace belongs.
is_defaultOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property isDefault: Indicates whether it is the default resource.
Currently, this parameter only supports the input of true and does not support false.
optionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property option: Create behavior that supports the following values: - CreateAndAttach: Create resource and bind to workspace - Attach: bind resource to workspace.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_pai
ros_cdk_pai.WorkspaceResourceFlink.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The creation time of the resource. |
attr_group_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute GroupName: Resource group name. |
attr_is_default | typing.Union[str, ros_cdk_core.IResolvable] | Attribute IsDefault: Indicates whether it is the default resource. |
attr_resources | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Resources: Resource List. |
props | WorkspaceResourceFlinkProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The creation time of the resource.
attr_group_nameRequired
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_defaultRequired
attr_is_default: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute IsDefault: Indicates whether it is the default resource.
Currently, this parameter only supports the input of true and does not support false.
attr_resourcesRequired
attr_resources: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Resources: Resource List.
propsRequired
props: WorkspaceResourceFlinkProps