AWS::WAFv2::WebACL Rule - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::WAFv2::WebACL Rule

A single rule, which you can use in a AWS::WAFv2::WebACL or AWS::WAFv2::RuleGroup to identify web requests that you want to manage in some way. Each rule includes one top-level Statement that Amazon WAF uses to identify matching web requests, and parameters that govern how Amazon WAF handles them.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

Action

The action that Amazon WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.

This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupStatement.

You must set either this Action setting or the rule's OverrideAction, but not both:

  • If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.

  • If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.

Required: Conditional

Type: RuleAction

Update requires: No interruption

CaptchaConfig

Specifies how Amazon WAF should handle CAPTCHA evaluations. If you don't specify this, Amazon WAF uses the CAPTCHA configuration that's defined for the web ACL.

Required: No

Type: CaptchaConfig

Update requires: No interruption

ChallengeConfig

Specifies how Amazon WAF should handle Challenge evaluations. If you don't specify this, Amazon WAF uses the challenge configuration that's defined for the web ACL.

Required: No

Type: ChallengeConfig

Update requires: No interruption

Name

The name of the rule.

If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. Amazon WAF doesn't automatically update the metric name when you update the rule name.

Required: Yes

Type: String

Pattern: ^[0-9A-Za-z_-]{1,128}$

Update requires: No interruption

OverrideAction

The override action to apply to the rules in a rule group, instead of the individual rule action settings. This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupStatement.

Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

You must set either this OverrideAction setting or the Action setting, but not both:

  • If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.

  • If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.

Required: Conditional

Type: OverrideAction

Update requires: No interruption

Priority

If you define more than one Rule in a WebACL, Amazon WAF evaluates each request against the Rules in order based on the value of Priority. Amazon WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

Required: Yes

Type: Integer

Minimum: 0

Update requires: No interruption

RuleLabels

Labels to apply to web requests that match the rule match statement. Amazon WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

  • Separate each component of the label with a colon.

  • Each namespace or name can have up to 128 characters.

  • You can specify up to 5 namespaces in a label.

  • Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.

Required: No

Type: Array of Label

Update requires: No interruption

Statement

The Amazon WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

Required: Yes

Type: Statement

Update requires: No interruption

VisibilityConfig

Defines and enables Amazon CloudWatch metrics and web request sample collection.

If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. Amazon WAF doesn't automatically update the metric name.

Required: Yes

Type: VisibilityConfig

Update requires: No interruption