ALIYUN::ADB::DBCluster is used to create an AnalyticDB for MySQL cluster.

Syntax

{
  "Type": "ALIYUN::ADB::DBCluster",
  "Properties": {
    "DBNodeStorage": Integer,
    "PeriodType": String,
    "DBClusterCategory": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "VPCId": String,
    "VSwitchId": String,
    "Mode": String,
    "DBClusterDescription": String,
    "ComputeResource": String,
    "Period": Integer,
    "PayType": String,
    "ElasticIOResource": Integer,
    "DBClusterVersion": String,
    "DBNodeGroupCount": Integer,
    "ExecutorCount": Integer,
    "DBClusterClass": String,
    "Tags": List
  }
}

Properties

Property Type Required Editable Description Constraint
DBNodeStorage Integer No Yes The storage capacity of the node. Unit: GB.

This property is required if the Mode property is set to Reserver.

Valid values:

  • If the DBClusterClass property is set to T8: 100 to 500
  • If the DBClusterClass property is set to T16: 100 to 2000
  • If the DBClusterClass property is set to T32: 100 to 2000
  • If the DBClusterClass property is set to T52: 100 to 4000
  • If the DBClusterClass property is set to C8: 100 to 1000
  • If the DBClusterClass property is set to C32: 100 to 8000
Note 1000 The storage capacity smaller than 1,000 GB increases in increments of 100 GB. The storage capacity larger than 1,000 GB increases in increments of 1,000 GB.
PeriodType String No No The subscription type of the subscription cluster.

This property is required if the PayType property is set to Prepaid.

Valid values:

  • Year
  • Month
DBClusterCategory String Yes Yes The edition of the cluster.

Valid values:

  • If the Mode property is set to Reserver:
    • Basic
    • Cluster
  • If the Mode property is set to Flexible:

    MixedStorage

For more information, see Editions.

ZoneId String No No The zone ID of the cluster. You can call the DescribeRegions operation to query zones.
ResourceGroupId String No Yes The ID of the resource group. None
VPCId String Yes No The ID of the virtual private cloud (VPC). None
VSwitchId String Yes No The ID of the vSwitch. None
Mode String Yes No The mode of the cluster. Valid values:
  • Reserver
  • Flexible
DBClusterDescription String No No The description of the cluster. None
ComputeResource String No Yes The computing resources of the cluster. This property is required if the Mode property is set to Flexible.
Period Integer No No The subscription period of the cluster.

This property is required if the PayType property is set to Prepaid.

Valid values:

  • If the PeriodType property is set to Month: 1 to 9
  • If the PeriodType property is set to Year: 1 to 3
PayType String Yes No The billing method of the cluster. Valid values:
  • Postpaid: pay-as-you-go
  • Prepaid: subscription
ElasticIOResource Integer No Yes The elastic I/O units (EIUs) of the cluster. This property is required if the Mode property is set to Flexible.

For more information, see EIUs.

DBClusterVersion String Yes No The version of the AnalyticDB for MySQL cluster. Set the value to 3.0.
DBNodeGroupCount Integer No Yes The number of node groups.

This property is required if the Mode property is set to Reserver.

Valid values:

  • If the DBClusterClass property is set to T8: 1
  • If the DBClusterClass property is set to T16: 1
  • If the DBClusterClass property is set to T32: 1
  • If the DBClusterClass property is set to T52: 1
  • If the DBClusterClass property is set to C8: 1 to 128
  • If the DBClusterClass property is set to C32: 1 to 128
ExecutorCount Integer No No The number of compute nodes that are used by the cluster in elastic mode. None
DBClusterClass String No Yes The instance type of the cluster.

This property is required if the Mode property is set to Reserver.

Valid values:

  • If the DBClusterCategory property is set to Basic:
    • T8
    • T16
    • T32
    • T52
  • If the DBClusterCategory property is set to Cluster:
    • C8
    • C32
Tags List No Yes The tags of the cluster. You can add up to 20 tags at a time.

For more information, see Tags properties.

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]  
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 aliyun or acs:.
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 aliyun or acs:.

Response parameters

Fn::GetAtt

  • DBClusterId: the ID of the cluster.
  • OrderId: the ID of the order.
  • ConnectionString: the VPC endpoint of the cluster.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterCategory": {
      "Type": "String",
      "Description": "The edition of the cluster.\nValid values when the cluster is in reserved mode:\nBasic\nCluster\nWhen the cluster is in elastic mode, set the value to MixedStorage.",
      "AllowedValues": [
        "Basic",
        "Cluster",
        "MixedStorage"
      ],
      "Default": "MixedStorage"
    },
    "ZoneId": {
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
      "Type": "String",
      "Description": "The zone ID of the cluster. You can call the DescribeRegions operation to query the most recent zone list."
    },
    "VPCId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "The ID of the VPC.\nNote If you leave this parameter empty, the default VPC or vSwitch of the specified region is used. If the region does not have a default VPC, a VPC is created."
    },
    "VSwitchId": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "The ID of the vSwitch.",
      "AssociationPropertyMetadata": {
        "VpcId": "VPC",
        "ZoneId": "VSwitchZoneId"
      }
    },
    "Mode": {
      "Type": "String",
      "Description": "The mode of the cluster. Valid values:\nReserver: the reserved mode\nFlexible: the elastic mode",
      "AllowedValues": [
        "Reserver",
        "Flexible"
      ],
      "Default": "Flexible"
    },
    "ComputeResource": {
      "Type": "String",
      "Description": "The computing resource of the cluster. This parameter is required in elastic mode.",
      "Default": "8Core32GB"
    },
    "PayType": {
      "Type": "String",
      "Description": "The billing method of the cluster. Valid values:\nPostpaid: pay-as-you-go\nPrepaid: subscription",
      "AllowedValues": [
        "PrePaid",
        "Postpaid"
      ],
      "Default": "PostPaid"
    },
    "ElasticIOResource": {
      "Type": "Number",
      "Description": "Elastic IO Unit\nNote the flexible mode cluster will use this parameter.",
      "Default": 0
    },
    "DBClusterVersion": {
      "Type": "String",
      "Description": "The version of the cluster. Set the value to 3.0.",
      "Default": "3.0"
    }
  },
  "Resources": {
    "DBCluster": {
      "Type": "ALIYUN::ADB::DBCluster",
      "Properties": {
        "DBClusterCategory": {
          "Ref": "DBClusterCategory"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Mode": {
          "Ref": "Mode"
        },
        "ComputeResource": {
          "Ref": "ComputeResource"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "ElasticIOResource": {
          "Ref": "ElasticIOResource"
        },
        "DBClusterVersion": {
          "Ref": "DBClusterVersion"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "The ID of the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "DBClusterId"
        ]
      }
    },
    "OrderId": {
      "Description": "The ID of the order.",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "OrderId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "Vpc connection string.",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "ConnectionString"
        ]
      }
    }
  }
}