ALIYUN::EBS::DedicatedBlockStorageCluster - Resource Orchestration Service

ALIYUN::EBS::DedicatedBlockStorageCluster is used to create a dedicated block storage cluster.

Syntax

{
  "Type": "ALIYUN::EBS::DedicatedBlockStorageCluster",
  "Properties": {
    "Azone": String,
    "Capacity": Integer,
    "DbscName": String,
    "Period": Integer,
    "PeriodUnit": String,
    "Type": String,
    "ResourceGroupId": String,
    "Tag": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Azone	String	Yes	No	The ID of the zone in which the dedicated block storage cluster resides.	You can call the DescribeZones operation to query zones.
Capacity	Integer	Yes	No	The capacity of the dedicated block storage cluster.	Valid values: 61440 to 2334720. Unit: GiB. 2,334,720 GiB is equivalent to 2,280 TiB. The capacity increases in a minimum increment of 12,288 GiB.
DbscName	String	Yes	No	The name of the dedicated block storage cluster.	None.
Period	Integer	Yes	No	The subscription duration of the dedicated block storage cluster.	Valid values: 6, 7, 8, 9, 10, 11, 12, 24, and 36.
PeriodUnit	String	Yes	No	The unit of the subscription duration of the dedicated block storage cluster.	Set the value to Month. The value of this property is the unit of the `Period` value.
Type	String	Yes	No	The type of the dedicated block storage cluster.	Valid values: Standard: basic dedicated block storage cluster. Performance level 0 (PL0) Enterprise SSDs (ESSDs) can be created in basic dedicated block storage clusters. Premium: performance dedicated block storage cluster. PL1 ESSDs can be created in performance dedicated block storage clusters. Default value: Premium.
ResourceGroupId	String	No	No	The ID of the resource group to which the dedicated block storage cluster belongs.	None.
Tag	List	No	Yes	The tags that you want to add to the dedicated block storage cluster.	For more information, see Tag properties.

Tag syntax

"Tag": [
  {
    "Value": String,
    "Key": String
  }
]

Tag properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The key of the tag.	The key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
Value	String	No	No	The value of the tag.	The value can be up to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

DedicatedBlockStorageClusterId: the ID of the dedicated block storage cluster.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Azone:
    Type: String
    Description:
      en: The ID of the zone in which to create the dedicated block storage cluster.
    Required: true
  Type:
    Type: String
    Description:
      en: |-
        The type of the dedicated block storage cluster. Valid values: 
        Standard: basic dedicated block storage cluster. Enterprise SSDs (ESSDs) at performance level 0 (PL0 ESSDs) can be created in basic dedicated block storage clusters.
        Premium: performance dedicated block storage cluster. ESSDs at performance level 1 (PL1 ESSDs) can be created in performance dedicated block storage clusters.
        Default value: Premium.
    AllowedValues:
      - Standard
      - Premium
    Required: true
  Capacity:
    Type: Number
    Description:
      en: 'The capacity of the dedicated block storage cluster. Valid values: 61440 to 2334720. Unit: GiB. 2,334,720 GiB is equal to 2,280 TiB. The capacity increases in a minimum increment of 12,288 GiB.'
    Required: true
    MinValue: 61440
    MaxValue: 2334720
  Period:
    AssociationProperty: PayPeriod
    Type: Number
    Description:
      en: 'The subscription duration of the dedicated block storage cluster. Valid values: 6, 7, 8, 9, 10, 11, 12, 24, and 36.'
    AllowedValues:
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 24
      - 36
    Required: true
  DbscName:
    Type: String
    Description:
      en: The name of the dedicated block storage cluster.
    Required: true
  PeriodUnit:
    AssociationProperty: PayPeriodUnit
    Type: String
    Description:
      en: The unit of the subscription duration specified by Period. Set the value to Month.
    AllowedValues:
      - Month
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::EBS::DedicatedBlockStorageCluster
    Properties:
      Azone:
        Ref: Azone
      Type:
        Ref: Type
      Capacity:
        Ref: Capacity
      Period:
        Ref: Period
      DbscName:
        Ref: DbscName
      PeriodUnit:
        Ref: PeriodUnit
Outputs:
  DedicatedBlockStorageClusterId:
    Description: The ID of the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DedicatedBlockStorageClusterId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Azone": {
      "Type": "String",
      "Description": {
        "en": "The ID of the zone in which to create the dedicated block storage cluster."
      },
      "Required": true
    },
    "Type": {
      "Type": "String",
      "Description": {
        "en": "The type of the dedicated block storage cluster. Valid values: \nStandard: basic dedicated block storage cluster. Enterprise SSDs (ESSDs) at performance level 0 (PL0 ESSDs) can be created in basic dedicated block storage clusters.\nPremium: performance dedicated block storage cluster. ESSDs at performance level 1 (PL1 ESSDs) can be created in performance dedicated block storage clusters.\nDefault value: Premium."
      },
      "AllowedValues": [
        "Standard",
        "Premium"
      ],
      "Required": true
    },
    "Capacity": {
      "Type": "Number",
      "Description": {
        "en": "The capacity of the dedicated block storage cluster. Valid values: 61440 to 2334720. Unit: GiB. 2,334,720 GiB is equal to 2,280 TiB. The capacity increases in a minimum increment of 12,288 GiB."
      },
      "Required": true,
      "MinValue": 61440,
      "MaxValue": 2334720
    },
    "Period": {
      "AssociationProperty": "PayPeriod",
      "Type": "Number",
      "Description": {
        "en": "The subscription duration of the dedicated block storage cluster. Valid values: 6, 7, 8, 9, 10, 11, 12, 24, and 36."
      },
      "AllowedValues": [
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        24,
        36
      ],
      "Required": true
    },
    "DbscName": {
      "Type": "String",
      "Description": {
        "en": "The name of the dedicated block storage cluster."
      },
      "Required": true
    },
    "PeriodUnit": {
      "AssociationProperty": "PayPeriodUnit",
      "Type": "String",
      "Description": {
        "en": "The unit of the subscription duration specified by Period. Set the value to Month."
      },
      "AllowedValues": [
        "Month"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::EBS::DedicatedBlockStorageCluster",
      "Properties": {
        "Azone": {
          "Ref": "Azone"
        },
        "Type": {
          "Ref": "Type"
        },
        "Capacity": {
          "Ref": "Capacity"
        },
        "Period": {
          "Ref": "Period"
        },
        "DbscName": {
          "Ref": "DbscName"
        },
        "PeriodUnit": {
          "Ref": "PeriodUnit"
        }
      }
    }
  },
  "Outputs": {
    "DedicatedBlockStorageClusterId": {
      "Description": "The ID of the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DedicatedBlockStorageClusterId"
        ]
      }
    }
  }
}