Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . globalaccelerator ]

create-endpoint-group

Description

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-endpoint-group
--listener-arn <value>
--endpoint-group-region <value>
[--endpoint-configurations <value>]
[--traffic-dial-percentage <value>]
[--health-check-port <value>]
[--health-check-protocol <value>]
[--health-check-path <value>]
[--health-check-interval-seconds <value>]
[--threshold-count <value>]
--idempotency-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--listener-arn (string)

The Amazon Resource Name (ARN) of the listener.

--endpoint-group-region (string)

The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

--endpoint-configurations (list)

The list of endpoint objects.

Shorthand Syntax:

EndpointId=string,Weight=integer,ClientIPPreservationEnabled=boolean ...

JSON Syntax:

[
  {
    "EndpointId": "string",
    "Weight": integer,
    "ClientIPPreservationEnabled": true|false
  }
  ...
]

--traffic-dial-percentage (float)

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

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.

The default value is 100.

--health-check-port (integer)

The port that AWS 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.

--health-check-protocol (string)

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

Possible values:

  • TCP
  • HTTP
  • HTTPS

--health-check-path (string)

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

--health-check-interval-seconds (integer)

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

--threshold-count (integer)

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.

--idempotency-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create an endpoint group

The following create-endpoint-group example creates an endpoint group.

aws globalaccelerator create-endpoint-group \
    --listener-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \
    --endpoint-group-region us-east-1 \
    --endpoint-configurations EndpointId=eipalloc-eip01234567890abc,Weight=128 \
    --region us-west-2 \
    --idempotencytoken dcba4321-dcba-4321-dcba-dcba4321

Output:

{
    "EndpointGroup": {
        "TrafficDialPercentage": 100.0,
        "EndpointDescriptions": [
            {
                "Weight": 128,
                "EndpointId": "eipalloc-eip01234567890abc"
            }
        ],
        "EndpointGroupArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu",
        "EndpointGroupRegion": "us-east-1"
    }
}

For more information, see Endpoint Groups in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

Output

EndpointGroup -> (structure)

The information about the endpoint group that was created.

EndpointGroupArn -> (string)

The Amazon Resource Name (ARN) of the endpoint group.

EndpointGroupRegion -> (string)

The AWS Region that this endpoint group belongs.

EndpointDescriptions -> (list)

The list of endpoint objects.

(structure)

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

EndpointId -> (string)

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.

Weight -> (integer)

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

HealthState -> (string)

The health status of the endpoint.

HealthReason -> (string)

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy , the reason code can be one of the following values:

  • Timeout : The health check requests to the endpoint are timing out before returning a status.
  • Failed : The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial , the reason code can be one of the following values:

  • ProvisioningInProgress : The endpoint is in the process of being provisioned.
  • InitialHealthChecking : Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

ClientIPPreservationEnabled -> (boolean)

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

TrafficDialPercentage -> (float)

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

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.

The default value is 100.

HealthCheckPort -> (integer)

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

HealthCheckProtocol -> (string)

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

HealthCheckPath -> (string)

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

HealthCheckIntervalSeconds -> (integer)

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

ThresholdCount -> (integer)

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.