software.amazon.awssdk.services.globalaccelerator.model.EndpointConfiguration Maven / Gradle / Ivy
Show all versions of globalaccelerator Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.globalaccelerator.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EndpointConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ENDPOINT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointId").getter(getter(EndpointConfiguration::endpointId)).setter(setter(Builder::endpointId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointId").build()).build();
private static final SdkField WEIGHT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("Weight").getter(getter(EndpointConfiguration::weight)).setter(setter(Builder::weight))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Weight").build()).build();
private static final SdkField CLIENT_IP_PRESERVATION_ENABLED_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("ClientIPPreservationEnabled")
.getter(getter(EndpointConfiguration::clientIPPreservationEnabled))
.setter(setter(Builder::clientIPPreservationEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientIPPreservationEnabled")
.build()).build();
private static final SdkField ATTACHMENT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AttachmentArn").getter(getter(EndpointConfiguration::attachmentArn))
.setter(setter(Builder::attachmentArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttachmentArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENDPOINT_ID_FIELD,
WEIGHT_FIELD, CLIENT_IP_PRESERVATION_ENABLED_FIELD, ATTACHMENT_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String endpointId;
private final Integer weight;
private final Boolean clientIPPreservationEnabled;
private final String attachmentArn;
private EndpointConfiguration(BuilderImpl builder) {
this.endpointId = builder.endpointId;
this.weight = builder.weight;
this.clientIPPreservationEnabled = builder.clientIPPreservationEnabled;
this.attachmentArn = builder.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.
*
*
* @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 final String endpointId() {
return 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.
*
*
* @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 final Integer weight() {
return 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.
*
*
* @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 final Boolean clientIPPreservationEnabled() {
return 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.
*
*
* @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 final String attachmentArn() {
return attachmentArn;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(endpointId());
hashCode = 31 * hashCode + Objects.hashCode(weight());
hashCode = 31 * hashCode + Objects.hashCode(clientIPPreservationEnabled());
hashCode = 31 * hashCode + Objects.hashCode(attachmentArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EndpointConfiguration)) {
return false;
}
EndpointConfiguration other = (EndpointConfiguration) obj;
return Objects.equals(endpointId(), other.endpointId()) && Objects.equals(weight(), other.weight())
&& Objects.equals(clientIPPreservationEnabled(), other.clientIPPreservationEnabled())
&& Objects.equals(attachmentArn(), other.attachmentArn());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("EndpointConfiguration").add("EndpointId", endpointId()).add("Weight", weight())
.add("ClientIPPreservationEnabled", clientIPPreservationEnabled()).add("AttachmentArn", attachmentArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EndpointId":
return Optional.ofNullable(clazz.cast(endpointId()));
case "Weight":
return Optional.ofNullable(clazz.cast(weight()));
case "ClientIPPreservationEnabled":
return Optional.ofNullable(clazz.cast(clientIPPreservationEnabled()));
case "AttachmentArn":
return Optional.ofNullable(clazz.cast(attachmentArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EndpointConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder endpointId(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.
*
*
* @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.
*/
Builder weight(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.
*
*
* @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.
*/
Builder clientIPPreservationEnabled(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.
*
*
* @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.
*/
Builder attachmentArn(String attachmentArn);
}
static final class BuilderImpl implements Builder {
private String endpointId;
private Integer weight;
private Boolean clientIPPreservationEnabled;
private String attachmentArn;
private BuilderImpl() {
}
private BuilderImpl(EndpointConfiguration model) {
endpointId(model.endpointId);
weight(model.weight);
clientIPPreservationEnabled(model.clientIPPreservationEnabled);
attachmentArn(model.attachmentArn);
}
public final String getEndpointId() {
return endpointId;
}
public final void setEndpointId(String endpointId) {
this.endpointId = endpointId;
}
@Override
public final Builder endpointId(String endpointId) {
this.endpointId = endpointId;
return this;
}
public final Integer getWeight() {
return weight;
}
public final void setWeight(Integer weight) {
this.weight = weight;
}
@Override
public final Builder weight(Integer weight) {
this.weight = weight;
return this;
}
public final Boolean getClientIPPreservationEnabled() {
return clientIPPreservationEnabled;
}
public final void setClientIPPreservationEnabled(Boolean clientIPPreservationEnabled) {
this.clientIPPreservationEnabled = clientIPPreservationEnabled;
}
@Override
public final Builder clientIPPreservationEnabled(Boolean clientIPPreservationEnabled) {
this.clientIPPreservationEnabled = clientIPPreservationEnabled;
return this;
}
public final String getAttachmentArn() {
return attachmentArn;
}
public final void setAttachmentArn(String attachmentArn) {
this.attachmentArn = attachmentArn;
}
@Override
public final Builder attachmentArn(String attachmentArn) {
this.attachmentArn = attachmentArn;
return this;
}
@Override
public EndpointConfiguration build() {
return new EndpointConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}