software.amazon.awssdk.services.globalaccelerator.model

Interface EndpointDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EndpointDescription.Builder,EndpointDescription>, SdkBuilder<EndpointDescription.Builder,EndpointDescription>, SdkPojo

Enclosing class:

EndpointDescription

public static interface EndpointDescription.Builder
extends SdkPojo, CopyableBuilder<EndpointDescription.Builder,EndpointDescription>

Method Summary

Modifier and Type	Method and Description
EndpointDescription.Builder	clientIPPreservationEnabled(Boolean clientIPPreservationEnabled) Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.
EndpointDescription.Builder	endpointId(String endpointId) An ID for the endpoint.
EndpointDescription.Builder	healthReason(String healthReason) Returns a null result.
EndpointDescription.Builder	healthState(HealthState healthState) The health status of the endpoint.
EndpointDescription.Builder	healthState(String healthState) The health status of the endpoint.
EndpointDescription.Builder	weight(Integer weight) The weight associated with the endpoint.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

endpointId

EndpointDescription.Builder endpointId(String endpointId)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

weight

EndpointDescription.Builder weight(Integer weight)

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 AWS Global Accelerator Developer Guide.

Parameters:

weight - The weight associated with the endpoint. When you add weights to endpoints, you configure AWS 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 AWS Global Accelerator Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthState

EndpointDescription.Builder healthState(String healthState)

The health status of the endpoint.

Parameters:

healthState - The health status of the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HealthState, HealthState

healthState

EndpointDescription.Builder healthState(HealthState healthState)

The health status of the endpoint.

Parameters:

healthState - The health status of the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HealthState, HealthState

healthReason

EndpointDescription.Builder healthReason(String healthReason)

Returns a null result.

Parameters:

healthReason - Returns a null result.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientIPPreservationEnabled

EndpointDescription.Builder clientIPPreservationEnabled(Boolean clientIPPreservationEnabled)

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

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

Parameters:

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

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.