Class EndpointDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EndpointDescription.Builder,
EndpointDescription>
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EndpointDescription.Builder
builder()
final Boolean
Indicates whether client IP address preservation is enabled for an endpoint.final String
An ID for the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
Returns a null result.final HealthState
The health status of the endpoint.final String
The health status of the endpoint.static Class
<? extends EndpointDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
weight()
The weight associated with the endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
weight
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:
- 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.
-
healthState
The health status of the endpoint.
If the service returns an enum value that is not available in the current SDK version,
healthState
will returnHealthState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthStateAsString()
.- Returns:
- The health status of the endpoint.
- See Also:
-
healthStateAsString
The health status of the endpoint.
If the service returns an enum value that is not available in the current SDK version,
healthState
will returnHealthState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthStateAsString()
.- Returns:
- The health status of the endpoint.
- See Also:
-
healthReason
Returns a null result.
- Returns:
- Returns a null result.
-
clientIPPreservationEnabled
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
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, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
- Returns:
- Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.
The default value is true for Application Load Balancers endpoints.
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, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EndpointDescription.Builder,
EndpointDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-