ALIYUN::GA::EndpointGroup-Resource Orchestration Service(ROS)-阿里云帮助中心

The ALIYUN::GA::EndpointGroup resource creates an endpoint group.

Syntax

{
  "Type": "ALIYUN::GA::EndpointGroup",
  "Properties": {
    "HealthCheckIntervalSeconds": Integer,
    "EndpointGroupRegion": String,
    "TrafficPercentage": Integer,
    "Description": String,
    "HealthCheckPath": String,
    "HealthCheckProtocol": String,
    "ThresholdCount": Integer,
    "HealthCheckPort": Integer,
    "AcceleratorId": String,
    "EndpointConfigurations": List,
    "Name": String,
    "ListenerId": String,
    "HealthCheckEnabled": Boolean,
    "EndpointGroupType": String,
    "EndpointRequestProtocol": String
  }
}

Properties

Property	Type	Required	Update Allowed	Description	Constraints
HealthCheckIntervalSeconds	Integer	No	Yes	The interval between health checks.	Unit: seconds.
EndpointGroupRegion	String	Yes	No	The region where the endpoint group is deployed.	None
TrafficPercentage	Integer	No	Yes	The weight of the endpoint group when the listener is associated with multiple endpoint groups.	None
Description	String	No	Yes	The description of the endpoint group.	None
HealthCheckPath	String	No	Yes	The path for the health check.	None
HealthCheckProtocol	String	No	Yes	The protocol for the health check.	Valid values: tcp: TCP. http: HTTP. https: HTTPS.
ThresholdCount	Integer	No	Yes	The number of consecutive failed health checks that must occur before an endpoint is considered unhealthy.	None
HealthCheckPort	Integer	No	Yes	The port used for the health check.	None
AcceleratorId	String	Yes	No	The ID of the Global Accelerator instance.	None
EndpointConfigurations	List	Yes	Yes	The endpoints.	A maximum of four endpoints can be specified. For more information, see EndpointConfigurations properties.
Name	String	No	Yes	The name of the endpoint group.	None
ListenerId	String	Yes	No	The ID of the listener.	None
HealthCheckEnabled	Boolean	No	Yes	Specifies whether to enable the health check feature.	Valid values: true (default): Enables the health check feature. false: Disables the health check feature.
EndpointGroupType	String	No	No	The type of the endpoint group.	Valid values: default (default): a default endpoint group. virtual: a virtual endpoint group. Note Only listeners that use HTTP or HTTPS support virtual endpoint groups.
EndpointRequestProtocol	String	No	Yes	The protocol of the backend service.	Valid values: HTTP (default) HTTPS Note This parameter is available only when you create an endpoint group for a listener that uses HTTP or HTTPS. For an HTTP listener, the backend service protocol must be HTTP.

EndpointConfigurations syntax

"EndpointConfigurations": [
  {
    "Type": String,
    "Endpoint": String,
    "Weight": Integer,
    "EnableClientIPPreservation": Boolean,
    "EnableProxyProtocol": Boolean
  }
]

EndpointConfigurations properties

Property Name	Type	Required	Update Allowed	Description	Constraints
Type	String	Yes	Yes	The type of the endpoint.	Valid values: Domain: a custom domain name. Ip: a custom IP address.
Endpoint	String	Yes	Yes	The IP address or domain name of the endpoint.	None
Weight	Integer	Yes	Yes	The weight of the endpoint.	None
EnableClientIPPreservation	Boolean	No	Yes	Specifies whether to preserve client source IP addresses.	Valid values: true: Preserves client source IP addresses. false (default): Does not preserve client source IP addresses.
EnableProxyProtocol	Boolean	No	Yes	Specifies whether the TCP Option Address (TOA) module retrieves the IP address of the client that accesses the endpoint.	None

Return values

Fn::GetAtt

EndpointGroupId: The ID of the endpoint group.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AcceleratorId:
    Type: String
    Description: The ID of the Global Accelerator instance with which the endpoint group will be associated.
  ListenerId:
    Type: String
    Description: The ID of the listener to be associated with the endpoint group.
Resources:
  EndpointGroup:
    Type: ALIYUN::GA::EndpointGroup
    Properties:
      EndpointGroupRegion: cn-beijing
      AcceleratorId:
        Ref: AcceleratorId
      EndpointConfigurations:
        - Type: Ip
          Endpoint: 10.10.10.1
          Weight: 100
      Name: TestEndpointGroup
      ListenerId:
        Ref: ListenerId
Outputs:
  EndpointGroupId:
    Description: The ID of the endpoint group.
    Value:
      Fn::GetAtt:
        - EndpointGroup
        - EndpointGroupId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AcceleratorId": {
      "Type": "String",
      "Description": "The ID of the Global Accelerator instance with which the endpoint group will be associated."
    },
    "ListenerId": {
      "Type": "String",
      "Description": "The ID of the listener to be associated with the endpoint group."
    }
  },
  "Resources": {
    "EndpointGroup": {
      "Type": "ALIYUN::GA::EndpointGroup",
      "Properties": {
        "EndpointGroupRegion": "cn-beijing",
        "AcceleratorId": {
          "Ref": "AcceleratorId"
        },
        "EndpointConfigurations": [
          {
            "Type": "Ip",
            "Endpoint": "10.10.10.1",
            "Weight": 100
          }
        ],
        "Name": "TestEndpointGroup",
        "ListenerId": {
          "Ref": "ListenerId"
        }
      }
    }
  },
  "Outputs": {
    "EndpointGroupId": {
      "Description": "The ID of the endpoint group.",
      "Value": {
        "Fn::GetAtt": [
          "EndpointGroup",
          "EndpointGroupId"
        ]
      }
    }
  }
}