class ApplicationListenerRule (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ElasticLoadBalancingV2.ApplicationListenerRule
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#ApplicationListenerRule
Java	software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerRule
Python	aws_cdk.aws_elasticloadbalancingv2.ApplicationListenerRule
TypeScript (source)	aws-cdk-lib » aws_elasticloadbalancingv2 » ApplicationListenerRule

Implements IConstruct, IDependable

Define a new listener rule.

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

Initializer

new ApplicationListenerRule(scope: Construct, id: string, props: ApplicationListenerRuleProps)

Parameters

• scope Construct
• id string
• props ApplicationListenerRuleProps

Construct Props

Name	Type	Description
listener	IApplicationListener	The listener to attach the rule to.
priority	number	Priority of the rule.
action?	ListenerAction	Action to perform when requests are received.
conditions?	ListenerCondition[]	Rule applies if matches the conditions.
targetGroups?	IApplicationTargetGroup[]	Target groups to forward requests to.

---

listener

Type: IApplicationListener

The listener to attach the rule to.

---

priority

Type: number

Priority of the rule.

The rule with the lowest priority will be used for every request.

Priorities must be unique.

---

action?

Type: ListenerAction (optional, default: No action)

Action to perform when requests are received.

Only one of action, fixedResponse, redirectResponse or targetGroups can be specified.

---

conditions?

Type: ListenerCondition[] (optional, default: No conditions.)

Rule applies if matches the conditions.

See also: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html

---

targetGroups?

Type: IApplicationTargetGroup[] (optional, default: No target groups.)

Target groups to forward requests to.

Only one of action, fixedResponse, redirectResponse or targetGroups can be specified.

Implies a forward action.

Properties

Name	Type	Description
listenerRuleArn	string	The ARN of this rule.
node	Node	The tree node.

---

listenerRuleArn

Type: string

The ARN of this rule.

---

node

Type: Node

The tree node.

Methods

Name	Description
addCondition(condition)	Add a non-standard condition to this rule.
configureAction(action)	Configure the action to perform for this rule.
toString()	Returns a string representation of this construct.

---

addCondition(condition)

public addCondition(condition: ListenerCondition): void

Parameters

• condition ListenerCondition

Add a non-standard condition to this rule.

---

configureAction(action)

public configureAction(action: ListenerAction): void

Parameters

• action ListenerAction

Configure the action to perform for this rule.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.