O tipo de recurso ALIYUN::CLOUDFW::AddressBook cria catálogos de endereços para controle de acesso de segurança, incluindo catálogos de endereços IP, catálogos baseados em tags do ECS, catálogos de portas e catálogos de nomes de domínio.
Sintaxe
{
"Type": "ALIYUN::CLOUDFW::AddressBook",
"Properties": {
"GroupType": String,
"AutoAddTagEcs": Boolean,
"Description": String,
"TagRelation": String,
"RegionId": String,
"GroupName": String,
"AddressList": String,
"AckLabels": List,
"AckClusterConnectorId": String,
"AckNamespaces": List,
"TagList": List
}
}
Propriedades
Nome da propriedade | Tipo | Obrigatório | Atualizável | Descrição | Restrições |
Description | String | Sim | Sim | Descrição do catálogo de endereços. | Nenhuma. |
GroupName | String | Sim | Não | Nome do catálogo de endereços. | Nenhuma. |
GroupType | String | Sim | Não | Tipo do catálogo de endereços. | Valores válidos:
|
AddressList | String | Não | Sim | Lista de endereços do catálogo. Separe vários endereços com vírgulas. Nota Defina este parâmetro quando GroupType for IP, port ou domain. |
|
AckLabels | List | Não | Não | Lista de rótulos de grupos de contêineres do cluster ACK. | Máximo de 10. Para mais informações, consulte Propriedades de AckLabels. |
AckClusterConnectorId | String | Não | Não | ID do conector de cluster ACK. | Nenhuma. |
AckNamespaces | List | Não | Não | Lista de namespaces de grupos de contêineres do cluster ACK. | Máximo de 10. |
AutoAddTagEcs | Boolean | Não | Sim | Adiciona automaticamente ao catálogo os endereços IP públicos de instâncias do Elastic Compute Service (ECS) correspondentes a novas tags. | Valores válidos:
|
RegionId | String | Não | Não | Região. Valor padrão: cn-hangzhou. | Valores válidos:
|
TagList | List | Não | Sim | Tags do ECS para correspondência. | Nenhuma. |
TagRelation | String | Não | Sim | Relação entre múltiplas tags do ECS para correspondência. | Valores válidos:
|
Sintaxe de AckLabels
"AckLabels": [
{
"Key": String,
"Value": String
}
]
Propriedades de AckLabels
|
Nome da propriedade |
Tipo |
Obrigatório |
Atualizável |
Descrição |
Restrições |
|
Key |
String |
Não |
Não |
Chave do rótulo de grupo de contêineres do cluster ACK. |
Nenhuma. |
|
Value |
String |
Não |
Não |
Valor do rótulo de grupo de contêineres do cluster ACK. |
Nenhuma. |
Sintaxe de TagList
"TagList": [
{
"TagKey": String,
"TagValue": String
}
]
Propriedades de TagList
|
Nome da propriedade |
Tipo |
Obrigatório |
Atualizável |
Descrição |
Restrições |
|
TagKey |
String |
Não |
Sim |
Chave da tag do ECS para correspondência. |
Nenhuma. |
|
TagValue |
String |
Não |
Sim |
Valor da tag do ECS para correspondência. |
Nenhuma. |
Valor de retorno
Fn::GetAtt
GroupUuid: ID exclusivo do catálogo de endereços. O sistema retorna este ID após a criação bem-sucedida do catálogo.
Exemplo
ROSTemplateFormatVersion: '2015-09-01'
Resources:
AddressBook:
Type: ALIYUN::CLOUDFW::AddressBook
Properties:
GroupType:
Ref: GroupType
AutoAddTagEcs:
Ref: AutoAddTagEcs
Description:
Ref: Description
TagRelation:
Ref: TagRelation
RegionId:
Ref: RegionId
GroupName:
Ref: GroupName
AddressList:
Ref: AddressList
TagList:
Ref: TagList
Parameters:
GroupType:
Type: String
Description: 'The type of the address book. Valid values: ip: IP address book. domain: domain name address book. port: port address book. tag: ECS tag-based address book.'
AllowedValues:
- domain
- ip
- port
- tag
AutoAddTagEcs:
Default: false
Type: Boolean
Description: Automatically add public IP addresses of Elastic Compute Service (ECS) instances that match new tags to the address book. Defaults to false.
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description:
MinLength: 1
Type: String
Description: The description of the address book.
TagRelation:
Type: String
Description: 'The relationship between multiple ECS tags to match. Valid values: and: Multiple tags have an "AND" relationship. Only public IP addresses of ECS instances that match all specified tags are added to the address book. or: Multiple tags have an "OR" relationship. Public IP addresses of ECS instances that match any specified tag are added to the address book.'
AllowedValues:
- and
- or
RegionId:
Default: cn-hangzhou
Type: String
Description: The region. Default value: cn-hangzhou.
AllowedValues:
- cn-hangzhou
- ap-southeast-1
GroupName:
Type: String
Description: The name of the address book.
AddressList:
Type: String
Description: |-
The address list of the address book. Separate multiple addresses with commas.
Note: Set this parameter when GroupType is IP, port, or domain.
If GroupType is IP, enter IP addresses in the address list. For example: 10.10.XX.XX/32, 10.10.XX.XX/24.
If GroupType is port, enter ports or port ranges in the address list. For example: 80, 100/200.
If GroupType is domain, enter domain names in the address list. For example: demo1.aliyun.com, demo2.aliyun.com.
TagList:
Type: Json
Description: ''
MaxLength: 100
Outputs:
GroupUuid:
Description: The unique ID of the address book returned after successful addition.
Value:
Fn::GetAtt:
- AddressBook
- GroupUuid
{
"ROSTemplateFormatVersion": "2015-09-01",
"Resources": {
"AddressBook": {
"Type": "ALIYUN::CLOUDFW::AddressBook",
"Properties": {
"GroupType": {
"Ref": "GroupType"
},
"AutoAddTagEcs": {
"Ref": "AutoAddTagEcs"
},
"Description": {
"Ref": "Description"
},
"TagRelation": {
"Ref": "TagRelation"
},
"RegionId": {
"Ref": "RegionId"
},
"GroupName": {
"Ref": "GroupName"
},
"AddressList": {
"Ref": "AddressList"
},
"TagList": {
"Ref": "TagList"
}
}
}
},
"Parameters": {
"GroupType": {
"Type": "String",
"Description": "The type of the address book. Valid values: ip: IP address book. domain: domain name address book. port: port address book. tag: ECS tag-based address book.",
"AllowedValues": [
"domain",
"ip",
"port",
"tag"
]
},
"AutoAddTagEcs": {
"Default": false,
"Type": "Boolean",
"Description": "Automatically add public IP addresses of Elastic Compute Service (ECS) instances that match new tags to the address book. Defaults to false.",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"Description": {
"MinLength": 1,
"Type": "String",
"Description": "The description of the address book."
},
"TagRelation": {
"Type": "String",
"Description": "The relationship between multiple ECS tags to match. Valid values: and: Multiple tags have an \"AND\" relationship. Only public IP addresses of ECS instances that match all specified tags are added to the address book. or: Multiple tags have an \"OR\" relationship. Public IP addresses of ECS instances that match any specified tag are added to the address book.",
"AllowedValues": [
"and",
"or"
]
},
"RegionId": {
"Default": "cn-hangzhou",
"Type": "String",
"Description": "The region. Default value: cn-hangzhou.",
"AllowedValues": [
"cn-hangzhou",
"ap-southeast-1"
]
},
"GroupName": {
"Type": "String",
"Description": "The name of the address book."
},
"AddressList": {
"Type": "String",
"Description": "The address list of the address book. Separate multiple addresses with commas.\nNote: Set this parameter when GroupType is IP, port, or domain.\nIf GroupType is IP, enter IP addresses in the address list. For example: 10.10.XX.XX/32, 10.10.XX.XX/24.\nIf GroupType is port, enter ports or port ranges in the address list. For example: 80, 100/200.\nIf GroupType is domain, enter domain names in the address list. For example: demo1.aliyun.com, demo2.aliyun.com."
},
"TagList": {
"Type": "Json",
"Description": "",
"MaxLength": 100
}
},
"Outputs": {
"GroupUuid": {
"Description": "The unique ID of the address book returned after successful addition.",
"Value": {
"Fn::GetAtt": [
"AddressBook",
"GroupUuid"
]
}
}
}
}