software.amazon.awscdk.services.ecs

Interface LoadBalancerTargetOptions

All Known Implementing Classes:

LoadBalancerTargetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:05.511Z")
public interface LoadBalancerTargetOptions

Properties for defining an ECS target.

The port mapping for it must already have been created through addPortMapping().

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 Vpc vpc;
 Ec2Service service = Ec2Service.Builder.create(this, "Service").cluster(cluster).taskDefinition(taskDefinition).build();
 LoadBalancer lb = LoadBalancer.Builder.create(this, "LB").vpc(vpc).build();
 lb.addListener(LoadBalancerListener.builder().externalPort(80).build());
 lb.addTarget(service.loadBalancerTarget(LoadBalancerTargetOptions.builder()
         .containerName("MyContainer")
         .containerPort(80)
         .build()));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LoadBalancerTargetOptions.Builder A builder for LoadBalancerTargetOptions
static class	LoadBalancerTargetOptions.Jsii$Proxy An implementation for LoadBalancerTargetOptions

Method Summary

Modifier and Type	Method and Description
static LoadBalancerTargetOptions.Builder	builder()
java.lang.String	getContainerName() The name of the container.
default java.lang.Number	getContainerPort() The port number of the container.
default Protocol	getProtocol() The protocol used for the port mapping.

Method Detail

getContainerName

java.lang.String getContainerName()

The name of the container.

getContainerPort

default java.lang.Number getContainerPort()

The port number of the container.

Only applicable when using application/network load balancers.

Default: - Container port of the first added port mapping.

getProtocol

default Protocol getProtocol()

The protocol used for the port mapping.

Only applicable when using application load balancers.

Default: Protocol.TCP

builder

static LoadBalancerTargetOptions.Builder builder()

Returns:

a LoadBalancerTargetOptions.Builder of LoadBalancerTargetOptions