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	endpointId(String endpointId) An ID for the endpoint.
EndpointDescription.Builder	healthReason(String healthReason) The reason code associated with why the endpoint is not healthy.
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

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.

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.

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)

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy, the reason code can be one of the following values:

• Timeout: The health check requests to the endpoint are timing out before returning a status.

• Failed: The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial, the reason code can be one of the following values:

• ProvisioningInProgress: The endpoint is in the process of being provisioned.

• InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

Parameters:

healthReason - The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy, the reason code can be one of the following values:

• Timeout: The health check requests to the endpoint are timing out before returning a status.

• Failed: The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial, the reason code can be one of the following values:

• ProvisioningInProgress: The endpoint is in the process of being provisioned.

• InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

Returns:

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