ALIYUN::POLARDB::DBClusterAccessWhiteList - ROS

ALIYUN::POLARDB::DBClusterAccessWhiteList は、PolarDB クラスタへのアクセスを許可する IP アドレスホワイトリストを変更するために使用されます。

構文

{
  "Type": "ALIYUN::POLARDB::DBClusterAccessWhiteList",
  "Properties": {
    "DBClusterId": String, // PolarDB クラスタID
    "DBClusterIPArrayName": String, // IPアドレス ホワイトリスト名
    "SecurityIps": String // ホワイトリスト内のセグメント
  }
}

プロパティ

名前	タイプ	必須	編集可能	説明	制約
DBClusterId	String	はい	いいえ	PolarDB クラスタの ID。	なし。
DBClusterIPArrayName	String	いいえ	いいえ	IP アドレスホワイトリストの名前。	PolarDB クラスタは最大 50 個の IP アドレスホワイトリストをサポートします。デフォルト値：Default。説明 PolarDB クラスタのデフォルト IP アドレスホワイトリストは削除できません。DBClusterIPArrayName が Default に設定されている場合、Resource Orchestration Service (ROS) は削除中にデフォルトの IP アドレスホワイトリストを無視します。
SecurityIps	String	はい	はい	ホワイトリスト内のセグメント。	複数のセグメントはカンマ (,) で区切ります。セグメントは次の形式をサポートしています： IP アドレス。例：10.23.12.24。 CIDR ブロック。例：10.23.12.24/24。/24 は、CIDR ブロックのプレフィックスの長さが 24 ビットであることを指定します。24 は 1 から 32 までの値に置き換えることができます。ホワイトリストには最大 1,000 個のセグメントを含めることができます。

戻り値

Fn::GetAtt

DBClusterId: PolarDB クラスタの ID。

例

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "DBClusterAccessWhiteList": {
      "Type": "ALIYUN::POLARDB::DBClusterAccessWhiteList",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId" // 変更する ApsaraDB for POLARDB クラスタのIDを参照
        },
        "DBClusterIPArrayName": {
          "Ref": "DBClusterIPArrayName" // 変更する IPアドレス ホワイトリストグループ名を参照
        },
        "SecurityIps": {
          "Ref": "SecurityIps" // 変更する IPアドレス ホワイトリストグループに追加する IPアドレスを参照
        }
      }
    }
  },
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "IP アドレス ホワイトリストを変更する ApsaraDB for POLARDB クラスタの ID。" // 変更する ApsaraDB for POLARDB クラスタのID
    },
    "DBClusterIPArrayName": {
      "MinLength": 1,
      "Type": "String",
      "Description": "IP アドレス ホワイトリストグループの名前。このパラメータを指定しない場合、デフォルトで Default ホワイトリストグループが変更されます。\nApsaraDB for POLARDB クラスタには最大 50 個のホワイトリストグループを作成できます。" // 変更する IPアドレス ホワイトリストグループ名。指定しない場合は、デフォルトで Default ホワイトリストグループが変更されます。
    },
    "SecurityIps": {
      "Type": "String",
      "Description": "変更する IP アドレス ホワイトリストグループに追加する IP アドレス。各ホワイトリストグループには最大 1,000 個の IP アドレスを含めることができます。複数の IP アドレスはカンマ (,) で区切ります。次の 2 つの形式がサポートされています。\nIP アドレス: 例: 10.23.12.24。\nクラスレス ドメイン間ルーティング (CIDR) ブロック: 例: 10.23.12.24/24。サフィックス /24 は、IP アドレスのプレフィックスのビット数を示します。サフィックスの範囲は 1 ～ 32 です。" // 変更する IPアドレス ホワイトリストグループに追加する IPアドレス
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "IP アドレス ホワイトリストを変更する ApsaraDB for POLARDB クラスタの ID。", // 変更する ApsaraDB for POLARDB クラスタのID
      "Value": {
        "Fn::GetAtt": [
          "DBClusterAccessWhiteList",
          "DBClusterId"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  DBClusterAccessWhiteList:
    Type: ALIYUN::POLARDB::DBClusterAccessWhiteList
    Properties:
      DBClusterId:
        Ref: DBClusterId # 変更する ApsaraDB for POLARDB クラスタのIDを参照
      DBClusterIPArrayName:
        Ref: DBClusterIPArrayName # 変更する IPアドレス ホワイトリストグループ名を参照
      SecurityIps:
        Ref: SecurityIps # 変更する IPアドレス ホワイトリストグループに追加する IPアドレスを参照
Parameters:
  DBClusterId:
    Type: String
    Description: IP アドレス ホワイトリストを変更する ApsaraDB for POLARDB クラスタの ID。 # 変更する ApsaraDB for POLARDB クラスタのID
  DBClusterIPArrayName:
    MinLength: 1
    Type: String
    Description: |-
      IP アドレス ホワイトリストグループの名前。このパラメータを指定しない場合、
      デフォルトで Default ホワイトリストグループが変更されます。
      ApsaraDB for POLARDB クラスタには最大 50 個のホワイトリストグループを作成できます。 # 変更する IPアドレス ホワイトリストグループ名。指定しない場合は、デフォルトで Default ホワイトリストグループが変更されます。
  SecurityIps:
    Type: String
    Description: |-
      変更する IP アドレス ホワイトリストグループに追加する IP アドレス。各
      ホワイトリストグループには最大 1,000 個の IP アドレスを含めることができます。複数の IP
      アドレスはカンマ (,) で区切ります。次の 2 つの形式がサポートされています。
      IP アドレス: 例: 10.23.12.24。
      クラスレス ドメイン間ルーティング (CIDR) ブロック: 例: 10.23.12.24/24。
      サフィックス /24 は、IP アドレスのプレフィックスのビット数を示します。サフィックス
      の範囲は 1 ～ 32 です。 # 変更する IPアドレス ホワイトリストグループに追加する IPアドレス
Outputs:
  DBClusterId:
    Description: IP アドレス ホワイトリストを変更する ApsaraDB for POLARDB クラスタの ID。 # 変更する ApsaraDB for POLARDB クラスタのID
    Value:
      Fn::GetAtt:
      - DBClusterAccessWhiteList
      - DBClusterId