EndpointConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.globalaccelerator.model.EndpointConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointConfiguration()

Constructors
Constructor and Description
`EndpointConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAttachmentArn()` The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
`Boolean`	`getClientIPPreservationEnabled()` Indicates whether client IP address preservation is enabled for an endpoint.
`String`	`getEndpointId()` An ID for the endpoint.
`Integer`	`getWeight()` The weight associated with the endpoint.
`int`	`hashCode()`
`Boolean`	`isClientIPPreservationEnabled()` Indicates whether client IP address preservation is enabled for an endpoint.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttachmentArn(String attachmentArn)` The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
`void`	`setClientIPPreservationEnabled(Boolean clientIPPreservationEnabled)` Indicates whether client IP address preservation is enabled for an endpoint.
`void`	`setEndpointId(String endpointId)` An ID for the endpoint.
`void`	`setWeight(Integer weight)` The weight associated with the endpoint.
`String`	`toString()` Returns a string representation of this object.
`EndpointConfiguration`	`withAttachmentArn(String attachmentArn)` The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
`EndpointConfiguration`	`withClientIPPreservationEnabled(Boolean clientIPPreservationEnabled)` Indicates whether client IP address preservation is enabled for an endpoint.
`EndpointConfiguration`	`withEndpointId(String endpointId)` An ID for the endpoint.
`EndpointConfiguration`	`withWeight(Integer weight)` The weight associated with the endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointConfiguration
```
public EndpointConfiguration()
```
- Method Detail
  - setEndpointId
```
public void setEndpointId(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. A resource must be valid and active when you add it as an endpoint.
    
    For cross-account endpoints, this must be the ARN of the resource.
    
    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. A resource must be valid and active when you add it as an endpoint.
    
    For cross-account endpoints, this must be the ARN of the resource.
  - getEndpointId
```
public String getEndpointId()
```
    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.
    
    For cross-account endpoints, this must be the ARN of the resource.
    
    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. A resource must be valid and active when you add it as an endpoint.
    
    For cross-account endpoints, this must be the ARN of the resource.
  - withEndpointId
```
public EndpointConfiguration withEndpointId(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. A resource must be valid and active when you add it as an endpoint.
    
    For cross-account endpoints, this must be the ARN of the resource.
    
    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. A resource must be valid and active when you add it as an endpoint.
    
    For cross-account endpoints, this must be the ARN of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWeight
```
public void setWeight(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.
  - getWeight
```
public Integer getWeight()
```
    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.
  - withWeight
```
public EndpointConfiguration withWeight(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.
  - setClientIPPreservationEnabled
```
public void setClientIPPreservationEnabled(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 Balancer 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 Balancer 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.
  - getClientIPPreservationEnabled
```
public Boolean getClientIPPreservationEnabled()
```
    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 Balancer 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 Balancer 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.
  - withClientIPPreservationEnabled
```
public EndpointConfiguration withClientIPPreservationEnabled(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 Balancer 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 Balancer 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.
  - isClientIPPreservationEnabled
```
public Boolean isClientIPPreservationEnabled()
```
    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 Balancer 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 Balancer 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.
  - setAttachmentArn
```
public void setAttachmentArn(String attachmentArn)
```
    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
    
    Parameters:
    
    attachmentArn - The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
  - getAttachmentArn
```
public String getAttachmentArn()
```
    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
  - withAttachmentArn
```
public EndpointConfiguration withAttachmentArn(String attachmentArn)
```
    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
    
    Parameters:
    
    attachmentArn - The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EndpointConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class EndpointConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointConfiguration

Method Detail

setEndpointId

getEndpointId

withEndpointId

setWeight

getWeight

withWeight

setClientIPPreservationEnabled

getClientIPPreservationEnabled

withClientIPPreservationEnabled

isClientIPPreservationEnabled

setAttachmentArn

getAttachmentArn

withAttachmentArn

toString

equals

hashCode

clone

marshall