Use ALIYUN::POLARDB::DBClusterAccessWhiteList to modify the IP address whitelist for a PolarDB cluster - Resource Orchestration Service

ALIYUN::POLARDB::DBClusterAccessWhiteList is used to modify the IP address whitelist that allows access to a PolarDB cluster.

Syntax

{
  "Type": "ALIYUN::POLARDB::DBClusterAccessWhiteList",
  "Properties": {
    "DBClusterId": String,
    "DBClusterIPArrayName": String,
    "SecurityIps": String
  }
}

Properties

Name	Type	Required	Editable	Description	Constraint
DBClusterId	String	Yes	No	The ID of the PolarDB cluster.	None.
DBClusterIPArrayName	String	No	No	The name of the IP address whitelist.	A PolarDB cluster supports up to 50 IP address whitelists. Default value: Default. Note The default IP address whitelist of a PolarDB cluster cannot be deleted. If DBClusterIPArrayName is set to Default, Resource Orchestration Service (ROS) ignores the default IP address whitelist during deletion.
SecurityIps	String	Yes	Yes	The segments in the whitelist.	Separate multiple segments with commas (,). The segments support the following formats: IP address, such as 10.23.12.24. CIDR block, such as 10.23.12.24/24, where /24 specifies that the prefix of the CIDR block is 24 bits in length. You can replace 24 with a value that ranges from 1 to 32. A whitelist can contain up to 1,000 segments.

Return values

Fn::GetAtt

DBClusterId: the ID of the PolarDB cluster.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "DBClusterAccessWhiteList": {
      "Type": "ALIYUN::POLARDB::DBClusterAccessWhiteList",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "DBClusterIPArrayName": {
          "Ref": "DBClusterIPArrayName"
        },
        "SecurityIps": {
          "Ref": "SecurityIps"
        }
      }
    }
  },
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist is to be modified."
    },
    "DBClusterIPArrayName": {
      "MinLength": 1,
      "Type": "String",
      "Description": "The name of the IP address whitelist group. If you do not specify this parameter,\nthe Default whitelist group is modified by default.\nNote You can create up to 50 whitelist groups for an ApsaraDB for POLARDB cluster."
    },
    "SecurityIps": {
      "Type": "String",
      "Description": "The IP addresses to be added to the IP address whitelist group to be modified. Each\nwhitelist group can contain a maximum of 1,000 IP addresses. Separate multiple IP\naddresses with a comma (,). The following two formats are supported:\nIP address: for example, 10.23.12.24.\nClassless inter-domain routing (CIDR) block: for example, 10.23.12.24/24, where the\nsuffix /24 indicates the number of bits for the prefix of the IP address. The suffix\nranges from 1 to 32."
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist is to be modified.",
      "Value": {
        "Fn::GetAtt": [
          "DBClusterAccessWhiteList",
          "DBClusterId"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  DBClusterAccessWhiteList:
    Type: ALIYUN::POLARDB::DBClusterAccessWhiteList
    Properties:
      DBClusterId:
        Ref: DBClusterId
      DBClusterIPArrayName:
        Ref: DBClusterIPArrayName
      SecurityIps:
        Ref: SecurityIps
Parameters:
  DBClusterId:
    Type: String
    Description: The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist
      is to be modified.
  DBClusterIPArrayName:
    MinLength: 1
    Type: String
    Description: |-
      The name of the IP address whitelist group. If you do not specify this parameter,
      the Default whitelist group is modified by default.
      Note You can create up to 50 whitelist groups for an ApsaraDB for POLARDB cluster.
  SecurityIps:
    Type: String
    Description: |-
      The IP addresses to be added to the IP address whitelist group to be modified. Each
      whitelist group can contain a maximum of 1,000 IP addresses. Separate multiple IP
      addresses with a comma (,). The following two formats are supported:
      IP address: for example, 10.23.12.24.
      Classless inter-domain routing (CIDR) block: for example, 10.23.12.24/24, where the
      suffix /24 indicates the number of bits for the prefix of the IP address. The suffix
      ranges from 1 to 32.
Outputs:
  DBClusterId:
    Description: The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist
      is to be modified.
    Value:
      Fn::GetAtt:
      - DBClusterAccessWhiteList
      - DBClusterId