ALIYUN::ADBLake::DBCluster - Resource Orchestration Service

ALIYUN::ADBLake::DBCluster type is used to create an AnalyticDB for MySQL Data Lakehouse Edition cluster.

Syntax

{
  "Type": "ALIYUN::ADBLake::DBCluster",
  "Properties": {
    "ComputeResource": String,
    "DBClusterVersion": String,
    "DiskEncryption": Boolean,
    "KmsId": String,
    "ProductForm": String,
    "ReservedNodeCount": Integer,
    "ReservedNodeSize": Integer,
    "CloneSourceRegionId": String,
    "DBClusterNetworkType": String
    "PayType": String,
    "StorageResource": String,
    "VPCId": String,
    "VSwitchId": String,
    "ZoneId": String,
    "BackupSetId": String,
    "DBClusterDescription": String,
    "EnableDefaultResourcePool": Boolean,
    "PeriodType": String,
    "Period": String,
    "RestoreToTime": String,
    "ResourceGroupId": String,
    "RestoreType": String,
    "SourceDbClusterId": String,
    "ProductVersion": String,
    "SecondaryVSwitchId": String,
    "SecondaryZoneId": String,
    "Tags": List
  }
}

Properties

Property name	Type	Required	Editable	Description	Constraint
DBClusterVersion	String	Yes	No	The AnalyticDB for MySQL Data Lakehouse Edition.	Set value: 5.0.
PayType	String	Yes	No	The billing method.	Valid values: Prepaid: annual or monthly subscription. Postpaid: pay-as-you-go.
VPCId	String	Yes	No	Virtual private cloud (VPC) ID.	None.
VSwitchId	String	Yes	No	The vSwitch ID.	None.
ZoneId	String	Yes	No	The zone ID.	Note You can call DescribeRegion API to view the availability zone ID of a specified AnalyticDB for MySQL Data Lakehouse Edition cluster.
BackupSetId	String	No	No	The backup set ID.	None.
CloneSourceRegionId	String	No	No	The source cluster region ID.	Note This field is required for cross-region cloning.
ComputeResource	String	No	No	The reserved computing resources.	Valid values: 0 to 4096. The value must be in increments of 16. Unit: AnalyticDB compute units (ACUs). An ACU is equivalent to 1 core and 4 GB memory. Note You must specify a value with the unit for this field.
DBClusterDescription	String	No	No	DBcluster description.	Cannot start with `http://` or `https://`. The length must be 2 to 256 characters.
DBClusterNetworkType	String	No	No	DBcluster network type.	Only VPC (Virtual Private Cloud) type is supported.
DiskEncryption	Boolean	No	No	Whether to enable cloud disk encryption.	None.
EnableDefaultResourcePool	Boolean	No	No	Specifies whether the reserved computing resources are all allocated to the default resource group.	Valid values: true (default) false
KmsId	String	No	No	The key ID used to encrypt the cloud disk data.	Note This field is used only when cloud disk encryption is enabled for AnalyticDB MySQL cluster.
Period	String	No	No	The cluster subscription duration.	Valid values: When PeriodType is set to Year: the value range is 1 to 3. The value must be an integer. When PeriodType is set to Month: the value range is 1 to 9. The value must be an integer.
PeriodType	String	No	No	The subscription type of the cluster.	Valid values: Year: subscription on a yearly basis. Month: subscription on a monthly basis.
ProductForm	String	No	No	The product form.	Valid values: IntegrationForm: integrated Edition. LegacyForm: Lakehouse Edition.
ProductVersion	String	No	No	The product version.	Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.
ResourceGroupId	String	No	No	The resource group ID.	None.
RestoreToTime	String	No	No	The recovery timestamp based on the backup set.	None.
RestoreType	String	No	No	The restore data method.	Valid values: backup: restores data from a backup set. You must specify BackupSetId and SourceDBClusterId. timepoint: restores data from a timestamp. You must specify RestoreToTime and SourceDBClusterId.
ReservedNodeCount	Integer	No	No	The number of reserved nodes.	The default for Enterprise Edition is 3 nodes and the increments is 3. The default for Basic Edition is 1 node. Note Fill in this field only when ProductForm set to IntegrationForm
ReservedNodeSize	Integer	No	No	The specifications of reserved nodes.	Unit: ACU.
SecondaryVSwitchId	String	No	No	The ID of the secondary vSwitch.	None.
SecondaryZoneId	String	No	No	The ID of the secondary zone.	None.
SourceDbClusterId	String	No	No	The source ID of AnalyticDB for MySQL Data Warehouse Edition cluster.	None.
StorageResource	String	No	No	The reserved storage resources.	Valid values: 0 to 2064. The value must be in increments of 24. Unit: AnalyticDB compute units (ACUs). An ACU is equivalent to 1 core and 4 GB memory. Note You must specify a value with the unit for this field.
Tags	List	No	Yes	The tag information.	For more information, see Tags properties.

Tags syntax

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

Tags properties

Property	Type	Required	Allow updates	Description	Constraint
Key	String	Yes	No	The tag key.	You can specify 1 to 20 tag keys.
Value	String	No	No	The tag value.	You can specify 1 to 20 tag values.

Return values

Fn::GetAtt

DBClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
OrderId: The order ID.
ConnectionString: The public endpoint for connecting to the cluster.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  StorageResource:
    Type: String
    Description:
      en: |-
        The amount of reserved storage resources. Unit: AnalyticDB compute units (ACUs). Valid values: 0ACU to 2064ACU. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.
        Note This parameter must be specified with a unit.
    Required: true
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      en: |-
        The zone ID.
        Note You can call the  DescribeRegions  operation to query the most recent zone list.
    Required: true
  VPCId:
    Type: String
    Description:
      en: The virtual private cloud (VPC) ID of the cluster.
    Required: true
  VSwitchId:
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    Type: String
    Description:
      en: The vSwitch ID of the cluster.
    Required: true
  ComputeResource:
    Type: String
    Description:
      en: |-
        The amount of reserved computing resources. Unit: ACUs. Valid values: 0ACU to 4096ACU. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.
        Note This parameter must be specified with a unit.
    Required: true
  PayType:
    Type: String
    Description:
      en: |-
        The billing method of the cluster. Valid values:
        Postpaid: pay-as-you-go.
        Prepaid: subscription.
    AllowedValues:
      - PayAsYouGo
      - Subscription
    Required: true
    Default: PayAsYouGo
  DBClusterVersion:
    Type: String
    Description:
      en: The version of the cluster. Set the value to 5.0.
    Required: true
Resources:
  DBCluster:
    Type: ALIYUN::ADBLake::DBCluster
    Properties:
      StorageResource:
        Ref: StorageResource
      ZoneId:
        Ref: ZoneId
      VPCId:
        Ref: VPCId
      VSwitchId:
        Ref: VSwitchId
      ComputeResource:
        Ref: ComputeResource
      PayType:
        Ref: PayType
      DBClusterVersion:
        Ref: DBClusterVersion
Outputs:
  DBClusterId:
    Description: The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
    Value:
      Fn::GetAtt:
        - DBCluster
        - DBClusterId
  OrderId:
    Description: The order ID.
    Value:
      Fn::GetAtt:
        - DBCluster
        - OrderId
  ConnectionString:
    Description: The public endpoint that is used to connect to the cluster.
    Value:
      Fn::GetAtt:
        - DBCluster
        - ConnectionString

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "StorageResource": {
      "Type": "String",
      "Description": {
        "en": "The amount of reserved storage resources. Unit: AnalyticDB compute units (ACUs). Valid values: 0ACU to 2064ACU. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.\nNote This parameter must be specified with a unit."
      },
      "Required": true
    },
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "The zone ID.\nNote You can call the  DescribeRegions  operation to query the most recent zone list."
      },
      "Required": true
    },
    "VPCId": {
      "Type": "String",
      "Description": {
        "en": "The virtual private cloud (VPC) ID of the cluster."
      },
      "Required": true
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "en": "The vSwitch ID of the cluster."
      },
      "Required": true
    },
    "ComputeResource": {
      "Type": "String",
      "Description": {
        "en": "The amount of reserved computing resources. Unit: ACUs. Valid values: 0ACU to 4096ACU. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.\nNote This parameter must be specified with a unit."
      },
      "Required": true
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "en": "The billing method of the cluster. Valid values:\nPostpaid: pay-as-you-go.\nPrepaid: subscription."
      },
      "AllowedValues": [
        "PayAsYouGo",
        "Subscription"
      ],
      "Required": true,
      "Default": "PayAsYouGo"
    },
    "DBClusterVersion": {
      "Type": "String",
      "Description": {
        "en": "The version of the cluster. Set the value to 5.0."
      },
      "Required": true
    }
  },
  "Resources": {
    "DBCluster": {
      "Type": "ALIYUN::ADBLake::DBCluster",
      "Properties": {
        "StorageResource": {
          "Ref": "StorageResource"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "ComputeResource": {
          "Ref": "ComputeResource"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "DBClusterVersion": {
          "Ref": "DBClusterVersion"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "DBClusterId"
        ]
      }
    },
    "OrderId": {
      "Description": "The order ID.",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "OrderId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "The public endpoint that is used to connect to the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "ConnectionString"
        ]
      }
    }
  }
}