ALIYUN::ECS::Disk is used to create a cloud disk for an Elastic Compute Service (ECS) instance.
Syntax
{
"Type": "ALIYUN::ECS::Disk",
"Properties": {
"StorageSetId": String,
"Description": String,
"Tags": List,
"AutoSnapshotPolicyId": String,
"Encrypted": Boolean,
"DiskName": String,
"DiskCategory": String,
"ResourceGroupId": String,
"KMSKeyId": String,
"DeleteAutoSnapshot": Boolean,
"SnapshotId": String,
"StorageSetPartitionNumber": Integer,
"PerformanceLevel": String,
"ZoneId": String,
"Size": Integer,
"BurstingEnabled": Boolean,
"ProvisionedIops": Integer,
"MultiAttach": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
ResourceGroupId | String | No | Yes | The ID of the resource group to which the cloud disk belongs. | None. |
ZoneId | String | Yes | No | The ID of the zone. | None. |
DiskName | String | No | No | The name of the cloud disk. | The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https:// . |
Description | String | No | No | The description of the cloud disk. | The description must be 2 to 256 characters in length. The description cannot start with http:// or https:// . |
Tags | List | No | No | The tags that you want to add to the cloud disk. | You can add up to 20 tags. For more information, see Tags properties. |
DiskCategory | String | No | No | The category of the cloud disk. | Default value: cloud. Valid values:
|
SnapshotId | String | No | No | The ID of the snapshot. | If you specify the SnapshotId property and the Size property at the same time, the value of the SnapshotId property takes precedence. The actual size of the created cloud disk is the size of the specified snapshot. Note Snapshots that were created on or before July 15, 2013 cannot be used to create cloud disks. |
PerformanceLevel | String | No | No | The performance level (PL) of the ESSD. | Default value: PL1. Valid values:
|
Size | Integer | No | No | The size of the cloud disk. | Valid values:
Unit: GiB. The value of this property must be greater than or equal to the size of the specified snapshot. |
BurstingEnabled | Boolean | No | No | Specifies whether to enable the burst mode for the cloud disk. | Default value: false. Valid values:
|
ProvisionedIops | Integer | No | No | The IOPS that is preset in the cloud disk. | None. |
AutoSnapshotPolicyId | String | No | No | The ID of the automatic snapshot policy. | None. |
Encrypted | Boolean | No | No | Specifies whether to encrypt the cloud disk. | Default value: false. Valid values:
|
DeleteAutoSnapshot | Boolean | No | No | Specifies whether to delete the automatic snapshots of the cloud disk when the cloud disk is released. | Default value: true. Valid values:
|
StorageSetId | String | No | No | The ID of the storage set. | None. |
KMSKeyId | String | No | No | The ID of the Key Management Service (KMS) key that is used by the cloud disk. | None. |
StorageSetPartitionNumber | Integer | No | No | The number of partitions in the storage set. | None. |
MultiAttach | String | No | No | Specifies whether to enable the multi-attach feature for the cloud disk. | Default value: Disabled. Valid values:
Note Cloud disks for which the multi-attach feature is enabled support only the pay-as-you-go billing method. |
Tags syntax
"Tags" : [
{
"Value" : String,
"Key" : String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
Key | String | Yes | No | The key of the tag. | The tag key must be 1 to 128 characters in length, and cannot contain http:// or https:// . The tag key cannot start with acs: or aliyun . |
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length, and cannot contain http:// or https:// . The tag value cannot start with acs: or aliyun . |
Return values
Fn::GetAtt
- DiskId: the ID of the cloud disk.
- Status: the state of the cloud disk.
Examples
JSON
format{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneId": { "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId", "Type": "String", "Label": { "en": "VSwitch Availability Zone" } } }, "Resources": { "DataDisk": { "Type": "ALIYUN::ECS::Disk", "Properties": { "Size": 10, "ZoneId": { "Ref": "ZoneId" }, "DiskName": "DataDisk" } } }, "Outputs": { "DiskId": { "Value": { "Fn::GetAtt": [ "DataDisk", "DiskId" ] } }, "Status": { "Value": { "Fn::GetAtt": [ "DataDisk", "Status" ] } } } }