AWS::ElasticLoadBalancingV2::ListenerRule

ElasticLoadBalancingV2 ListenerRule

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*.

Properties

6 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`Actions`	`Array<Action>`	Required
`Conditions`	`Array<RuleCondition>`	Required
`Priority`	`integer`	Required
`ListenerArn`	`string`	Create-onlyWrite-only
`Tags`	`Array<Tag>`
`Transforms`	`Array<Transform>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`IsDefault`	`boolean`	-
`RuleArn`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ElasticLoadBalancingV2::ListenerRule

Resources:
  MyResource:
    Type: AWS::ElasticLoadBalancingV2::ListenerRule
    Properties:
      Actions: []
      Priority: 1
      Conditions: []
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

elasticloadbalancing:CreateRuleelasticloadbalancing:DescribeRuleselasticloadbalancing:AddTagscognito-idp:DescribeUserPoolClient

delete

elasticloadbalancing:DeleteRuleelasticloadbalancing:DescribeRules

list

elasticloadbalancing:DescribeRules

read

elasticloadbalancing:DescribeRuleselasticloadbalancing:DescribeTags

update

elasticloadbalancing:ModifyRuleelasticloadbalancing:SetRulePrioritieselasticloadbalancing:DescribeRuleselasticloadbalancing:AddTagselasticloadbalancing:RemoveTagselasticloadbalancing:DescribeTags

Get the ElasticLoadBalancingV2 Cheat Sheet

Everything you need to know about ElasticLoadBalancingV2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceElasticLoadBalancingV2

Properties8

Required3

TaggingSupported

Primary IDRuleArn

Supported Operations

CreateDeleteListReadUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ListenerArn

Related Resources

External Links

AWS Documentation