ALIYUN::ClickHouse::EnterpriseDBCluster - Resource Orchestration Service

The ALIYUN::ClickHouse::EnterpriseDBCluster resource creates an Enterprise Edition database instance.

Syntax

{
  "Type": "ALIYUN::ClickHouse::EnterpriseDBCluster",
  "Properties": {
    "Engine": String,
    "NodeScaleMin": Integer,
    "NodeCount": Integer,
    "NodeScaleMax": Integer,
    "VSwitchId": String,
    "VpcId": String,
    "ZoneId": String,
    "BackupSetId": String,
    "DBTimeZone": String,
    "DeploySchema": String,
    "DBInstanceDescription": String,
    "MultiZone": List,
    "ResourceGroupId": String,
    "StorageType": String,
    "SourceDBInstanceId": String,
    "StorageQuota": Integer,
    "PublicConnectionSetting": Map,
    "Tags": List
  }
}

Properties

Property name	Type	Required	Update allowed	Description	Constraint
Engine	String	Yes	No	Engine type.	Value: ClickHouse
NodeCount	Integer	Yes	No	Number of nodes.	Valid values: 2 to 16. Required if you configure the elastic scaling range using NodeScaleMin and NodeScaleMax.
NodeScaleMax	Integer	Yes	No	Maximum number of Serverless nodes for elastic scaling.	Valid values: 4 to 32. Must be greater than NodeScaleMin.
NodeScaleMin	Integer	Yes	No	Minimum number of Serverless nodes for elastic scaling.	Valid values: 4 to 32.
VpcId	String	Yes	No	The ID of the VPC.	None
VSwitchId	String	Yes	No	The ID of the vSwitch.	None
ZoneId	String	Yes	No	The ID of the zone.	None
BackupSetId	String	No	No	The ID of the backup set.	None
DBInstanceDescription	String	No	No	The description of the cluster.	None
DBTimeZone	String	No	No	The time zone of the database kernel.	None
DeploySchema	String	No	No	The deployment mode of the cluster across zones.	Valid values: single_az: Deploy servers in the primary zone specified by ZoneId. multi_az: Deploy servers across multiple zones specified by MultiZone.
MultiZone	List	No	No	The multi-zone configuration.	For more information, see MultiZone property.
PublicConnectionSetting	Map	No	No	The public network connection settings.	None
ResourceGroupId	String	No	No	The ID of the resource group to which the cluster belongs.	None
SourceDBInstanceId	String	No	No	Cluster example ID.	None
StorageQuota	Integer	No	No	The pre-purchased storage capacity, in GB.	None
StorageType	String	No	No	The storage class.	None
Tags	List	No	No	The custom tags attached to the cluster.	For more information, see Tags property.

PublicConnectionSetting syntax

"PublicConnectionSetting": 
  {
    "ConnectionPrefix": String,
    "EnablePublicConnection": Boolean
  }

PublicConnectionSetting properties

Property name	Type	Required	Update allowed	Description	Constraint
ConnectionPrefix	String	Yes	No	The prefix of the target endpoint.	None
EnablePublicConnection	Boolean	Yes	No	Specifies whether to enable public network connections.	None

MultiZone syntax

"MultiZone": [
  {
    "ZoneId": String,
    "VSwitchIds": List
  }
]

MultiZone properties

Property name	Type	Required	Update allowed	Description	Constraint
VSwitchIds	List	Yes	No	A list of vSwitch IDs.	None
ZoneId	String	Yes	No	The ID of the zone.	None

Tags syntax

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

Tags properties

Property name	Type	Required	Update allowed	Description	Constraint
Key	String	Yes	No	The tag key.	None
Value	String	No	No	The tag value.	None

Return values

Fn::GetAtt

DBInstanceId: The ID of the Enterprise Edition database instance.
PrivateConnectionString: The private network endpoint of the Enterprise Edition database instance.
PublicConnectionString: The public network endpoint of the Enterprise Edition database instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  NodeScaleMin:
    Type: Number
    Description:
      en: The minimum number of nodes for scaling.
    Required: true
    MinValue: 4
    MaxValue: 32
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      en: The ID of the zone.
    Required: true
  NodeCount:
    Type: Number
    Description:
      en: The number of nodes.
    Required: true
    MinValue: 2
    MaxValue: 16
  VSwitchId:
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    Type: String
    Description:
      en: The ID of the VSwitch.
    Required: true
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      en: The ID of the VPC.
    Required: true
  NodeScaleMax:
    Type: Number
    Description:
      en: The maximum number of nodes for scaling.
    Required: true
    MinValue: 4
    MaxValue: 32
  Engine:
    Type: String
    Description:
      en: The engine type.
    AllowedValues:
      - clickhouse
    Required: true
    Default: clickhouse
Resources:
  EnterpriseDBCluster:
    Type: ALIYUN::ClickHouse::EnterpriseDBCluster
    Properties:
      NodeScaleMin:
        Ref: NodeScaleMin
      ZoneId:
        Ref: ZoneId
      NodeCount:
        Ref: NodeCount
      VSwitchId:
        Ref: VSwitchId
      VpcId:
        Ref: VpcId
      NodeScaleMax:
        Ref: NodeScaleMax
      Engine:
        Ref: Engine
Outputs:
  DBInstanceId:
    Description: The ID of the database instance.
    Value:
      Fn::GetAtt:
        - EnterpriseDBCluster
        - DBInstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NodeScaleMin": {
      "Type": "Number",
      "Description": {
        "en": "The minimum number of nodes for scaling."
      },
      "Required": true,
      "MinValue": 4,
      "MaxValue": 32
    },
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "The ID of the zone."
      },
      "Required": true
    },
    "NodeCount": {
      "Type": "Number",
      "Description": {
        "en": "The number of nodes."
      },
      "Required": true,
      "MinValue": 2,
      "MaxValue": 16
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "en": "The ID of the VSwitch."
      },
      "Required": true
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "The ID of the VPC."
      },
      "Required": true
    },
    "NodeScaleMax": {
      "Type": "Number",
      "Description": {
        "en": "The maximum number of nodes for scaling."
      },
      "Required": true,
      "MinValue": 4,
      "MaxValue": 32
    },
    "Engine": {
      "Type": "String",
      "Description": {
        "en": "The engine type."
      },
      "AllowedValues": [
        "clickhouse"
      ],
      "Required": true,
      "Default": "clickhouse"
    }
  },
  "Resources": {
    "EnterpriseDBCluster": {
      "Type": "ALIYUN::ClickHouse::EnterpriseDBCluster",
      "Properties": {
        "NodeScaleMin": {
          "Ref": "NodeScaleMin"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "NodeCount": {
          "Ref": "NodeCount"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "NodeScaleMax": {
          "Ref": "NodeScaleMax"
        },
        "Engine": {
          "Ref": "Engine"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceId": {
      "Description": "The ID of the database instance.",
      "Value": {
        "Fn::GetAtt": [
          "EnterpriseDBCluster",
          "DBInstanceId"
        ]
      }
    }
  }
}