AWS CDK Reference

Appearance

v2.274.0

DeploymentLifecycleStage Enum ​

Deployment lifecycle stages where hooks can be executed.

Source
aws-ecs/lib/deployment-lifecycle-hook-target.ts
Type last changed
v2.211.0 · 13 Aug 2025

Example ​

ts
import * as lambda from 'aws-cdk-lib/aws-lambda';

declare const cluster: ecs.Cluster;
declare const taskDefinition: ecs.TaskDefinition;
declare const lambdaHook: lambda.Function;
declare const blueTargetGroup: elbv2.ApplicationTargetGroup;
declare const greenTargetGroup: elbv2.ApplicationTargetGroup;
declare const prodListenerRule: elbv2.ApplicationListenerRule;

const service = new ecs.FargateService(this, 'Service', {
  cluster,
  taskDefinition,
  deploymentStrategy: ecs.DeploymentStrategy.BLUE_GREEN,
});

service.addLifecycleHook(new ecs.DeploymentLifecycleLambdaTarget(lambdaHook, 'PreScaleHook', {
  lifecycleStages: [ecs.DeploymentLifecycleStage.PRE_SCALE_UP],
}));

const target = service.loadBalancerTarget({
  containerName: 'nginx',
  containerPort: 80,
  protocol: ecs.Protocol.TCP,
  alternateTarget: new ecs.AlternateTarget('AlternateTarget', {
    alternateTargetGroup: greenTargetGroup,
    productionListener: ecs.ListenerRuleConfiguration.applicationListenerRule(prodListenerRule),
  }),
});

target.attachToApplicationTargetGroup(blueTargetGroup);

Members ​

MemberDescription
RECONCILE_SERVICEExecute during service reconciliation.
PRE_SCALE_UPExecute before scaling up tasks.
POST_SCALE_UPExecute after scaling up tasks.
TEST_TRAFFIC_SHIFTExecute during test traffic shift.
POST_TEST_TRAFFIC_SHIFTExecute after test traffic shift.
PRODUCTION_TRAFFIC_SHIFTExecute during production traffic shift.
POST_PRODUCTION_TRAFFIC_SHIFTExecute after production traffic shift.

Referenced by ​