The ALIYUN::ClickHouse::EnterpriseDBClusterSecurityIP resource modifies the whitelist for a cluster.
Syntax
{
"Type": "ALIYUN::ClickHouse::EnterpriseDBClusterSecurityIP",
"Properties": {
"DbInstanceId": String,
"GroupName": String,
"SecurityIpList": String
}
}
Properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
DbInstanceId |
String |
Yes |
No |
The cluster ID. |
None |
|
GroupName |
String |
Yes |
No |
The name of the whitelist group. |
None |
|
SecurityIpList |
String |
Yes |
Yes |
The IP addresses and CIDR blocks for the whitelist group. |
None |
Return values
Fn::GetAtt
-
GroupName: The name of the whitelist group.
-
SecurityIpList: The IP addresses and CIDR blocks in the whitelist group.
-
SecurityIpType: The type of IP address.
-
WhitelistNetType: The network type of the whitelist.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GroupName:
Type: String
Description: The name of the whitelist whose settings you want to modify.
Required: true
SecurityIpList:
Type: String
Description: The IP addresses and CIDR blocks in the whitelist.
Required: true
DbInstanceId:
Type: String
Description: The cluster ID.
Required: true
Resources:
ExtensionResource:
Type: ALIYUN::ClickHouse::EnterpriseDBClusterSecurityIP
Properties:
GroupName:
Ref: GroupName
SecurityIpList:
Ref: SecurityIpList
DbInstanceId:
Ref: DbInstanceId
Outputs:
GroupName:
Description: The name of the whitelist whose settings you want to modify.
Value:
Fn::GetAtt:
- ExtensionResource
- GroupName
SecurityIpList:
Description: The IP addresses and CIDR blocks in the whitelist.
Value:
Fn::GetAtt:
- ExtensionResource
- SecurityIpList
SecurityIpType:
Description: The type of IP address.
Value:
Fn::GetAtt:
- ExtensionResource
- SecurityIpType
WhitelistNetType:
Description: The network type of the whitelist.
Value:
Fn::GetAtt:
- ExtensionResource
- WhitelistNetType
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"GroupName": {
"Type": "String",
"Description": "The name of the whitelist whose settings you want to modify.",
"Required": true
},
"SecurityIpList": {
"Type": "String",
"Description": "The IP addresses and CIDR blocks in the whitelist.",
"Required": true
},
"DbInstanceId": {
"Type": "String",
"Description": "The cluster ID.",
"Required": true
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::ClickHouse::EnterpriseDBClusterSecurityIP",
"Properties": {
"GroupName": {
"Ref": "GroupName"
},
"SecurityIpList": {
"Ref": "SecurityIpList"
},
"DbInstanceId": {
"Ref": "DbInstanceId"
}
}
}
},
"Outputs": {
"GroupName": {
"Description": "The name of the whitelist whose settings you want to modify.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"GroupName"
]
}
},
"SecurityIpList": {
"Description": "The IP addresses and CIDR blocks in the whitelist.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"SecurityIpList"
]
}
},
"SecurityIpType": {
"Description": "The type of IP address.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"SecurityIpType"
]
}
},
"WhitelistNetType": {
"Description": "The network type of the whitelist.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"WhitelistNetType"
]
}
}
}
}