Package software.amazon.awscdk.services.ecs

Class AlternateTarget

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.AlternateTarget

All Implemented Interfaces:

IAlternateTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:30.751Z")
@Stability(Stable)
public class AlternateTarget
extends software.amazon.jsii.JsiiObject
implements IAlternateTarget

Configuration for alternate target groups used in blue/green deployments with load balancers.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Cluster cluster;
 TaskDefinition taskDefinition;
 Function lambdaHook;
 ApplicationTargetGroup blueTargetGroup;
 ApplicationTargetGroup greenTargetGroup;
 ApplicationListenerRule prodListenerRule;
 FargateService service = FargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .deploymentStrategy(DeploymentStrategy.BLUE_GREEN)
         .build();
 service.addLifecycleHook(DeploymentLifecycleLambdaTarget.Builder.create(lambdaHook, "PreScaleHook")
         .lifecycleStages(List.of(DeploymentLifecycleStage.PRE_SCALE_UP))
         .build());
 IEcsLoadBalancerTarget target = service.loadBalancerTarget(LoadBalancerTargetOptions.builder()
         .containerName("nginx")
         .containerPort(80)
         .protocol(Protocol.TCP)
         .alternateTarget(AlternateTarget.Builder.create("AlternateTarget")
                 .alternateTargetGroup(greenTargetGroup)
                 .productionListener(ListenerRuleConfiguration.applicationListenerRule(prodListenerRule))
                 .build())
         .build());
 target.attachToApplicationTargetGroup(blueTargetGroup);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AlternateTarget.Builder	A fluent builder for AlternateTarget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IAlternateTarget

IAlternateTarget.Jsii$Default, IAlternateTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	AlternateTarget(String id, AlternateTargetProps props)
protected	AlternateTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AlternateTarget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
AlternateTargetConfig	bind(software.constructs.IConstruct scope)	Bind this configuration to a service.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AlternateTarget

protected AlternateTarget(software.amazon.jsii.JsiiObjectRef objRef)

AlternateTarget

protected AlternateTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AlternateTarget

@Stability(Stable)
public AlternateTarget(@NotNull
 String id,
 @NotNull
 AlternateTargetProps props)

Parameters:

id - This parameter is required.

props - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public AlternateTargetConfig bind(@NotNull
 software.constructs.IConstruct scope)

Bind this configuration to a service.

Specified by:

bind in interface IAlternateTarget

Parameters:

scope - This parameter is required.

Returns:

The configuration to apply to the service