Package software.amazon.awscdk.services.ecs

Interface TrafficShiftConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TrafficShiftConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:10.427Z")
@Stability(Stable)
public interface TrafficShiftConfig
extends software.amazon.jsii.JsiiSerializable

Configuration for traffic shift during progressive deployments.

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	TrafficShiftConfig.Builder	A builder for TrafficShiftConfig
static final class	TrafficShiftConfig.Jsii$Proxy	An implementation for TrafficShiftConfig

Method Summary

Modifier and Type	Method	Description
static TrafficShiftConfig.Builder	builder()
default Duration	getStepBakeTime()	The duration to wait between traffic shifting steps.
default Number	getStepPercent()	The percentage of production traffic to shift in each step.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStepBakeTime

@Stability(Stable)
@Nullable
default Duration getStepBakeTime()

The duration to wait between traffic shifting steps.

Valid values are 0 to 1440 minutes (24 hours).

Default: - Duration.minutes(6) for linear, Duration.minutes(10) for canary

getStepPercent

@Stability(Stable)
@Nullable
default Number getStepPercent()

The percentage of production traffic to shift in each step.

• For linear deployment: multiples of 0.1 from 3.0 to 100.0
• For canary deployment: multiples of 0.1 from 0.1 to 100.0

Default: - 10.0 for linear, 5.0 for canary

builder

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

Returns:

a TrafficShiftConfig.Builder of TrafficShiftConfig