You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GlobalAccelerator::Types::CreateEndpointGroupRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateEndpointGroupRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  listener_arn: "GenericString", # required
  endpoint_group_region: "GenericString", # required
  endpoint_configurations: [
    {
      endpoint_id: "GenericString",
      weight: 1,
      client_ip_preservation_enabled: false,
    },
  ],
  traffic_dial_percentage: 1.0,
  health_check_port: 1,
  health_check_protocol: "TCP", # accepts TCP, HTTP, HTTPS
  health_check_path: "GenericString",
  health_check_interval_seconds: 1,
  threshold_count: 1,
  idempotency_token: "IdempotencyToken", # required
  port_overrides: [
    {
      listener_port: 1,
      endpoint_port: 1,
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_configurations ⇒ Array<Types::EndpointConfiguration>

The list of endpoint objects.

Returns:

#endpoint_group_region ⇒ String

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

Returns:

  • (String) —

    The AWS Region where the endpoint group is located.

#health_check_interval_seconds ⇒ Integer

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

Returns:

  • (Integer) —

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

#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 (/).

Returns:

  • (String) —

    If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets.

#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.

Returns:

  • (Integer) —

    The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group.

#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

Returns:

  • (String) —

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

#idempotency_token ⇒ String

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

Returns:

  • (String) —

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

#listener_arn ⇒ String

The Amazon Resource Name (ARN) of the listener.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the listener.

#port_overrides ⇒ Array<Types::PortOverride>

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 Port overrides in the AWS Global Accelerator Developer Guide.

Returns:

  • (Array<Types::PortOverride>) —

    Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.

#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.

Returns:

  • (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.

#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.

Returns:

  • (Float) —

    The percentage of traffic to send to an AWS Region.