@Generated(value="software.amazon.awssdk:codegen") public final class LoadBalancer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoadBalancer.Builder,LoadBalancer>
Details on a load balancer that is used with a service.
If the service is using the ECS
deployment controller, you are limited to one load balancer or target
group.
If the service is using the CODE_DEPLOY
deployment controller, the service is required to use either an
Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you
specify two target groups (referred to as a targetGroupPair
). Each target group binds to a separate task
set in the deployment. The load balancer can also have up to two listeners, a required listener for production
traffic and an optional listener that allows you to test new revisions of the service before routing production
traffic to it.
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.
Modifier and Type | Class and Description |
---|---|
static interface |
LoadBalancer.Builder |
Modifier and Type | Method and Description |
---|---|
static LoadBalancer.Builder |
builder() |
String |
containerName()
The name of the container (as it appears in a container definition) to associate with the load balancer.
|
Integer |
containerPort()
The port on the container to associate with the load balancer.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
loadBalancerName()
The name of a load balancer.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends LoadBalancer.Builder> |
serializableBuilderClass() |
String |
targetGroupArn()
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a
service.
|
LoadBalancer.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String targetGroupArn()
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a
service. For services using the ECS
deployment controller, you are limited to one target group. For
services using the CODE_DEPLOY
deployment controller, you are required to define two target groups
for the load balancer.
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.
ECS
deployment controller, you are limited to one target
group. For services using the CODE_DEPLOY
deployment controller, you are required to define
two target groups for the load balancer.
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 loadBalancerName()
The name of a load balancer.
public String containerName()
The name of the container (as it appears in a container definition) to associate with the load balancer.
public 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.
containerPort
in the service's task definition. Your container instances must allow ingress
traffic on the hostPort
of the port mapping.public LoadBalancer.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<LoadBalancer.Builder,LoadBalancer>
public static LoadBalancer.Builder builder()
public static Class<? extends LoadBalancer.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.