Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1449191193.1 KB

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.

post/#X-Amz-Target=GlobalAccelerator_V20180706.CreateEndpointGroup

Headers

X-Amz-Target'GlobalAccelerator_V20180706.CreateEndpointGroup' required

Request body

ListenerArnstring required

The Amazon Resource Name (ARN) of the listener.

EndpointGroupRegionstring required

The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

TrafficDialPercentagenumber float
<p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>
HealthCheckPortinteger

The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

HealthCheckProtocol'TCP' | 'HTTP' | 'HTTPS'

The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

HealthCheckPathstring

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

HealthCheckIntervalSecondsinteger

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

ThresholdCountinteger

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

IdempotencyTokenstring required

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

Response

Success