aws_globalaccelerator_endpointgroup

account_id

Type: STRING

endpoint_descriptions

Type: UNORDERED_LIST_STRUCT
Provider name: EndpointDescriptions
Description: The list of endpoint objects.

• client_ip_preservation_enabled
  Type: BOOLEAN
  Provider name: ClientIPPreservationEnabled
  Description: Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints. 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 endpoint fronted by the accelerator. Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners. For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
  
• endpoint_id
  Type: STRING
  Provider name: EndpointId
  Description: 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. For Amazon EC2 instances, this is the EC2 instance ID. An Application Load Balancer can be either internal or internet-facing.
  
• health_reason
  Type: STRING
  Provider name: HealthReason
  Description: Returns a null result.
  
• health_state
  Type: STRING
  Provider name: HealthState
  Description: The health status of the endpoint.
  
• weight
  Type: INT32
  Provider name: Weight
  Description: The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.
  

endpoint_group_arn

Type: STRING
Provider name: EndpointGroupArn
Description: The Amazon Resource Name (ARN) of the endpoint group.

endpoint_group_region

Type: STRING
Provider name: EndpointGroupRegion
Description: The Amazon Web Services Region where the endpoint group is located.

health_check_interval_seconds

Type: INT32
Provider name: HealthCheckIntervalSeconds
Description: The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

health_check_path

Type: STRING
Provider name: HealthCheckPath
Description: 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 (/).

health_check_port

Type: INT32
Provider name: HealthCheckPort
Description: 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.

health_check_protocol

Type: STRING
Provider name: HealthCheckProtocol
Description: The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

port_overrides

Type: UNORDERED_LIST_STRUCT
Provider name: PortOverrides
Description: Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

• endpoint_port
  Type: INT32
  Provider name: EndpointPort
  Description: The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
  
• listener_port
  Type: INT32
  Provider name: ListenerPort
  Description: The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
  

tags

Type: UNORDERED_LIST_STRING

threshold_count

Type: INT32
Provider name: ThresholdCount
Description: 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.

traffic_dial_percentage

Type: FLOAT
Provider name: TrafficDialPercentage
Description: 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.