ALIYUN::DNS::AddressPool - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::DNS::AddressPool",
  "Properties": {
    "Addr": List,
    "InstanceId": String,
    "LbaStrategy": String,
    "Name": String,
    "Type": String,
    "EvaluationCount": Integer,
    "IspCityNode": List,
    "Interval": Integer,
    "MonitorExtendInfo": Map,
    "MonitorStatus": String,
    "ProtocolType": String,
    "Timeout": Integer
  }
}

Properties

Parameter	Type	Required	Update allowed	Description	Constraints
Addr	List	Yes	Yes	The addresses in the address pool.	Length: 1 to 50. For more information, see Addr Properties.
InstanceId	String	Yes	No	The GTM instance ID.	None
LbaStrategy	String	Yes	Yes	The load balancing strategy.	Valid values: `ALL_RR`: Returns all addresses. `RATIO`: Returns addresses by weight.
Name	String	Yes	Yes	The name of the address pool.	None
Type	String	Yes	No	The type of the address pool.	Valid values: `IPV4`: IPv4 address. `IPV6`: IPv6 address. `DOMAIN`: domain name.
EvaluationCount	Integer	No	No	The number of consecutive failed health checks before an address is considered unhealthy.	Range: 1 to 9,999,999.
Interval	Integer	No	No	The health check interval.	Unit: seconds. Range: 1 to 9,999,999.
IspCityNode	List	No	No	The ISP city nodes.	Length: 1 to 20. For more information, see IspCityNode Properties.
MonitorExtendInfo	Map	No	No	The extended information for the health check.	None
MonitorStatus	String	No	No	The monitoring status of the address pool.	Valid values: `OPEN`: Enabled. `CLOSE`: Disabled. `UNCONFIGURED`: Not configured.
ProtocolType	String	No	No	The protocol used for health checks.	Valid values: `HTTP` `HTTPS` `PING` `TCP`
Timeout	Integer	No	No	The health check timeout.	Unit: seconds. Range: 1 to 9,999,999.

IspCityNode Syntax

"IspCityNode": [
  {
    "CityCode": String,
    "IspCode": String
  }
]

IspCityNode Properties

Parameter	Type	Required	Update allowed	Description	Constraints
CityCode	String	No	No	The city code.	None
IspCode	String	No	No	The ISP code.	None

Addr Syntax

"Addr": [
  {
    "AttributeInfo": Map,
    "LbaWeight": Integer,
    "Mode": String,
    "Addr": String,
    "Remark": String
  }
]

Addr Properties

Parameter	Type	Required	Update allowed	Description	Constraints
Addr	String	Yes	No	The address value.	None
AttributeInfo	Map	Yes	No	The attributes of the address.	None
Mode	String	Yes	No	The mode of the address.	Valid values: `SMART`: Smart return. `ONLINE`: Always online. `OFFLINE`: Always offline.
LbaWeight	Integer	No	No	The weight of the address.	None
Remark	String	No	No	The remark for the address.	None

Return values

Fn::GetAtt

AddrPoolId: The ID of the address pool.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Type:
    Type: String
    Description:
      en: 'The type of the address pool. Valid values: IPV4, IPV6, and DOMAIN.'
      zh: 地址池的类型。取值范围：Ipv4、Ipv6、Domain。
    AllowedValues:
      - IPV4
      - IPV6
      - DOMAIN
    Required: true
  LbaStrategy:
    Type: String
    Description:
      en: 'The load balancing strategy. Valid values: ALL_RR and RATIO.'
      zh: 负载均衡策略。取值范围：RoundRobin、Weighted、FallbackToFirst。
    AllowedValues:
      - ALL_RR
      - RATIO
    Required: true
  InstanceId:
    Type: String
    Description:
      en: The ID of the GTM instance.
      zh: GTM实例的ID。
    Required: true
  Addr:
    AssociationPropertyMetadata:
      Parameter:
        AssociationPropertyMetadata:
          Parameters:
            AttributeInfo:
              Type: Json
              Description:
                en: The attributes of the address.
                zh: 地址的属性信息。
              Required: true
            LbaWeight:
              Type: Number
              Description:
                en: The weight of the address.
                zh: 地址的权重。
              Required: false
            Mode:
              Type: String
              Description:
                en: 'The mode of the address. Valid values: SMART, ONLINE, and OFFLINE.'
                zh: 地址的模式。取值范围：Normal、Maintenance。
              AllowedValues:
                - SMART
                - ONLINE
                - OFFLINE
              Required: true
            Addr:
              Type: String
              Description:
                en: The address value.
                zh: 地址值。
              Required: true
            Remark:
              Type: String
              Description:
                en: The remark for the address.
                zh: 地址的备注。
              Required: false
        Type: Json
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: The list of addresses in the address pool.
      zh: 地址池中的地址列表。
    Required: true
    MinLength: 1
    MaxLength: 50
  Name:
    Type: String
    Description:
      en: The name of the address pool.
      zh: 地址池的名称。
    Required: true
Resources:
  AddressPool:
    Type: ALIYUN::DNS::AddressPool
    Properties:
      Type:
        Ref: Type
      LbaStrategy:
        Ref: LbaStrategy
      InstanceId:
        Ref: InstanceId
      Addr:
        Ref: Addr
      Name:
        Ref: Name
Outputs:
  AddrPoolId:
    Description:
      en: The ID of the address pool.
      zh: 地址池的ID。
    Value:
      Fn::GetAtt:
        - AddressPool
        - AddrPoolId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Type": {
      "Type": "String",
      "Description": {
        "en": "The type of the address pool. Valid values: IPV4, IPV6, and DOMAIN.",
        "zh": "地址池的类型。取值范围：Ipv4、Ipv6、Domain。"
      },
      "AllowedValues": [
        "IPV4",
        "IPV6",
        "DOMAIN"
      ],
      "Required": true
    },
    "LbaStrategy": {
      "Type": "String",
      "Description": {
        "en": "The load balancing strategy. Valid values: ALL_RR and RATIO.",
        "zh": "负载均衡策略。取值范围：RoundRobin、Weighted、FallbackToFirst。"
      },
      "AllowedValues": [
        "ALL_RR",
        "RATIO"
      ],
      "Required": true
    },
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the GTM instance.",
        "zh": "GTM实例的ID。"
      },
      "Required": true
    },
    "Addr": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "AttributeInfo": {
                "Type": "Json",
                "Description": {
                  "en": "The attributes of the address.",
                  "zh": "地址的属性信息。"
                },
                "Required": true
              },
              "LbaWeight": {
                "Type": "Number",
                "Description": {
                  "en": "The weight of the address.",
                  "zh": "地址的权重。"
                },
                "Required": false
              },
              "Mode": {
                "Type": "String",
                "Description": {
                  "en": "The mode of the address. Valid values: SMART, ONLINE, and OFFLINE.",
                  "zh": "地址的模式。取值范围：Normal、Maintenance。"
                },
                "AllowedValues": [
                  "SMART",
                  "ONLINE",
                  "OFFLINE"
                ],
                "Required": true
              },
              "Addr": {
                "Type": "String",
                "Description": {
                  "en": "The address value.",
                  "zh": "地址值。"
                },
                "Required": true
              },
              "Remark": {
                "Type": "String",
                "Description": {
                  "en": "The remark for the address.",
                  "zh": "地址的备注。"
                },
                "Required": false
              }
            }
          },
          "Type": "Json",
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "The list of addresses in the address pool.",
        "zh": "地址池中的地址列表。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 50
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the address pool.",
        "zh": "地址池的名称。"
      },
      "Required": true
    }
  },
  "Resources": {
    "AddressPool": {
      "Type": "ALIYUN::DNS::AddressPool",
      "Properties": {
        "Type": {
          "Ref": "Type"
        },
        "LbaStrategy": {
          "Ref": "LbaStrategy"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "Addr": {
          "Ref": "Addr"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "AddrPoolId": {
      "Description": {
        "en": "The ID of the address pool.",
        "zh": "地址池的ID。"
      },
      "Value": {
        "Fn::GetAtt": [
          "AddressPool",
          "AddrPoolId"
        ]
      }
    }
  }
}