AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ElasticLoadBalancingV2::ListenerRule

CfnListenerRule

Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers* .

Import

import { CfnListenerRule } from 'aws-cdk-lib/aws-elasticloadbalancingv2';

Or use the module namespace:

import * as elasticloadbalancingv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';
// elasticloadbalancingv2.CfnListenerRule

Properties

Configuration passed to the constructor as CfnListenerRuleProps.

actionsRequired
IResolvable | IResolvable | ActionProperty[]

The actions. The rule must include exactly one of the following types of actions: `forward` , `fixed-response` , or `redirect` , and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.

conditionsRequired
IResolvable | IResolvable | RuleConditionProperty[]

The conditions. The rule can optionally include up to one of each of the following conditions: `http-request-method` , `host-header` , `path-pattern` , and `source-ip` . A rule can also optionally include one or more of each of the following conditions: `http-header` and `query-string` .

priorityRequired
number

The rule priority. A listener can't have multiple rules with the same priority. If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.

listenerArnOptional
string | IListenerRef

The Amazon Resource Name (ARN) of the listener.

transformsOptional
IResolvable | IResolvable | TransformProperty[]

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ElasticLoadBalancingV2::ListenerRuleView in CloudFormation Explorer

Get the Elastic Load Balancing V2 Cheat Sheet

Everything you need to know about Elastic Load Balancing V2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-elasticloadbalancingv2
CFN TypeAWS::ElasticLoadBalancingV2::ListenerRule
Properties5

Related Constructs

Explore This Service

External Links