Package 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 Details

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

      Parameters:
      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:
      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

      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:

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.