ALIYUN::ClickHouse::DBCluster を使用した ApsaraDB for ClickHouse クラスターの作成 - Resource Orchestration Service

ALIYUN::ClickHouse::DBCluster は、ApsaraDB for ClickHouse クラスターを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ClickHouse::DBCluster",
  "Properties": {
    "DbNodeStorageType": String,
    "DBNodeStorage": Integer,
    "EncryptionType": String,
    "Category": String,
    "ZoneId": String,
    "ZoneIdBak": String,
    "ZoneIdBak2": String,
    "VSwitchId": String,
    "VSwitchBak": String,
    "VSwitchBak2": 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 に設定します。これは仮想プライベートクラウド (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 (エンタープライズ SSD) cloud_efficiency：Ultra ディスク
PaymentType	String	はい	いいえ	課金方法。	有効な値：後払い: 従量課金 Prepaid：サブスクリプション
DBClusterDescription	String	いいえ	はい	クラスターの説明。	なし
EncryptionKey	String	いいえ	いいえ	Key Management Service (KMS) が提供するキーの ID。	なし
EncryptionType	String	いいえ	いいえ	暗号化タイプ。	値を CloudDisk に設定します。この値は、クラスターに対してディスク暗号化が適用されることを指定します。
Period	String	いいえ	いいえ	クラスターのサブスクリプション期間の単位。	有効な値： Year Month 説明 PaymentType を Prepaid に設定する場合は、このプロパティを必ず指定してください。
UsedTime	Integer	いいえ	いいえ	クラスターの使用期間。	Period が Month の場合の有効な値：1～9 Period が Year の場合の有効な値：1～3
VpcId	String	いいえ	いいえ	VPC ID。	なし
VSwitchId	String	いいえ	いいえ	vSwitch ID。	なし
VSwitchBak	String	いいえ	いいえ	バックアップ用 vSwitch ID。	なし
VSwitchBak2	String	いいえ	いいえ	第 2 バックアップ用 vSwitch ID。	なし
ZoneId	String	いいえ	いいえ	ゾーン ID。	DescribeRegions 操作を呼び出して、サポートされているゾーンを照会できます。
ZoneIdBak	String	いいえ	いいえ	バックアップゾーンの ID。	なし
ZoneIdBak2	String	いいえ	いいえ	第 2 バックアップゾーンの ID。	なし

戻り値

Fn::GetAtt

DBClusterId：クラスター ID
PublicPort：パブリックポート
Bid：ビジネスプロセス ID
LockReason：クラスターがロックされた理由
LockMode：ロックモード
DBClusterVersion：クラスターのバージョン
CommodityCode：商品コード
VpcId：VPC ID
Engine：クラスターのエンジン
Category：クラスターのエディション
DBClusterType：クラスターの仕様
DBClusterNetworkType：ネットワークタイプ
EncryptionType：暗号化タイプ
VpcCloudInstanceId：VPC タイプのクラスターの ID
Port：クラスターへの接続に使用されるポート番号
PaymentType：課金方法
DBNodeStorage：ノードのストレージ容量
PublicConnectionString：パブリックエンドポイント
EngineVersion：エンジンのバージョン
IsExpired：クラスターの有効期限が切れているかどうかを示すフラグ
VSwitchId：vSwitch ID
Period：クラスターのサブスクリプション期間の単位
StorageType：ストレージタイプ
DBNodeCount：ノード数
AliUid：Alibaba Cloud アカウントの ID
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"
      }
    }
  }
}