ALIYUN::POLARDB::DBClusterEndpoint を使用して PolarDB のカスタムクラスターエンドポイントを作成する - Resource Orchestration Service

ALIYUN::POLARDB::DBClusterEndpoint タイプは、PolarDB のカスタムクラスターエンドポイントを作成します。

構文

{
  "Type": "ALIYUN::POLARDB::DBClusterEndpoint",
  "Properties": {
    "DBClusterId": String,
    "ReadWriteMode": String,
    "EndpointType": String,
    "AutoAddNewNodes": String,
    "Nodes": List,
    "EndpointConfig": Map
  }
}

プロパティ

プロパティ名	タイプ	必須	更新可否	説明	制約
DBClusterId	String	はい	いいえ	クラスター ID。	なし
ReadWriteMode	String	いいえ	はい	読み書きモード。	有効な値： ReadWrite：自動読み書き分離を伴う読み書きモード。 ReadOnly (デフォルト)：読み取り専用モード。
EndpointType	String	いいえ	いいえ	カスタムクラスターエンドポイントのタイプ。	有効な値： Custom。
AutoAddNewNodes	String	いいえ	はい	新しく追加されたノードをカスタムクラスターエンドポイントに自動的に追加するかどうかを指定します。	有効な値： Enable Disable (デフォルト)
Nodes	List	いいえ	はい	読み取りリクエストを処理するノード。	例： `["pi-bpsg35x**", "pi-bp3ddh**"]`。値には少なくとも 2 つのノードを含める必要があります。デフォルト値はすべてのノードです。
EndpointConfig	Map	いいえ	はい	カスタムエンドポイントの詳細設定。	詳細については、「EndpointConfig プロパティ」をご参照ください。

EndpointConfig の構文

"EndpointConfig": {
  "ConsistLevel": String,
  "ConsistTimeout": String,
  "LoadBalancePolicy": String,
  "ConnectionPersist": String,
  "DistributedTransaction": String,
  "EnableOverloadThrottle": String,
  "MasterAcceptReads": String,
  "ConsistTimeoutAction": String,
  "EnableHtapImci": String,
  "MaxParallelDegree": String
}

EndpointConfig プロパティ

プロパティ名	タイプ	必須	更新可否	説明	制約
ConsistLevel	String	いいえ	はい	一貫性レベル。	有効な値： 0：結果整合性説明 ReadWriteMode パラメーターを ReadOnly に設定した場合、一貫性レベルは 0 のみ指定できます。 1 (デフォルト)：セッション整合性
ConsistTimeout	String	いいえ	はい	グローバル一貫性読み取りのタイムアウト。	なし
LoadBalancePolicy	String	いいえ	はい	負荷分散ポリシー。	形式： `{"LoadBalancePolicy":"<値>"}` 有効な値： 0：接続数に基づく負荷分散 (デフォルト)。 1：アクティブなリクエスト数に基づく負荷分散。
ConnectionPersist	String	いいえ	はい	コネクションプール。	形式： `{"ConnectionPersist":"<値>"}` 有効な値： off：コネクションプールを無効にします (デフォルト)。 Session：セッションレベルのコネクションプールを有効にします。 Transaction：トランザクションレベルのコネクションプーリングを有効にします。
DistributedTransaction	String	いいえ	はい	トランザクション分割。	形式： `{"DistributedTransaction":"<値>"}` 有効な値： on：トランザクション分割を有効にします (デフォルト)。 off：トランザクション分割を無効にします。
EnableOverloadThrottle	String	いいえ	はい	過負荷保護の有効化。	形式： `{"EnableOverloadThrottle":"<値>"}` 有効な値： on：過負荷保護を有効にします。 off：過負荷保護を無効にします (デフォルト)。
MasterAcceptReads	String	いいえ	はい	プライマリノードでの読み取りリクエストの受付。	形式： `{"MasterAcceptReads":"<値>"}` 有効な値： on：プライマリノードが読み取りリクエストを受け入れます。 off：プライマリノードは読み取りリクエストを受け入れません (デフォルト)。
ConsistTimeoutAction	String	いいえ	はい	グローバル一貫性読み取りのタイムアウト処理ポリシー。	有効な値： 0：リクエストをプライマリノードに送信します (デフォルト)。 1： SQL エラーを返します。
EnableHtapImci	String	いいえ	はい	行ストア/カラムストア間の自動トラフィックステアリングの有効化。	形式： `{"EnableHtapImci":"<値>"}` 有効な値： on：行ストアとカラムストア間の自動トラフィックステアリングを有効にします。 off：行ストアとカラムストア間の自動トラフィックステアリングを無効にします (デフォルト)。
MaxParallelDegree	String	いいえ	はい	パラレルクエリの有効化。	形式： `{"MaxParallelDegree":"<値>"}` 有効な値： on：パラレルクエリを有効にします。 off：パラレルクエリを無効にします (デフォルト)。

戻り値

Fn::GetAtt

DBEndpointId：クラスターエンドポイントの ID。
ConnectionString：接続文字列。
Addresses： IP アドレス。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  DBClusterEndpoint:
    Type: ALIYUN::POLARDB::DBClusterEndpoint
    Properties:
      DBClusterId:
        Ref: DBClusterId
      ReadWriteMode:
        Ref: ReadWriteMode
      EndpointConfig:
        Ref: EndpointConfig
      AutoAddNewNodes:
        Ref: AutoAddNewNodes
      Nodes:
        Fn::Split:
        - ","
        - Ref: Nodes
      EndpointType:
        Ref: EndpointType
Parameters:
  DBClusterId:
    Type: String
    Description: カスタムエンドポイントを作成する PolarDB クラスターの ID。
  ReadWriteMode:
    Default: ReadOnly
    Type: String
    Description: 'クラスターエンドポイントの読み書きモード。有効な値： ReadWrite： 読み取りリクエストと書き込みリクエストを転送します (自動読み書き分離)。ReadOnly： 読み取りリクエストのみを転送します。デフォルト値： ReadOnly。'
    AllowedValues:
    - ReadOnly
    - ReadWrite
  EndpointConfig:
    Type: Json
    Description: 'カスタムエンドポイントの詳細設定。'
  AutoAddNewNodes:
    Default: Disable
    Type: String
    Description: |-
      新しく追加されたノードをこのエンドポイントに自動的に追加するかどうかを指定します。
      有効な値： Enable、Disable。
      デフォルト値： Disable。
    AllowedValues:
    - Disable
    - Enable
  Nodes:
    MinLength: 2
    Type: CommaDelimitedList
    Description: |-
      このエンドポイントで読み取りリクエストを処理するために追加するノード。少なくとも 2 つのノードを追加してください。
      このパラメーターを指定しない場合、デフォルトでクラスターのすべてのノードがこのエンドポイントに追加されます。
  EndpointType:
    Default: Custom
    Type: String
    Description: クラスターエンドポイントのタイプ。このパラメーターを Custom に設定します。
Outputs:
  DBEndpointId:
    Description: データベースクラスターエンドポイント ID。例： pe-xxxxxxxx。
    Value:
      Fn::GetAtt:
      - DBClusterEndpoint
      - DBEndpointId
  ConnectionString:
    Description: データベースクラスターエンドポイントの最初の接続文字列。
    Value:
      Fn::GetAtt:
      - DBClusterEndpoint
      - ConnectionString
  Addresses:
    Description: データベースクラスターエンドポイントの IP アドレス。
    Value:
      Fn::GetAtt:
      - DBClusterEndpoint
      - Addresses

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "DBClusterEndpoint": {
      "Type": "ALIYUN::POLARDB::DBClusterEndpoint",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "ReadWriteMode": {
          "Ref": "ReadWriteMode"
        },
        "EndpointConfig": {
          "Ref": "EndpointConfig"
        },
        "AutoAddNewNodes": {
          "Ref": "AutoAddNewNodes"
        },
        "Nodes": {
          "Fn::Split": [
            ",",
            {
              "Ref": "Nodes"
            }
          ]
        },
        "EndpointType": {
          "Ref": "EndpointType"
        }
      }
    }
  },
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "カスタムエンドポイントを作成する PolarDB クラスターの ID。"
    },
    "ReadWriteMode": {
      "Default": "ReadOnly",
      "Type": "String",
      "Description": "クラスターエンドポイントの読み書きモード。有効な値： ReadWrite： 読み取りリクエストと書き込みリクエストを転送します (自動読み書き分離)。ReadOnly： 読み取りリクエストのみを転送します。デフォルト値： ReadOnly。",
      "AllowedValues": [
        "ReadOnly",
        "ReadWrite"
      ]
    },
    "EndpointConfig": {
      "Type": "Json",
      "Description": "カスタムエンドポイントの詳細設定。"
    },
    "AutoAddNewNodes": {
      "Default": "Disable",
      "Type": "String",
      "Description": "新しく追加されたノードをこのエンドポイントに自動的に追加するかどうかを指定します。\n有効な値： Enable、Disable。\nデフォルト値： Disable。",
      "AllowedValues": [
        "Disable",
        "Enable"
      ]
    },
    "Nodes": {
      "MinLength": 2,
      "Type": "CommaDelimitedList",
      "Description": "このエンドポイントで読み取りリクエストを処理するために追加するノード。少なくとも 2 つのノードを追加してください。\nこのパラメーターを指定しない場合、デフォルトでクラスターのすべてのノードがこのエンドポイントに追加されます。"
    },
    "EndpointType": {
      "Default": "Custom",
      "Type": "String",
      "Description": "クラスターエンドポイントのタイプ。このパラメーターを Custom に設定します。"
    }
  },
  "Outputs": {
    "DBEndpointId": {
      "Description": "データベースクラスターエンドポイント ID。例： pe-xxxxxxxx。",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpoint",
          "DBEndpointId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "データベースクラスターエンドポイントの最初の接続文字列。",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpoint",
          "ConnectionString"
        ]
      }
    },
    "Addresses": {
      "Description": "データベースクラスターエンドポイントの IP アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpoint",
          "Addresses"
        ]
      }
    }
  }
}