すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::ADBLake::DBCluster

最終更新日:Jan 23, 2025

ALIYUN::ADBLake::DBCluster は、AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタを作成するために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ComputeResource

String

はい

いいえ

予約済みの計算リソース。

有効な値: 0 ~ 4096。値は 16 ずつ増加する必要があります。単位: AnalyticDB 計算ユニット (ACU)。1 つの ACU は 1 コアと 4 GB のメモリに相当します。

説明

このプロパティには、単位を含む値を指定する必要があります。

DBClusterVersion

String

はい

いいえ

AnalyticDB for MySQL Data Lakehouse Edition クラスタのバージョン。

値を 3.0 に設定します。

PayType

String

はい

いいえ

課金方法。

有効な値:

  • Postpaid: 従量課金

  • Prepaid: サブスクリプション

StorageResource

String

はい

いいえ

予約済みのストレージリソース。

有効な値: 0 ~ 2064。値は 24 ずつ増加する必要があります。単位: ACU。1 つの ACU は 1 コアと 4 GB のメモリに相当します。

説明

このプロパティには、単位を含む値を指定する必要があります。

VPCId

String

はい

いいえ

仮想プライベートクラウド (VPC) の ID。

なし。

VSwitchId

String

はい

いいえ

vSwitch ID。

なし。

ZoneId

String

はい

いいえ

ゾーン ID。

説明

DescribeRegions 操作を呼び出すことで、AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタでサポートされているゾーンの ID をクエリできます。

BackupSetId

String

いいえ

いいえ

バックアップセットの ID。

なし。

DBClusterDescription

String

いいえ

いいえ

AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタの説明。

説明には以下の制限があります。

  • http:// または https:// で始めることはできません。

  • 長さは 2 ~ 256 文字である必要があります。

EnableDefaultResourcePool

Boolean

いいえ

いいえ

予約済みのすべての計算リソースをデフォルトのリソースグループに割り当てるかどうかを指定します。

有効な値:

  • true (デフォルト)

  • false

PeriodType

String

いいえ

いいえ

サブスクリプション AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタのサブスクリプションタイプ。

有効な値:

  • Year: 年間サブスクリプション

  • Month: 月間サブスクリプション

Period

String

いいえ

いいえ

サブスクリプション AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタのサブスクリプション期間。

  • PeriodType が Year に設定されている場合の Period の有効な値: 1 ~ 3。値は整数である必要があります。

  • PeriodType が Month に設定されている場合の Period の有効な値: 1 ~ 9。値は整数である必要があります。

RestoreToTime

String

いいえ

いいえ

バックアップセットからデータを復元する時点。

なし。

ResourceGroupId

String

いいえ

いいえ

リソースグループの ID。

なし。

RestoreType

String

いいえ

いいえ

データの復元に使用するメソッド。

有効な値:

  • backup: バックアップセットからデータを復元します。BackupSetIdSourceDBClusterId も指定する必要があります。

  • timepoint: データを特定の時点に復元します。RestoreToTimeSourceDBClusterId も指定する必要があります。

SourceDbClusterId

String

いいえ

いいえ

ソース AnalyticDB for MySQL Data Warehouse Edition クラスタの ID。

なし。

Tags

List

いいえ

はい

タグに関する情報。

詳細については、「タグのプロパティ」をご参照ください。

タグの構文

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

タグのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Key

String

はい

いいえ

タグキー。

1 ~ 20 個のタグキーを指定できます。

Value

String

いいえ

いいえ

タグ値。

1 ~ 20 個のタグ値を指定できます。

戻り値

Fn::GetAtt

  • DBClusterId: AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタの ID。

  • OrderId: 注文 ID。

  • ConnectionString: AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタのエンドポイント。

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  StorageResource:
    Type: String
    Description:
      ja: |-
        予約済みのストレージリソースの量。単位: AnalyticDB 計算ユニット (ACU)。有効な値: 0ACU ~ 2064ACU。値は 24 ACU ずつ増加する必要があります。各 ACU は 1 コアと 4 GB のメモリに相当します。
        注: このパラメータには単位を指定する必要があります。
    Required: true
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      ja: |-
        ゾーン ID。
        注:  DescribeRegions  操作を呼び出すことで、最新のゾーンリストをクエリできます。
    Required: true
  VPCId:
    Type: String
    Description:
      ja: クラスタの仮想プライベートクラウド (VPC) ID。
    Required: true
  VSwitchId:
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    Type: String
    Description:
      ja: クラスタの vSwitch ID。
    Required: true
  ComputeResource:
    Type: String
    Description:
      ja: |-
        予約済みの計算リソースの量。単位: ACU。有効な値: 0ACU ~ 4096ACU。値は 16 ACU ずつ増加する必要があります。各 ACU は 1 コアと 4 GB のメモリに相当します。
        注: このパラメータには単位を指定する必要があります。
    Required: true
  PayType:
    Type: String
    Description:
      ja: |-
        クラスタの課金方法。有効な値:
        Postpaid: 従量課金。
        Prepaid: サブスクリプション。
    AllowedValues:
      - PayAsYouGo
      - Subscription
    Required: true
    Default: PayAsYouGo
  DBClusterVersion:
    Type: String
    Description:
      ja: クラスタのバージョン。値を 3.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: AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタの ID。
    Value:
      Fn::GetAtt:
        - DBCluster
        - DBClusterId
  OrderId:
    Description: 注文 ID。
    Value:
      Fn::GetAtt:
        - DBCluster
        - OrderId
  ConnectionString:
    Description: クラスタへの接続に使用するパブリックエンドポイント。
    Value:
      Fn::GetAtt:
        - DBCluster
        - ConnectionString

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "StorageResource": {
      "Type": "String",
      "Description": {
        "ja": "予約済みのストレージリソースの量。単位: AnalyticDB 計算ユニット (ACU)。有効な値: 0ACU ~ 2064ACU。値は 24 ACU ずつ増加する必要があります。各 ACU は 1 コアと 4 GB のメモリに相当します。\n注: このパラメータには単位を指定する必要があります。"
      },
      "Required": true
    },
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "ja": "ゾーン ID。\n注:  DescribeRegions  操作を呼び出すことで、最新のゾーンリストをクエリできます。"
      },
      "Required": true
    },
    "VPCId": {
      "Type": "String",
      "Description": {
        "ja": "クラスタの仮想プライベートクラウド (VPC) ID。"
      },
      "Required": true
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "ja": "クラスタの vSwitch ID。"
      },
      "Required": true
    },
    "ComputeResource": {
      "Type": "String",
      "Description": {
        "ja": "予約済みの計算リソースの量。単位: ACU。有効な値: 0ACU ~ 4096ACU。値は 16 ACU ずつ増加する必要があります。各 ACU は 1 コアと 4 GB のメモリに相当します。\n注: このパラメータには単位を指定する必要があります。"
      },
      "Required": true
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "ja": "クラスタの課金方法。有効な値:\nPostpaid: 従量課金。\nPrepaid: サブスクリプション。"
      },
      "AllowedValues": [
        "PayAsYouGo",
        "Subscription"
      ],
      "Required": true,
      "Default": "PayAsYouGo"
    },
    "DBClusterVersion": {
      "Type": "String",
      "Description": {
        "ja": "クラスタのバージョン。値を 3.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": "AnalyticDB for MySQL Data Lakehouse Edition (V3.0) クラスタの ID。",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "DBClusterId"
        ]
      }
    },
    "OrderId": {
      "Description": "注文 ID。",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "OrderId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "クラスタへの接続に使用するパブリックエンドポイント。",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "ConnectionString"
        ]
      }
    }
  }
}