interface AlternateTargetProps

Language	Type name
.NET	Amazon.CDK.AWS.ECS.AlternateTargetProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecs#AlternateTargetProps
Java	software.amazon.awscdk.services.ecs.AlternateTargetProps
Python	aws_cdk.aws_ecs.AlternateTargetProps
TypeScript (source)	aws-cdk-lib » aws_ecs » AlternateTargetProps

Properties for AlternateTarget configuration.

Example

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);

Properties

Name	Type	Description
alternateTargetGroup	ITargetGroup	The alternate target group.
productionListener	ListenerRuleConfiguration	The production listener rule ARN (ALB) or listener ARN (NLB).
role?	IRole	The IAM role for the configuration.
testListener?	ListenerRuleConfiguration	The test listener configuration.

---

alternateTargetGroup

Type: ITargetGroup

The alternate target group.

---

productionListener

Type: ListenerRuleConfiguration

The production listener rule ARN (ALB) or listener ARN (NLB).

---

role?

Type: IRole (optional, default: a new role will be created)

The IAM role for the configuration.

---

testListener?

Type: ListenerRuleConfiguration (optional, default: none)

The test listener configuration.