ALIYUN::ADBLake::DBCluster - Resource Orchestration Service

ALIYUN::ADBLake::DBCluster is used to create an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Syntax

{
  "Type": "ALIYUN::ADBLake::DBCluster",
  "Properties": {
    "ComputeResource": String,
    "DBClusterVersion": 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,
    "Tags": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ComputeResource	String	Yes	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 that contains the unit for this property.
DBClusterVersion	String	Yes	No	The version of the AnalyticDB for MySQL Data Lakehouse Edition cluster.	Set the value to 3.0.
PayType	String	Yes	No	The billing method.	Valid values: Postpaid: pay-as-you-go Prepaid: subscription
StorageResource	String	Yes	No	The reserved storage resources.	Valid values: 0 to 2064. The value must be in increments of 24. Unit: ACUs. An ACU is equivalent to 1 core and 4 GB memory. Note You must specify a value that contains the unit for this property.
VPCId	String	Yes	No	The ID of the virtual private cloud (VPC).	None.
VSwitchId	String	Yes	No	The vSwitch ID.	None.
ZoneId	String	Yes	No	The zone ID.	Note You can call the DescribeRegions operation to query the IDs of zones supported by the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
BackupSetId	String	No	No	The ID of the backup set.	None.
DBClusterDescription	String	No	No	The description of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.	The description is subject to the following limits: It cannot start with `http://` or `https://`. It must be 2 to 256 characters in length.
EnableDefaultResourcePool	Boolean	No	No	Specifies whether to allocate all reserved computing resources to the default resource group.	Valid values: true (default) false
PeriodType	String	No	No	The subscription type of the subscription AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.	Valid values: Year: subscription on a yearly basis Month: subscription on a monthly basis
Period	String	No	No	The subscription duration of the subscription AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.	Valid values of Period when PeriodType is set to Year: 1 to 3. The value must be an integer. Valid values of Period when PeriodType is set to Month: 1 to 9. The value must be an integer.
RestoreToTime	String	No	No	The point in time to which you want to restore data from the backup set.	None.
ResourceGroupId	String	No	No	The ID of the resource group.	None.
RestoreType	String	No	No	The method that you want to use to restore data.	Valid values: backup: restores data from a backup set. You must also specify BackupSetId and SourceDBClusterId. timepoint: restores data to a point in time. You must also specify RestoreToTime and SourceDBClusterId.
SourceDbClusterId	String	No	No	The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.	None.
Tags	List	No	Yes	The information about the tags.	For more information, see Tags properties.

Tags syntax

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

Tags properties

Property	Type	Required	Editable	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 (V3.0) cluster.
OrderId: the order ID.
ConnectionString: the endpoint of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Examples

`YAML` format

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` format

{
  "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"
        ]
      }
    }
  }
}

Syntax

Properties

Tags syntax

Tags properties

Return values

Examples

YAML format

JSON format

`YAML` format

`JSON` format