LoadBalancer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.LoadBalancer

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LoadBalancer
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LoadBalancer()

Constructors
Constructor and Description
`LoadBalancer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoadBalancer`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getContainerName()` The name of the container (as it appears in a container definition) to associate with the load balancer.
`Integer`	`getContainerPort()` The port on the container to associate with the load balancer.
`String`	`getLoadBalancerName()` The name of a load balancer.
`String`	`getTargetGroupArn()` The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerName(String containerName)` The name of the container (as it appears in a container definition) to associate with the load balancer.
`void`	`setContainerPort(Integer containerPort)` The port on the container to associate with the load balancer.
`void`	`setLoadBalancerName(String loadBalancerName)` The name of a load balancer.
`void`	`setTargetGroupArn(String targetGroupArn)` The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`LoadBalancer`	`withContainerName(String containerName)` The name of the container (as it appears in a container definition) to associate with the load balancer.
`LoadBalancer`	`withContainerPort(Integer containerPort)` The port on the container to associate with the load balancer.
`LoadBalancer`	`withLoadBalancerName(String loadBalancerName)` The name of a load balancer.
`LoadBalancer`	`withTargetGroupArn(String targetGroupArn)` The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.

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

- Constructor Detail
  - LoadBalancer
```
public LoadBalancer()
```
- Method Detail
  - setTargetGroupArn
```
public void setTargetGroupArn(String 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.
    
    Parameters:
    
    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.
  - getTargetGroupArn
```
public String getTargetGroupArn()
```
    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.
    
    Returns:
    
    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.
  - withTargetGroupArn
```
public LoadBalancer withTargetGroupArn(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoadBalancerName
```
public void setLoadBalancerName(String loadBalancerName)
```
    The name of a load balancer.
    
    Parameters:
    
    loadBalancerName - The name of a load balancer.
  - getLoadBalancerName
```
public String getLoadBalancerName()
```
    The name of a load balancer.
    
    Returns:
    
    The name of a load balancer.
  - withLoadBalancerName
```
public LoadBalancer withLoadBalancerName(String loadBalancerName)
```
    The name of a load balancer.
    
    Parameters:
    
    loadBalancerName - The name of a load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerName
```
public void setContainerName(String containerName)
```
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    
    Parameters:
    
    containerName - The name of the container (as it appears in a container definition) to associate with the load balancer.
  - getContainerName
```
public String getContainerName()
```
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    
    Returns:
    
    The name of the container (as it appears in a container definition) to associate with the load balancer.
  - withContainerName
```
public LoadBalancer withContainerName(String containerName)
```
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    
    Parameters:
    
    containerName - The name of the container (as it appears in a container definition) to associate with the load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerPort
```
public void setContainerPort(Integer 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.
    
    Parameters:
    
    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.
  - getContainerPort
```
public Integer getContainerPort()
```
    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.
    
    Returns:
    
    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.
  - withContainerPort
```
public LoadBalancer withContainerPort(Integer 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.
    
    Parameters:
    
    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.
    
    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; useful for testing and debugging.
    
    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 LoadBalancer 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.

Did this page help you?

Class LoadBalancer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LoadBalancer

Method Detail

setTargetGroupArn

getTargetGroupArn

withTargetGroupArn

setLoadBalancerName

getLoadBalancerName

withLoadBalancerName

setContainerName

getContainerName

withContainerName

setContainerPort

getContainerPort

withContainerPort

toString

equals

hashCode

clone

marshall