aws-cdk-lib.aws_ecs.AlternateTargetConfig

AlternateTargetConfig Struct

Configuration returned by AlternateTargetConfiguration.bind().

Source

aws-ecs/lib/alternate-target-configuration.ts

Type last changed

v2.211.0 · 13 Aug 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const alternateTargetConfig: ecs.AlternateTargetConfig = {
  alternateTargetGroupArn: 'alternateTargetGroupArn',
  roleArn: 'roleArn',

  // the properties below are optional
  productionListenerRule: 'productionListenerRule',
  testListenerRule: 'testListenerRule',
};

Properties

alternateTargetGroupArnstringalternate_target_group_arnstralternateTargetGroupArnStringAlternateTargetGroupArnstringAlternateTargetGroupArn*stringrequired#

The ARN of the alternate target group.

productionListenerRule?optionalstringproduction_listener_rule?optionalstrproductionListenerRule?optionalStringProductionListenerRule?optionalstringProductionListenerRule?optional*string= none#

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

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

The IAM role ARN for the configuration.

Default: a new role will be created

testListenerRule?optionalstringtest_listener_rule?optionalstrtestListenerRule?optionalStringTestListenerRule?optionalstringTestListenerRule?optional*string= none#

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