ALIYUN::ENS::Disk - Resource Orchestration Service

ALIYUN::ENS::Disk is used to create a pay-as-you-go or subscription data disk.

Syntax

{
  "Type": "ALIYUN::ENS::Disk",
  "Properties": {
    "SnapshotId": String,
    "Category": String,
    "KMSKeyId": String,
    "Encrypted": Boolean,
    "InstanceChargeType": String,
    "Size": String,
    "DiskName": String,
    "EnsRegionId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
SnapshotId	String	No	No	The snapshot that you want to use to create the disk.	The following limits apply to SnapshotId and Size: If the size of the snapshot specified by SnapshotId is larger than the value of Size, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by SnapshotId is smaller than the value of Size, the size of the created disk is equal to the value of Size.
Category	String	Yes	No	The disk category.	Valid values: cloud_efficiency: ultra disk cloud_ssd: all-flash disk
KMSKeyId	String	No	No	The ID of the Key Management Service (KMS) key that you want to use for the disk.	If you set Encrypted to true and leave KMSKeyId empty, the default service key is used.
Encrypted	Boolean	No	No	Specifies whether to encrypt the disk.	Valid values: true false (default)
InstanceChargeType	String	Yes	No	The billing method of the instance.	Set the value to PostPaid. A value of PostPaid specifies the pay-as-you-go billing method.
Size	String	Yes	Yes	The disk size.	Unit: GiB.
DiskName	String	No	No	The disk name.	None.
EnsRegionId	String	Yes	No	The node ID.	None.

Return values

Fn::GetAtt

DiskId: the disk ID.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Category:
    Description:
      en: 'The category of the disk. Valid values:

        cloud_efficiency: ultra disk.

        cloud_ssd: all-flash disk.'
    Required: true
    Type: String
  DiskName:
    Description:
      en: The name of the disk.
    Required: false
    Type: String
  Encrypted:
    Description:
      en: 'Specifies whether to encrypt the new system disk. Valid values:

        true

        false (default): no'
    Required: false
    Type: Boolean
  EnsRegionId:
    Description:
      en: The ID of the edge node.
    Required: true
    Type: String
  InstanceChargeType:
    AssociationPropertyMetadata:
      LocaleKey: InstanceChargeType
    Default: PostPaid
    Description:
      en: The billing method of the instance. Set the value to PostPaid.
    Required: true
    Type: String
  KMSKeyId:
    Description:
      en: 'The ID of the Key Management Service (KMS) key that is used by the cloud
        disk.

        Note If you set the Encrypted parameter to true, the default service key is
        used when the KMSKeyId parameter is empty.'
    Required: false
    Type: String
  Size:
    Description:
      en: 'The size of the disk. Unit: GiB.'
    Required: true
    Type: String
  SnapshotId:
    Description:
      en: 'The ID of the snapshot that you want to use to create the disk.

        The following limits apply to the SnapshotId and Size parameters:

        If the size of the snapshot specified by SnapshotId is greater than the specified
        Size value, the size of the created disk is equal to the specified snapshot
        size.

        If the size of the snapshot specified by SnapshotId is smaller than the specified
        Size value, the size of the created disk is equal to the specified Size value.'
    Required: false
    Type: String
Resources:
  Disk:
    Properties:
      Category:
        Ref: Category
      DiskName:
        Ref: DiskName
      Encrypted:
        Ref: Encrypted
      EnsRegionId:
        Ref: EnsRegionId
      InstanceChargeType:
        Ref: InstanceChargeType
      KMSKeyId:
        Ref: KMSKeyId
      Size:
        Ref: Size
      SnapshotId:
        Ref: SnapshotId
    Type: ALIYUN::ENS::Disk
Outputs:
  DiskId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
      - Disk
      - DiskId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SnapshotId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the snapshot that you want to use to create the disk.\nThe following limits apply to the SnapshotId and Size parameters:\nIf the size of the snapshot specified by SnapshotId is greater than the specified Size value, the size of the created disk is equal to the specified snapshot size.\nIf the size of the snapshot specified by SnapshotId is smaller than the specified Size value, the size of the created disk is equal to the specified Size value."
      },
      "Required": false
    },
    "Category": {
      "Type": "String",
      "Description": {
        "en": "The category of the disk. Valid values:\ncloud_efficiency: ultra disk.\ncloud_ssd: all-flash disk."
      },
      "Required": true
    },
    "KMSKeyId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the Key Management Service (KMS) key that is used by the cloud disk.\nNote If you set the Encrypted parameter to true, the default service key is used when the KMSKeyId parameter is empty."
      },
      "Required": false
    },
    "Encrypted": {
      "Type": "Boolean",
      "Description": {
        "en": "Specifies whether to encrypt the new system disk. Valid values:\ntrue\nfalse (default): no"
      },
      "Required": false
    },
    "InstanceChargeType": {
      "AssociationPropertyMetadata": {
        "LocaleKey": "InstanceChargeType"
      },
      "Type": "String",
      "Description": {
        "en": "The billing method of the instance. Set the value to PostPaid."
      },
      "Required": true,
      "Default": "PostPaid"
    },
    "Size": {
      "Type": "String",
      "Description": {
        "en": "The size of the disk. Unit: GiB."
      },
      "Required": true
    },
    "DiskName": {
      "Type": "String",
      "Description": {
        "en": "The name of the disk."
      },
      "Required": false
    },
    "EnsRegionId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the edge node."
      },
      "Required": true
    }
  },
  "Resources": {
    "Disk": {
      "Type": "ALIYUN::ENS::Disk",
      "Properties": {
        "SnapshotId": {
          "Ref": "SnapshotId"
        },
        "Category": {
          "Ref": "Category"
        },
        "KMSKeyId": {
          "Ref": "KMSKeyId"
        },
        "Encrypted": {
          "Ref": "Encrypted"
        },
        "InstanceChargeType": {
          "Ref": "InstanceChargeType"
        },
        "Size": {
          "Ref": "Size"
        },
        "DiskName": {
          "Ref": "DiskName"
        },
        "EnsRegionId": {
          "Ref": "EnsRegionId"
        }
      }
    }
  },
  "Outputs": {
    "DiskId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Disk",
          "DiskId"
        ]
      }
    }
  }
}