全部产品
Search
文档中心

资源编排:ALIYUN::ClickHouse::DBCluster

更新时间:Jul 18, 2024

ALIYUN::ClickHouse::DBCluster类型用于创建ClickHouse集群。

语法

{
  "Type": "ALIYUN::ClickHouse::DBCluster",
  "Properties": {
    "DbNodeStorageType": String,
    "DBNodeStorage": Integer,
    "EncryptionType": String,
    "Category": String,
    "ZoneId": String,
    "VSwitchId": String,
    "DBClusterDescription": String,
    "Period": String,
    "EncryptionKey": String,
    "DBClusterNetworkType": String,
    "DBClusterType": String,
    "VpcId": String,
    "DBClusterVersion": String,
    "DBNodeCount": Integer,
    "UsedTime": Integer,
    "PaymentType": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Category

String

集群系列。

取值:

  • Basic:基础版。

  • HighAvailability:集群版。

DBClusterNetworkType

String

网络类型。

取值:VPC,表示专有网络。

DBClusterType

String

集群类型。

集群规格。

  • 双副本版,取值:

    • LC20:大存储型20核88 GB。

    • LC40:大存储型40核176 GB。

    • LC80:大存储型80核352 GB。

    • C8:标准型8核32 GB。

    • C16:标准型16核64 GB。

    • C32:标准型32核128 GB。

    • C64:标准型64核256 GB。

    • C80:标准型80核384 GB。

    • C104:标准型104核384 GB。

  • 单副本版,取值:

    • LS20:大存储型20核88 GB。

    • LS40:大存储型40核176 GB。

    • LS80:大存储型80核352 GB。

    • S8:标准型8核32 GB。

    • S16:标准型16核64 GB。

    • S32:标准型32核128 GB。

    • S64:标准型64核256 GB。

    • S80:标准型80核384 GB。

    • S104:标准型104核384 GB。

DBClusterVersion

String

实例版本。

取值:

  • 21.8.10.19

  • 22.8.5.29

DBNodeCount

Integer

节点组数量。

取值范围:

  • S系列:1~48。

  • C系列:1~24。

单位:个。

DBNodeStorage

Integer

节点存储空间。

取值范围:100~10000。

单位:GB。

每100 GB递增。

DbNodeStorageType

String

节点存储空间类型。

取值:

  • cloud_essd:ESSD云盘。

  • cloud_efficiency:高效云盘。

PaymentType

String

付费类型。

取值:

  • Postpaid:按量付费。

  • Prepaid:预付费(包年包月)。

DBClusterDescription

String

集群备注信息。

EncryptionKey

String

密钥管理服务KMS的密钥ID。

EncryptionType

String

加密类型。

取值:CloudDisk,表示云盘加密 。

Period

String

预付费集群的付费周期。

取值:

  • Year:包年。

  • Month:包月。

说明

当PaymentType取值为Prepaid时,该参数必须指定。

UsedTime

Integer

实例使用时间。

取值范围:

  • 当Period取值为Month时:1~9。

  • 当Period取值为Year时:1~3。

VpcId

String

专有网络ID。

VSwitchId

String

交换机ID。

ZoneId

String

可用区ID。

您可以调用DescribeRegions接口查询可用的可用区。

返回值

Fn::GetAtt

  • DBClusterId:实例ID。

  • PublicPort:公网端口。

  • Bid:业务流程的ID。

  • LockReason:锁定原因。

  • LockMode:锁定模式。

  • DBClusterVersion:实例版本。

  • CommodityCode:售卖商品代码。

  • VpcId:专有网络ID。

  • Engine:引擎。

  • Category:集群系列。

  • DBClusterType:集群类型。

  • DBClusterNetworkType:网络类型。

  • EncryptionType:加密类型。

  • VpcCloudInstanceId:VPC云实例ID。

  • Port:连接端口。

  • PaymentType:支付方式。

  • DBNodeStorage:节点存储空间。

  • PublicConnectionString:公网连接地址。

  • EngineVersion:引擎版本。

  • IsExpired:实例是否已过期。

  • VSwitchId:交换机ID。

  • Period:预付费集群的付费周期。

  • StorageType:存储类型。

  • DBNodeCount:节点组数量。

  • AliUid:阿里云账号。

  • DBClusterDescription:实例描述。

  • ConnectionString:连接字符串。

  • ZoneId:可用区ID。

  • EncryptionKey:KMS密钥ID。

  • DbNodeStorageType:节点存储类型。

  • DBNodeClass:节点类型。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ZoneId}
      VpcId: ${VpcId}
  PaymentType:
    Type: String
    Description: PayType
    Default: Month
Resources:
  ClickHouseDBCluster:
    Type: ALIYUN::ClickHouse::DBCluster
    Properties:
      DbNodeStorageType: cloud_essd
      DBNodeStorage: 100 
      Category: Basic
      ZoneId:
        Ref: ZoneId
      VSwitchId:
        Ref: VSwitchId
      Period: Month
      DBClusterNetworkType: VPC
      DBClusterType: S8
      VpcId:
        Ref: VpcId
      DBClusterVersion: 21.8.10.19
      DBNodeCount: 3
      UsedTime: 1
      PaymentType: Prepaid

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ZoneId}",
        "VpcId": "${VpcId}"
      }
    },
    "PaymentType": {
      "Type": "String",
      "Description": "PayType",
      "Default": "Month"
    }
  },
  "Resources": {
    "ClickHouseDBCluster": {
      "Type": "ALIYUN::ClickHouse::DBCluster",
      "Properties": {
        "DbNodeStorageType": "cloud_essd",
        "DBNodeStorage": 100,
        "Category": "Basic",
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Period": "Month",
        "DBClusterNetworkType": "VPC",
        "DBClusterType": "S8",
        "VpcId": {
          "Ref": "VpcId"
        },
        "DBClusterVersion": "21.8.10.19",
        "DBNodeCount": 3,
        "UsedTime": 1,
        "PaymentType": "Prepaid"
      }
    }
  }
}