Create Endpoint Group

globalaccelerator_create_endpoint_group

R Documentation

Create an endpoint group for the specified listener

Description

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.

For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.

Usage

globalaccelerator_create_endpoint_group(ListenerArn,
  EndpointGroupRegion, EndpointConfigurations, TrafficDialPercentage,
  HealthCheckPort, HealthCheckProtocol, HealthCheckPath,
  HealthCheckIntervalSeconds, ThresholdCount, IdempotencyToken,
  PortOverrides)

Arguments

ListenerArn

[required] The Amazon Resource Name (ARN) of the listener.

EndpointGroupRegion

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

EndpointConfigurations

The list of endpoint objects.

TrafficDialPercentage

The percentage of traffic to send to an Amazon Web Services 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

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

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

HealthCheckPath

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

HealthCheckIntervalSeconds

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

ThresholdCount

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.

IdempotencyToken

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

PortOverrides

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Overriding listener ports in the Global Accelerator Developer Guide.

Value

A list with the following syntax:

list(
  EndpointGroup = list(
    EndpointGroupArn = "string",
    EndpointGroupRegion = "string",
    EndpointDescriptions = list(
      list(
        EndpointId = "string",
        Weight = 123,
        HealthState = "INITIAL"|"HEALTHY"|"UNHEALTHY",
        HealthReason = "string",
        ClientIPPreservationEnabled = TRUE|FALSE
      )
    ),
    TrafficDialPercentage = 123.0,
    HealthCheckPort = 123,
    HealthCheckProtocol = "TCP"|"HTTP"|"HTTPS",
    HealthCheckPath = "string",
    HealthCheckIntervalSeconds = 123,
    ThresholdCount = 123,
    PortOverrides = list(
      list(
        ListenerPort = 123,
        EndpointPort = 123
      )
    )
  )
)

Request syntax

svc$create_endpoint_group(
  ListenerArn = "string",
  EndpointGroupRegion = "string",
  EndpointConfigurations = list(
    list(
      EndpointId = "string",
      Weight = 123,
      ClientIPPreservationEnabled = TRUE|FALSE,
      AttachmentArn = "string"
    )
  ),
  TrafficDialPercentage = 123.0,
  HealthCheckPort = 123,
  HealthCheckProtocol = "TCP"|"HTTP"|"HTTPS",
  HealthCheckPath = "string",
  HealthCheckIntervalSeconds = 123,
  ThresholdCount = 123,
  IdempotencyToken = "string",
  PortOverrides = list(
    list(
      ListenerPort = 123,
      EndpointPort = 123
    )
  )
)