ALIYUN::GPDB::DBInstanceIPArray

更新时间:
复制为 MD 格式

ALIYUN::GPDB::DBInstanceIPArray类型用于创建白名单分组。

语法

{
  "Type": "ALIYUN::GPDB::DBInstanceIPArray",
  "Properties": {
    "DBInstanceId": String,
    "DBInstanceIPArrayName": String,
    "SecurityIpList": List,
    "DBInstanceIPArrayAttribute": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

DBInstanceId

String

实例ID。

DBInstanceIPArrayName

String

IP地址白名单的名称。

如果不指定此参数,则查询默认白名单。

> 每个实例最多支持50IP地址白名单。

SecurityIpList

List

IP 白名单分组下的 IP 列表。

长度范围:0-999。最多包含1000IP地址,用逗号分隔,格式如下三种:

- 0.0.0.0/0

- 10.23.12.24(IP)

- 10.23.12.24/24(CIDR模式,无类别域间路由,'/24'表示地址中前缀的长度,范围是'[1,32]')。

DBInstanceIPArrayAttribute

String

IP 白名单分组属性值。

返回值

Fn::GetAtt

  • DBInstanceIPArrayAttribute:默认为空。为了区分不同的属性值,控制台不显示带有'hidden'属性的组。

  • SecurityIpList:IP地址白名单最多包含1000IP地址,用逗号分隔,格式如下三种:

  • DBInstanceIPArrayName:IP地址白名单的名称。如果不指定此参数,则查询默认白名单。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceIPArrayAttribute:
    Type: String
    Description:
      en: The default is empty. To distinguish between different attribute values, the console does not display groups with the 'hidden' attribute.
    Required: false
  DBInstanceId:
    Type: String
    Description:
      en: |
        The instance ID.
    Required: true
  SecurityIpList:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: |-
            The IP addresses listed in the whitelist. You can add up to 1,000 IP addresses to the whitelist. Separate multiple IP addresses with commas (,). The IP addresses must use one of the following formats:
            *   0.0.0.0/0
            *   10.23.12.24. This is a standard IP address.
            *   10.23.12.24/24. This is a CIDR block. The value `/24` indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of `1 to 32`.
        Required: true
    Type: Json
    AssociationProperty: List[Parameter]
    Description:
      en: |-
        The IP address whitelist contains a maximum of 1000 IP addresses separated by commas in the following three formats:
        - 0.0.0.0/0
        - 10.23.12.24(IP)
        - 10.23.12.24/24(CIDR mode, Classless Inter-Domain Routing, '/24' indicates the length of the prefix in the address, and the range is '[1,32]').
    Required: true
    MinLength: 0
    MaxLength: 999
  DBInstanceIPArrayName:
    Type: String
    Description:
      en: |-
        The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried.
        >  Each instance supports up to 50 IP address whitelists.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::GPDB::DBInstanceIPArray
    Properties:
      DBInstanceIPArrayAttribute:
        Ref: DBInstanceIPArrayAttribute
      DBInstanceId:
        Ref: DBInstanceId
      SecurityIpList:
        Ref: SecurityIpList
      DBInstanceIPArrayName:
        Ref: DBInstanceIPArrayName
Outputs:
  DBInstanceIPArrayAttribute:
    Description: The default is empty. To distinguish between different attribute values, the console does not display groups with the 'hidden' attribute.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DBInstanceIPArrayAttribute
  SecurityIpList:
    Description: The IP address whitelist contains a maximum of 1000 IP addresses separated by commas in the following three formats:.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SecurityIpList
  DBInstanceIPArrayName:
    Description: The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DBInstanceIPArrayName
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceIPArrayAttribute": {
      "Type": "String",
      "Description": {
        "en": "The default is empty. To distinguish between different attribute values, the console does not display groups with the 'hidden' attribute."
      },
      "Required": false
    },
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The instance ID.\n"
      },
      "Required": true
    },
    "SecurityIpList": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "The IP addresses listed in the whitelist. You can add up to 1,000 IP addresses to the whitelist. Separate multiple IP addresses with commas (,). The IP addresses must use one of the following formats:\n*   0.0.0.0/0\n*   10.23.12.24. This is a standard IP address.\n*   10.23.12.24/24. This is a CIDR block. The value `/24` indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of `1 to 32`."
          },
          "Required": true
        }
      },
      "Type": "Json",
      "AssociationProperty": "List[Parameter]",
      "Description": {
        "en": "The IP address whitelist contains a maximum of 1000 IP addresses separated by commas in the following three formats:\n- 0.0.0.0/0\n- 10.23.12.24(IP)\n- 10.23.12.24/24(CIDR mode, Classless Inter-Domain Routing, '/24' indicates the length of the prefix in the address, and the range is '[1,32]')."
      },
      "Required": true,
      "MinLength": 0,
      "MaxLength": 999
    },
    "DBInstanceIPArrayName": {
      "Type": "String",
      "Description": {
        "en": "The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried.\n>  Each instance supports up to 50 IP address whitelists."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::GPDB::DBInstanceIPArray",
      "Properties": {
        "DBInstanceIPArrayAttribute": {
          "Ref": "DBInstanceIPArrayAttribute"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "SecurityIpList": {
          "Ref": "SecurityIpList"
        },
        "DBInstanceIPArrayName": {
          "Ref": "DBInstanceIPArrayName"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceIPArrayAttribute": {
      "Description": "The default is empty. To distinguish between different attribute values, the console does not display groups with the 'hidden' attribute.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DBInstanceIPArrayAttribute"
        ]
      }
    },
    "SecurityIpList": {
      "Description": "The IP address whitelist contains a maximum of 1000 IP addresses separated by commas in the following three formats:.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SecurityIpList"
        ]
      }
    },
    "DBInstanceIPArrayName": {
      "Description": "The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DBInstanceIPArrayName"
        ]
      }
    }
  }
}