The ALIYUN::REDIS::Whitelist type is used to configure IP whitelists of an ApsaraDB for Redis instance.

Syntax

{
  "Type": "ALIYUN::REDIS::Whitelist",
  "Properties": {
    "InstanceId": String,
    "SecurityIpGroupName": String,
    "SecurityIpGroupAttribute": String,
    "SecurityIps": String
  }
}

Properties

Property Type Required Editable Description Validity
InstanceId String Yes No The ID of the ApsaraDB for Redis instance, which is globally unique. None
SecurityIpGroupName String No No The name of the whitelist group that you want to configure. Default value: default. None
SecurityIpGroupAttribute String No No The attribute value of the whitelist group that you want to configure. By default, this parameter is null. The console does not display the whitelist group for which this parameter is set to hidden. None
SecurityIps String Yes Yes The list of IP addresses in the IP whitelist group. IP addresses are separated by commas (,) in either of the following format: (1) 0.0.0.0/0, 10.23.12.24 for IP addresses. (2) 10.23.12.24/24 for CIDR blocks. /24 represents the length of the prefix in the IP address. The prefix length can range from 1 to 32. A maximum of 1,000 IP addresses can be added.

Response parameters

Fn::GetAtt

  • SecurityIpGroupName: the name of the whitelist group.
  • SecurityIpGroupAttribute: the attribute value of the whitelist group.
  • SecurityIps: the IP whitelist that you modified.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Whitelist": {
      "Type": "ALIYUN::REDIS::Whitelist",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "SecurityIpGroupName": {
          "Ref": "SecurityIpGroupName"
        },
        "SecurityIpGroupAttribute": {
          "Ref": "SecurityIpGroupAttribute"
        },
        "SecurityIps": {
          "Ref": "SecurityIps"
        }
      }
    }
  },
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "The ID of the ApsaraDB for Redis instance, which is globally unique."
    },
    "SecurityIpGroupName": {
      "AllowedPattern": "[a-z][a-zA-Z0-9_]*[a-zA-Z0-9]",
      "MinLength": 2,
      "Type": "String",
      "Description": "The name of the whitelist group that you want to configure.",
      "MaxLength": 32
    },
    "SecurityIpGroupAttribute": {
      "Type": "String",
      "Description": ""By default, this parameter is null. To distinguish attribute values, the console does not display the whitelist group for which this parameter is set to hidden. "
    },
    "SecurityIps": {
      "Type": "String",
      "Description": "The list of IP addresses in the IP whitelist group."
    }
  },
  "Outputs": {
    "SecurityIpGroupName": {
      "Description": "The name of the whitelist group.",
      "Value": {
        "Fn::GetAtt": [
          "Whitelist",
          "SecurityIpGroupName"
        ]
      }
    },
    "SecurityIpGroupAttribute": {
      "Description": "The attribute value of the whitelist group.",
      "Value": {
        "Fn::GetAtt": [
          "Whitelist",
          "SecurityIpGroupAttribute"
        ]
      }
    },
    "SecurityIps": {
      "Description": "The IP whitelist that you modified.",
      "Value": {
        "Fn::GetAtt": [
          "Whitelist",
          "SecurityIps"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Whitelist:
    Type: ALIYUN::REDIS::Whitelist
    Properties:
      InstanceId:
        Ref: InstanceId
      SecurityIpGroupName:
        Ref: SecurityIpGroupName
      SecurityIpGroupAttribute:
        Ref: SecurityIpGroupAttribute
      SecurityIps:
        Ref: SecurityIps
Parameters:
  InstanceId:
    Type: String
    Description: The ID of the ApsaraDB for Redis instance, which is globally unique.
  SecurityIpGroupName:
    AllowedPattern: "[a-z][a-zA-Z0-9_]*[a-zA-Z0-9]"
    MinLength: 2
    Type: String
    Description: The name of the whitelist group that you want to configure.
    MaxLength: 32
  SecurityIpGroupAttribute:
    Type: String
    Description: By default, this parameter is null. To distinguish attribute values, the console does not display the whitelist group for which this parameter is set to hidden.
  SecurityIps:
    Type: String
    Description: The list of IP addresses in the IP whitelist group.
Outputs:
  SecurityIpGroupName:
    Description: The name of the whitelist group.
    Value:
      Fn::GetAtt:
      - Whitelist
      - SecurityIpGroupName
  SecurityIpGroupAttribute:
    Description: The attribute value of the whitelist group.
    Value:
      Fn::GetAtt:
      - Whitelist
      - SecurityIpGroupAttribute
  SecurityIps:
    Description: The IP whitelist that you modified.
    Value:
      Fn::GetAtt:
      - Whitelist
      - SecurityIps