ResourceGroup
- Implements: IResourceGroup
This class encapsulates and extends the ROS resource type ALIYUN::DataWorks::ResourceGroup.
Initializers
import ros_cdk_dataworks
ros_cdk_dataworks.ResourceGroup(
scope: Construct,
id: str,
name: typing.Union[str, IResolvable],
payment_type: typing.Union[str, IResolvable],
vpc_id: typing.Union[str, IResolvable],
v_switch_id: typing.Union[str, IResolvable],
auto_renew_enabled: typing.Union[bool, IResolvable] = None,
payment_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
payment_duration_unit: typing.Union[str, IResolvable] = None,
remark: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
spec: typing.Union[typing.Union[int, float], IResolvable] = None,
tags: typing.List[TagsProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
name | typing.Union[str, ros_cdk_core.IResolvable] | Property name: The name of a common resource group that creates a common resource group must start with a letter and can contain letters, numbers, underscores (_), up to 128 characters. |
payment_type | typing.Union[str, ros_cdk_core.IResolvable] | Property paymentType: The type of payment for resource groups, PrePaid represents annual and monthly payments, and PostPaid represents payment by volume. |
vpc_id | typing.Union[str, ros_cdk_core.IResolvable] | Property vpcId: The default bound VPC ID. |
v_switch_id | typing.Union[str, ros_cdk_core.IResolvable] | Property vSwitchId: The default bound switch ID. |
auto_renew_enabled | typing.Union[bool, ros_cdk_core.IResolvable] | Property autoRenewEnabled: Whether to renew automatically. |
payment_duration | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property paymentDuration: Paid time. |
payment_duration_unit | typing.Union[str, ros_cdk_core.IResolvable] | Property paymentDurationUnit: Paid time unit. |
remark | typing.Union[str, ros_cdk_core.IResolvable] | Property remark: Remarks for creating a common resource group can contain letters, Chinese, numbers, underscores (_), up to 128 characters. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: Alibaba Cloud Resource Group ID. |
spec | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property spec: Resource group specifications, unit CU, required when the resource group payment mode is PrePaid. |
tags | typing.List[TagsProperty] | Property tags: Tags to attach to ResourceGroup. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The name of a common resource group that creates a common resource group must start with a letter and can contain letters, numbers, underscores (_), up to 128 characters.
payment_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property paymentType: The type of payment for resource groups, PrePaid represents annual and monthly payments, and PostPaid represents payment by volume.
vpc_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: The default bound VPC ID.
v_switch_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vSwitchId: The default bound switch ID.
auto_renew_enabledOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property autoRenewEnabled: Whether to renew automatically.
payment_durationOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property paymentDuration: Paid time.
Default is 1.
payment_duration_unitOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property paymentDurationUnit: Paid time unit.
Valid values: Month: represents monthly subscription Year: represents annual subscription. Default is Month.
remarkOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property remark: Remarks for creating a common resource group can contain letters, Chinese, numbers, underscores (_), up to 128 characters.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: Alibaba Cloud Resource Group ID.
specOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property spec: Resource group specifications, unit CU, required when the resource group payment mode is PrePaid.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: Tags to attach to ResourceGroup.
Max support 20 tags to add during create ResourceGroup. Each tag with two properties Key and Value, and Key is required.
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_dataworks
ros_cdk_dataworks.ResourceGroup.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_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Id: Creates a unique identifier for a common resource group. |
props | ResourceGroupProps | 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_idRequired
attr_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Id: Creates a unique identifier for a common resource group.
propsRequired
props: ResourceGroupProps
- Type: ResourceGroupProps