The ALIYUN::GPDB::DBInstanceIPArray resource creates an IP address whitelist group.
Syntax
{
"Type": "ALIYUN::GPDB::DBInstanceIPArray",
"Properties": {
"DBInstanceId": String,
"DBInstanceIPArrayName": String,
"SecurityIpList": List,
"DBInstanceIPArrayAttribute": String
}
}Properties
Parameter | Type | Required | Editable | Description | Constraints |
DBInstanceId | String | Yes | No | The instance ID. | None |
DBInstanceIPArrayName | String | Yes | No | The name of the IP address whitelist group. | If you do not specify this parameter, the system modifies the default whitelist. > Each instance supports a maximum of 50 IP address whitelists. |
SecurityIpList | List | Yes | Yes | The list of IP addresses in the IP address whitelist group. | You can add up to 1,000 IP addresses or CIDR blocks to a whitelist. Separate multiple entries with commas. The entries must be in one of the following formats: - - - |
DBInstanceIPArrayAttribute | String | No | No | The attribute of the IP address whitelist group. This attribute controls group visibility. For example, the console does not display groups with the | None |
Return values
Fn::GetAtt
DBInstanceIPArrayAttribute: The attribute of the IP address whitelist group. This value is empty by default. The console does not display groups with the 'hidden' attribute.
SecurityIpList: The list of IP addresses in the IP address whitelist group.
DBInstanceIPArrayName: The name of the IP address whitelist group.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DBInstanceIPArrayAttribute:
Type: String
Description:
en: The attribute of the IP address whitelist group. This attribute controls group visibility. This value is empty by default. For example, 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 in the whitelist. You can add up to 1,000 IP addresses or CIDR blocks to a whitelist. Separate multiple entries with commas. The IP addresses must be in one of the following formats:
* 0.0.0.0/0
* 10.23.12.24 (a standard IP address)
* 10.23.12.24/24 (a Classless Inter-Domain Routing (CIDR) block). The value after the slash, such as /24, specifies the prefix length, which can be an integer from 1 to 32.
Required: true
Type: Json
AssociationProperty: List[Parameter]
Description:
en: The list of IP addresses in the IP address whitelist group.
Required: true
MinLength: 0
MaxLength: 999
DBInstanceIPArrayName:
Type: String
Description:
en: |-
The name of the IP address whitelist group. If you do not specify this parameter, the system modifies the default whitelist.
> Each instance supports a maximum of 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 attribute of the IP address whitelist group.
Value:
Fn::GetAtt:
- ExtensionResource
- DBInstanceIPArrayAttribute
SecurityIpList:
Description: The list of IP addresses in the IP address whitelist group.
Value:
Fn::GetAtt:
- ExtensionResource
- SecurityIpList
DBInstanceIPArrayName:
Description: The name of the IP address whitelist group.
Value:
Fn::GetAtt:
- ExtensionResource
- DBInstanceIPArrayName
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"DBInstanceIPArrayAttribute": {
"Type": "String",
"Description": {
"en": "The attribute of the IP address whitelist group. This attribute controls group visibility. This value is empty by default. For example, 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 in the whitelist. You can add up to 1,000 IP addresses or CIDR blocks to a whitelist. Separate multiple entries with commas. The IP addresses must be in one of the following formats:\n* 0.0.0.0/0\n* 10.23.12.24 (a standard IP address)\n* 10.23.12.24/24 (a Classless Inter-Domain Routing (CIDR) block). The value after the slash, such as /24, specifies the prefix length, which can be an integer from 1 to 32."
},
"Required": true
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The list of IP addresses in the IP address whitelist group."
},
"Required": true,
"MinLength": 0,
"MaxLength": 999
},
"DBInstanceIPArrayName": {
"Type": "String",
"Description": {
"en": "The name of the IP address whitelist group. If you do not specify this parameter, the system modifies the default whitelist.\n> Each instance supports a maximum of 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 attribute of the IP address whitelist group.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DBInstanceIPArrayAttribute"
]
}
},
"SecurityIpList": {
"Description": "The list of IP addresses in the IP address whitelist group.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"SecurityIpList"
]
}
},
"DBInstanceIPArrayName": {
"Description": "The name of the IP address whitelist group.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DBInstanceIPArrayName"
]
}
}
}
}