ALIYUN::ClickHouse::EnterpriseDBCluster-资源编排(ROS)-阿里云帮助中心

语法

{
  "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,
    "Tags": List
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
Engine	String	是	否	引擎类型。	取值： clickhouse
NodeScaleMin	Integer	是	否	serverless 节点弹性伸缩最小值。	取值范围 4-32。
NodeCount	Integer	是	否	节点个数。	取值范围 2-16。使用 NodeScaleMin、NodeScaleMax 配置弹性区间时必填。
NodeScaleMax	Integer	是	否	serverless 节点弹性伸缩最大值。	取值范围 4-32，且必须大于最小值
VSwitchId	String	是	否	交换机 ID。	无
VpcId	String	是	否	VPC ID。	无
ZoneId	String	是	否	可用区 ID。	无
BackupSetId	String	否	否	备份集 ID。	无
DBTimeZone	String	否	否	数据库内核时区设置。	无
DeploySchema	String	否	否	集群可用区部署状态。	取值： single_az：server 部署到主可用区 ZoneId。 multi_az：server 部署到多可用区 MultiZones。
DBInstanceDescription	String	否	否	集群说明。	无
MultiZone	List	否	否	多可用区配置。	更多信息，请参考MultiZone属性。
ResourceGroupId	String	否	否	集群资源组 ID。	无
StorageType	String	否	否	存储类型。	无
SourceDBInstanceId	String	否	否	集群例 ID。	无
StorageQuota	Integer	否	否	存储预购量（GB）。	无
Tags	List	否	否	集群绑定的自定义标签。	更多信息，请参考Tags属性。

MultiZone语法

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

MultiZone属性

属性名称	类型	必须	允许更新	描述	约束
VSwitchIds	List	是	否	交换机 ID列表。	无
ZoneId	String	是	否	可用区 ID。	无

Tags语法

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

Tags属性

属性名称	类型	必须	允许更新	描述	约束
Key	String	是	否	标签键。	无
Value	String	否	否	标签值。	无

返回值

Fn::GetAtt

DBInstanceId：企业版数据库实例ID。

示例

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