CloneDisks
- Implements: ICloneDisks
This class encapsulates and extends the ROS resource type ALIYUN::ECS::CloneDisks.
Initializers
import ros_cdk_ecs
ros_cdk_ecs.CloneDisks(
scope: Construct,
id: str,
disk_category: typing.Union[str, IResolvable],
multi_attach: typing.Union[str, IResolvable],
size: typing.Union[typing.Union[int, float], IResolvable],
source_disk_id: typing.Union[str, IResolvable],
bursting_enabled: typing.Union[bool, IResolvable] = None,
disk_name: typing.Union[str, IResolvable] = None,
encrypted: typing.Union[bool, IResolvable] = None,
kms_key_id: typing.Union[str, IResolvable] = None,
performance_level: typing.Union[str, IResolvable] = None,
provisioned_iops: typing.Union[typing.Union[int, float], IResolvable] = None,
resource_group_id: typing.Union[str, 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. |
disk_category | typing.Union[str, ros_cdk_core.IResolvable] | Property diskCategory: The type of the new disk. |
multi_attach | typing.Union[str, ros_cdk_core.IResolvable] | Property multiAttach: Specifies whether to enable the multi-attach feature for the new disk. |
size | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property size: The size of the new disk, in GiB. |
source_disk_id | typing.Union[str, ros_cdk_core.IResolvable] | Property sourceDiskId: The ID of the source disk. |
bursting_enabled | typing.Union[bool, ros_cdk_core.IResolvable] | Property burstingEnabled: Specifies whether to enable performance bursting for the new disk. |
disk_name | typing.Union[str, ros_cdk_core.IResolvable] | Property diskName: The name of the new disk. |
encrypted | typing.Union[bool, ros_cdk_core.IResolvable] | Property encrypted: Specifies whether to encrypt the new disk. |
kms_key_id | typing.Union[str, ros_cdk_core.IResolvable] | Property kmsKeyId: The ID of the KMS key used to encrypt the disk. |
performance_level | typing.Union[str, ros_cdk_core.IResolvable] | Property performanceLevel: The performance level of the new ESSD cloud disk. |
provisioned_iops | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group. |
tags | typing.List[TagsProperty] | Property tags: Tags to attach to disk. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
disk_categoryRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property diskCategory: The type of the new disk.
Valid values:
cloud_essd: ESSD cloud disk.cloud_auto: ESSD AutoPL cloud disk.cloud_essd_entry: ESSD Entry cloud disk.cloud_regional_disk_auto: regional disk.
Disk type limits for cloning
- A non-regional disk can be cloned only as a non-regional disk.
- A regional disk can be cloned only as a regional disk.
multi_attachRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property multiAttach: Specifies whether to enable the multi-attach feature for the new disk.
Valid values:
Disabled: Disables the multi-attach feature.Enabled: Enables the multi-attach feature. You can set this parameter toEnabledonly for ESSD cloud disks.
sizeRequired
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property size: The size of the new disk, in GiB.
The value must be greater than or equal to the size of the source disk. The value range varies based on the DiskCategory value:
cloud_essd: The value range depends on thePerformanceLevelvalue.PL0: 1 to 65,536PL1: 20 to 65,536PL2: 461 to 65,536PL3: 1,261 to 65,536cloud_auto: 1 to 65,536cloud_essd_entry: 10 to 32,768cloud_regional_disk_auto: 10 to 65,536
source_disk_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property sourceDiskId: The ID of the source disk.
bursting_enabledOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property burstingEnabled: Specifies whether to enable performance bursting for the new disk.
Valid values:
true: Enables performance bursting.false: Disables performance bursting.
This parameter is valid only when
DiskCategoryis set tocloud_auto. For more information, see ESSD AutoPL cloud disks.
disk_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property diskName: The name of the new disk.
The name must be 2 to 128 characters in length. It must start with a letter and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). Default value: none.
encryptedOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property encrypted: Specifies whether to encrypt the new disk.
Valid values:
true: The disk is encrypted.false: The disk is not encrypted. Default value: false.
kms_key_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property kmsKeyId: The ID of the KMS key used to encrypt the disk.
performance_levelOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property performanceLevel: The performance level of the new ESSD cloud disk.
Valid values:
PL0: A single disk can deliver up to 10,000 random read/write IOPS.PL1: A single disk can deliver up to 50,000 random read/write IOPS.PL2: A single disk can deliver up to 100,000 random read/write IOPS.PL3: A single disk can deliver up to 1,000,000 random read/write IOPS.
This parameter is required when
DiskCategoryis set tocloud_essd.
provisioned_iopsOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.
Valid values:
- You cannot set this parameter for disks that are 3 GiB or smaller in size.
- For disks that are 4 GiB or larger in size, the value must be in the range of
[0, min(1000 * Size - baseline performance, 50000)]. baseline performance =max(min(1800 + 50 * Size, 50000), 3000).
This parameter is valid only when
DiskCategoryis set tocloud_auto. For more information, see ESSD AutoPL cloud disks.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: Tags to attach to disk.
Max support 20 tags to add during create disk. 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_ecs
ros_cdk_ecs.CloneDisks.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_disk_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DiskIds: The IDS of the disk. |
props | CloneDisksProps | 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_disk_idsRequired
attr_disk_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DiskIds: The IDS of the disk.
propsRequired
props: CloneDisksProps
- Type: CloneDisksProps