ALIYUN::POLARDB::DBClusterAccessWhiteList is used to modify the list of IP addresses that are allowed to access an ApsaraDB for POLARDB cluster.

Syntax

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

Properties

Name Type Required Editable Description Validity
DBClusterId String Yes No The ID of the ApsaraDB for POLARDB cluster. None
DBClusterIPArrayName String No No The name of the IP address whitelist. You can create up to 50 whitelists for an ApsaraDB for POLARDB cluster. Default value: Default.
SecurityIps String Yes Yes The list of IP addresses in the whitelist. Separate multiple IP addresses with commas (,). The following two formats are supported:
  • Standard IP address format, such as 10.23.12.24.
  • Classless Inter-Domain Routing (CIDR) format, such as 10.23.12.24/24 (where /24 indicates the number of bits for the prefix of the IP address, in the range of 1 to 32).
A whitelist can contain up to 1,000 IP addresses.

Response parameters

Fn::GetAtt

DBClusterId: the ID of the cluster.

Examples

JSON format 

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

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