ALIYUN::POLARDB::GlobalSecurityIPGroup - Resource Orchestration Service

ALIYUN::POLARDB::GlobalSecurityIPGroup is used to create a global IP whitelist template.

Syntax

{
  "Type": "ALIYUN::POLARDB::GlobalSecurityIPGroup",
  "Properties": {
    "GlobalIgName": String,
    "GIpList": List,
    "ResourceGroupId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
GlobalIgName	String	Yes	No	The name of the global IP whitelist template.	The name of the global IP whitelist template must meet the following requirements: The name can contain lowercase letters, digits, and underscores (_). It must start with a letter and end with a letter or digit. It must be 2 to 120 characters in length.
GIpList	List	Yes	Yes	The entries in the global IP whitelist template.	You can add up to 1,000 IP addresses or CIDR blocks to the global IP whitelist template.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.

Return values

Fn::GetAtt

GlobalSecurityGroupId: the ID of the global IP whitelist template.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GlobalIgName:
    Type: String
    Description:
      en: |-
        The name of the IP whitelist template. The name must meet the following requirements:
        The name can contain lowercase letters, digits, and underscores (_).
        The name must start with a letter and end with a letter or digit.
        The name must be 2 to 120 characters in length.
    Required: true
    AllowedPattern: ^[a-z][a-z0-9_]*[a-z0-9]$
    MinLength: 2
    MaxLength: 120
  GIpList:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: The IP address in the whitelist template.
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: |-
        The IP addresses in the whitelist template.
        You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.
    Required: true
    MinLength: 1
    MaxLength: 1000
Resources:
  GlobalSecurityIPGroup:
    Type: ALIYUN::POLARDB::GlobalSecurityIPGroup
    Properties:
      GlobalIgName:
        Ref: GlobalIgName
      GIpList:
        Ref: GIpList
Outputs:
  GlobalSecurityGroupId:
    Description: The ID of the IP whitelist template.
    Value:
      Fn::GetAtt:
        - GlobalSecurityIPGroup
        - GlobalSecurityGroupId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GlobalIgName": {
      "Type": "String",
      "Description": {
        "en": "The name of the IP whitelist template. The name must meet the following requirements:\nThe name can contain lowercase letters, digits, and underscores (_).\nThe name must start with a letter and end with a letter or digit.\nThe name must be 2 to 120 characters in length."
      },
      "Required": true,
      "AllowedPattern": "^[a-z][a-z0-9_]*[a-z0-9]$",
      "MinLength": 2,
      "MaxLength": 120
    },
    "GIpList": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "The IP address in the whitelist template."
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "The IP addresses in the whitelist template.\nYou can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 1000
    }
  },
  "Resources": {
    "GlobalSecurityIPGroup": {
      "Type": "ALIYUN::POLARDB::GlobalSecurityIPGroup",
      "Properties": {
        "GlobalIgName": {
          "Ref": "GlobalIgName"
        },
        "GIpList": {
          "Ref": "GIpList"
        }
      }
    }
  },
  "Outputs": {
    "GlobalSecurityGroupId": {
      "Description": "The ID of the IP whitelist template.",
      "Value": {
        "Fn::GetAtt": [
          "GlobalSecurityIPGroup",
          "GlobalSecurityGroupId"
        ]
      }
    }
  }
}