ALIYUN::POLARDB::DBClusterAccessWhiteList modifies the IP address whitelist of a PolarDB cluster.
Syntax
{
"Type": "ALIYUN::POLARDB::DBClusterAccessWhiteList",
"Properties": {
"DBClusterId": String,
"DBClusterIPArrayName": String,
"SecurityIps": String
}
}Properties
|
Name |
Type |
Required |
Editable |
Description |
Constraint |
|
DBClusterId |
String |
Yes |
No |
The ID of the PolarDB cluster. |
None. |
|
DBClusterIPArrayName |
String |
No |
No |
The name of the IP address whitelist. |
Maximum: 50 whitelists per cluster. Default value: Default. Note
The default IP address whitelist cannot be deleted. If DBClusterIPArrayName is set to Default, ROS skips this whitelist during deletion. |
|
SecurityIps |
String |
Yes |
Yes |
The IP addresses or CIDR blocks in the whitelist. |
Separate multiple entries with commas (,). Supported formats:
Each whitelist supports up to 1,000 entries. |
Return values
Fn::GetAtt
DBClusterId: the ID of the PolarDB cluster.
Examples
{
"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"
]
}
}
}
}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