Package software.amazon.awscdk.services.ecs

Interface LoadBalancerTargetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LoadBalancerTargetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-23T11:19:46.417Z")
@Stability(Stable)
public interface LoadBalancerTargetOptions
extends software.amazon.jsii.JsiiSerializable

Properties for defining an ECS target.

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

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 ApplicationTargetGroup blueTargetGroup;
 ApplicationTargetGroup greenTargetGroup;
 ApplicationListenerRule prodListenerRule;
 FargateService service = FargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .deploymentStrategy(DeploymentStrategy.LINEAR)
         .linearConfiguration(TrafficShiftConfig.builder()
                 .stepPercent(10)
                 .stepBakeTime(Duration.minutes(5))
                 .build())
         .build();
 IEcsLoadBalancerTarget target = service.loadBalancerTarget(LoadBalancerTargetOptions.builder()
         .containerName("web")
         .containerPort(80)
         .alternateTarget(AlternateTarget.Builder.create("AlternateTarget")
                 .alternateTargetGroup(greenTargetGroup)
                 .productionListener(ListenerRuleConfiguration.applicationListenerRule(prodListenerRule))
                 .build())
         .build());
 target.attachToApplicationTargetGroup(blueTargetGroup);
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static LoadBalancerTargetOptions.Builder	builder()
default IAlternateTarget	getAlternateTarget()	Alternate target configuration for blue/green deployments.
String	getContainerName()	The name of the container.
default Number	getContainerPort()	The port number of the container.
default Protocol	getProtocol()	The protocol used for the port mapping.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerName

@Stability(Stable)
@NotNull
String getContainerName()

The name of the container.

getAlternateTarget

@Stability(Stable)
@Nullable
default IAlternateTarget getAlternateTarget()

Alternate target configuration for blue/green deployments.

Default: - No alternate target configuration

getContainerPort

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default Protocol getProtocol()

The protocol used for the port mapping.

Only applicable when using application load balancers.

Default: Protocol.TCP

builder

@Stability(Stable)
static LoadBalancerTargetOptions.Builder builder()

Returns:

a LoadBalancerTargetOptions.Builder of LoadBalancerTargetOptions