Class: Aws::GlobalAccelerator::Types::EndpointConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb

Overview

Note:

When making an API call, you may pass EndpointConfiguration data as a hash:

{
  endpoint_id: "GenericString",
  weight: 1,
  client_ip_preservation_enabled: false,
}

A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_ip_preservation_enabledBoolean

Indicates whether client IP address preservation is enabled for an 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 endpoint fronted by the accelerator.

Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.

For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.

Returns:

  • (Boolean)


2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2030

class EndpointConfiguration < Struct.new(
  :endpoint_id,
  :weight,
  :client_ip_preservation_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_idString

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. A resource must be valid and active when you add it as an endpoint.

An Application Load Balancer can be either internal or internet-facing.

Returns:

  • (String)


2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2030

class EndpointConfiguration < Struct.new(
  :endpoint_id,
  :weight,
  :client_ip_preservation_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#weightInteger

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.

Returns:

  • (Integer)


2030
2031
2032
2033
2034
2035
2036
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/types.rb', line 2030

class EndpointConfiguration < Struct.new(
  :endpoint_id,
  :weight,
  :client_ip_preservation_enabled)
  SENSITIVE = []
  include Aws::Structure
end