com.amazonaws.services.ecs.model.LoadBalancer Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Details on a load balancer that is used with a service.
*
*
* Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type)
* only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also,
* when you create any target groups for these services, you must choose ip as the target type, not
* instance. Tasks that use the awsvpc network mode are associated with an elastic network
* interface, not an Amazon EC2 instance.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class LoadBalancer implements Serializable, Cloneable, StructuredPojo {
/**
*
* The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
*
*
*
* If your service's task definition uses the awsvpc network mode (which is required for the Fargate
* launch type), you must choose ip as the target type, not instance, because tasks that
* use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2
* instance.
*
*
*/
private String targetGroupArn;
/**
*
* The name of a load balancer.
*
*/
private String loadBalancerName;
/**
*
* The name of the container (as it appears in a container definition) to associate with the load balancer.
*
*/
private String containerName;
/**
*
* The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress traffic
* on the hostPort of the port mapping.
*
*/
private Integer containerPort;
/**
*
* The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
*
*
*
* If your service's task definition uses the awsvpc network mode (which is required for the Fargate
* launch type), you must choose ip as the target type, not instance, because tasks that
* use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2
* instance.
*
*
*
* @param targetGroupArn
* The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a
* service.
*
* If your service's task definition uses the awsvpc network mode (which is required for the
* Fargate launch type), you must choose ip as the target type, not instance,
* because tasks that use the awsvpc network mode are associated with an elastic network
* interface, not an Amazon EC2 instance.
*
*/
public void setTargetGroupArn(String targetGroupArn) {
this.targetGroupArn = targetGroupArn;
}
/**
*
* The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
*
*
*
* If your service's task definition uses the awsvpc network mode (which is required for the Fargate
* launch type), you must choose ip as the target type, not instance, because tasks that
* use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2
* instance.
*
*
*
* @return The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a
* service.
*
* If your service's task definition uses the awsvpc network mode (which is required for the
* Fargate launch type), you must choose ip as the target type, not instance,
* because tasks that use the awsvpc network mode are associated with an elastic network
* interface, not an Amazon EC2 instance.
*
*/
public String getTargetGroupArn() {
return this.targetGroupArn;
}
/**
*
* The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
*
*
*
* If your service's task definition uses the awsvpc network mode (which is required for the Fargate
* launch type), you must choose ip as the target type, not instance, because tasks that
* use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2
* instance.
*
*
*
* @param targetGroupArn
* The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a
* service.
*
* If your service's task definition uses the awsvpc network mode (which is required for the
* Fargate launch type), you must choose ip as the target type, not instance,
* because tasks that use the awsvpc network mode are associated with an elastic network
* interface, not an Amazon EC2 instance.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoadBalancer withTargetGroupArn(String targetGroupArn) {
setTargetGroupArn(targetGroupArn);
return this;
}
/**
*
* The name of a load balancer.
*
*
* @param loadBalancerName
* The name of a load balancer.
*/
public void setLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
}
/**
*
* The name of a load balancer.
*
*
* @return The name of a load balancer.
*/
public String getLoadBalancerName() {
return this.loadBalancerName;
}
/**
*
* The name of a load balancer.
*
*
* @param loadBalancerName
* The name of a load balancer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoadBalancer withLoadBalancerName(String loadBalancerName) {
setLoadBalancerName(loadBalancerName);
return this;
}
/**
*
* The name of the container (as it appears in a container definition) to associate with the load balancer.
*
*
* @param containerName
* The name of the container (as it appears in a container definition) to associate with the load balancer.
*/
public void setContainerName(String containerName) {
this.containerName = containerName;
}
/**
*
* The name of the container (as it appears in a container definition) to associate with the load balancer.
*
*
* @return The name of the container (as it appears in a container definition) to associate with the load balancer.
*/
public String getContainerName() {
return this.containerName;
}
/**
*
* The name of the container (as it appears in a container definition) to associate with the load balancer.
*
*
* @param containerName
* The name of the container (as it appears in a container definition) to associate with the load balancer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoadBalancer withContainerName(String containerName) {
setContainerName(containerName);
return this;
}
/**
*
* The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress traffic
* on the hostPort of the port mapping.
*
*
* @param containerPort
* The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress
* traffic on the hostPort of the port mapping.
*/
public void setContainerPort(Integer containerPort) {
this.containerPort = containerPort;
}
/**
*
* The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress traffic
* on the hostPort of the port mapping.
*
*
* @return The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress
* traffic on the hostPort of the port mapping.
*/
public Integer getContainerPort() {
return this.containerPort;
}
/**
*
* The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress traffic
* on the hostPort of the port mapping.
*
*
* @param containerPort
* The port on the container to associate with the load balancer. This port must correspond to a
* containerPort in the service's task definition. Your container instances must allow ingress
* traffic on the hostPort of the port mapping.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LoadBalancer withContainerPort(Integer containerPort) {
setContainerPort(containerPort);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTargetGroupArn() != null)
sb.append("TargetGroupArn: ").append(getTargetGroupArn()).append(",");
if (getLoadBalancerName() != null)
sb.append("LoadBalancerName: ").append(getLoadBalancerName()).append(",");
if (getContainerName() != null)
sb.append("ContainerName: ").append(getContainerName()).append(",");
if (getContainerPort() != null)
sb.append("ContainerPort: ").append(getContainerPort());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof LoadBalancer == false)
return false;
LoadBalancer other = (LoadBalancer) obj;
if (other.getTargetGroupArn() == null ^ this.getTargetGroupArn() == null)
return false;
if (other.getTargetGroupArn() != null && other.getTargetGroupArn().equals(this.getTargetGroupArn()) == false)
return false;
if (other.getLoadBalancerName() == null ^ this.getLoadBalancerName() == null)
return false;
if (other.getLoadBalancerName() != null && other.getLoadBalancerName().equals(this.getLoadBalancerName()) == false)
return false;
if (other.getContainerName() == null ^ this.getContainerName() == null)
return false;
if (other.getContainerName() != null && other.getContainerName().equals(this.getContainerName()) == false)
return false;
if (other.getContainerPort() == null ^ this.getContainerPort() == null)
return false;
if (other.getContainerPort() != null && other.getContainerPort().equals(this.getContainerPort()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTargetGroupArn() == null) ? 0 : getTargetGroupArn().hashCode());
hashCode = prime * hashCode + ((getLoadBalancerName() == null) ? 0 : getLoadBalancerName().hashCode());
hashCode = prime * hashCode + ((getContainerName() == null) ? 0 : getContainerName().hashCode());
hashCode = prime * hashCode + ((getContainerPort() == null) ? 0 : getContainerPort().hashCode());
return hashCode;
}
@Override
public LoadBalancer clone() {
try {
return (LoadBalancer) 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.ecs.model.transform.LoadBalancerMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}