com.amazonaws.services.globalaccelerator.model.EndpointConfiguration Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.globalaccelerator.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EndpointConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*/
private String endpointId;
/**
*
* 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.
*
*/
private Integer weight;
/**
*
* 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.
*
*/
private Boolean clientIPPreservationEnabled;
/**
*
* 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.
*
*/
private String attachmentArn;
/**
*
* 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.
*
*
* @param 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.
*/
public void setEndpointId(String endpointId) {
this.endpointId = 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.
*
*
* @return 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.
*/
public String getEndpointId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EndpointConfiguration withEndpointId(String endpointId) {
setEndpointId(endpointId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setWeight(Integer weight) {
this.weight = 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.
*
*
* @return 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.
*/
public Integer getWeight() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EndpointConfiguration withWeight(Integer weight) {
setWeight(weight);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setClientIPPreservationEnabled(Boolean clientIPPreservationEnabled) {
this.clientIPPreservationEnabled = 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.
*
*
* @return 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.
*/
public Boolean getClientIPPreservationEnabled() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EndpointConfiguration withClientIPPreservationEnabled(Boolean clientIPPreservationEnabled) {
setClientIPPreservationEnabled(clientIPPreservationEnabled);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isClientIPPreservationEnabled() {
return this.clientIPPreservationEnabled;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setAttachmentArn(String attachmentArn) {
this.attachmentArn = 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.
*
*
* @return 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.
*/
public String getAttachmentArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EndpointConfiguration withAttachmentArn(String attachmentArn) {
setAttachmentArn(attachmentArn);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEndpointId() != null)
sb.append("EndpointId: ").append(getEndpointId()).append(",");
if (getWeight() != null)
sb.append("Weight: ").append(getWeight()).append(",");
if (getClientIPPreservationEnabled() != null)
sb.append("ClientIPPreservationEnabled: ").append(getClientIPPreservationEnabled()).append(",");
if (getAttachmentArn() != null)
sb.append("AttachmentArn: ").append(getAttachmentArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EndpointConfiguration == false)
return false;
EndpointConfiguration other = (EndpointConfiguration) obj;
if (other.getEndpointId() == null ^ this.getEndpointId() == null)
return false;
if (other.getEndpointId() != null && other.getEndpointId().equals(this.getEndpointId()) == false)
return false;
if (other.getWeight() == null ^ this.getWeight() == null)
return false;
if (other.getWeight() != null && other.getWeight().equals(this.getWeight()) == false)
return false;
if (other.getClientIPPreservationEnabled() == null ^ this.getClientIPPreservationEnabled() == null)
return false;
if (other.getClientIPPreservationEnabled() != null && other.getClientIPPreservationEnabled().equals(this.getClientIPPreservationEnabled()) == false)
return false;
if (other.getAttachmentArn() == null ^ this.getAttachmentArn() == null)
return false;
if (other.getAttachmentArn() != null && other.getAttachmentArn().equals(this.getAttachmentArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEndpointId() == null) ? 0 : getEndpointId().hashCode());
hashCode = prime * hashCode + ((getWeight() == null) ? 0 : getWeight().hashCode());
hashCode = prime * hashCode + ((getClientIPPreservationEnabled() == null) ? 0 : getClientIPPreservationEnabled().hashCode());
hashCode = prime * hashCode + ((getAttachmentArn() == null) ? 0 : getAttachmentArn().hashCode());
return hashCode;
}
@Override
public EndpointConfiguration clone() {
try {
return (EndpointConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.globalaccelerator.model.transform.EndpointConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}