Class: Aws::GlobalAccelerator::Types::EndpointGroup

Inherits:

Struct

• Object
• Struct
• Aws::GlobalAccelerator::Types::EndpointGroup

Defined in:

gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb

Overview

A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #endpoint_descriptions ⇒ Array<Types::EndpointDescription>

  The list of endpoint objects.

• #endpoint_group_arn ⇒ String

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

• #endpoint_group_region ⇒ String

  The Amazon Web Services Region where the endpoint group is located.

• #health_check_interval_seconds ⇒ Integer

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

• #health_check_path ⇒ 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.

• #health_check_port ⇒ Integer

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

• #health_check_protocol ⇒ String

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

• #port_overrides ⇒ Array<Types::PortOverride>

  Allows you to override the destination ports used to route traffic to an endpoint.

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

• #traffic_dial_percentage ⇒ Float

  The percentage of traffic to send to an Amazon Web Services Region.

Instance Attribute Details

#endpoint_descriptions ⇒ Array<Types::EndpointDescription>

The list of endpoint objects.

Returns:

• (Array<Types::EndpointDescription>)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_group_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_group_region ⇒ String

The Amazon Web Services Region where the endpoint group is located.

Returns:

• (String)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_interval_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Integer)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#port_overrides ⇒ Array<Types::PortOverride>

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.

Returns:

• (Array<Types::PortOverride>)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_dial_percentage ⇒ Float

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.

Returns:

• (Float)

# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2167

class EndpointGroup < Struct.new(
  :endpoint_group_arn,
  :endpoint_group_region,
  :endpoint_descriptions,
  :traffic_dial_percentage,
  :health_check_port,
  :health_check_protocol,
  :health_check_path,
  :health_check_interval_seconds,
  :threshold_count,
  :port_overrides)
  SENSITIVE = []
  include Aws::Structure
end