AWS::WAFv2::WebACL ManagedRuleGroupStatement - AWS CloudFormation
SyntaxPropertiesExamples

AWS::WAFv2::WebACL ManagedRuleGroupStatement

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names through the API call ListAvailableManagedRuleGroups.

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group statement inside another rule group. You can only use a managed rule group statement as a top-level statement in a rule that you define in a web ACL.

Note

You are charged additional fees when you use the AWS WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see AWS WAF Pricing.

Syntax

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

Properties

ExcludedRules

Rules in the referenced rule group whose actions are set to Count.

Note

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

Required: No

Type: Array of ExcludedRule

Maximum: 100

Update requires: No interruption

ManagedRuleGroupConfigs

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

The rule groups used for intelligent threat mitigation require additional configuration:

  • Use the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

  • Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

  • Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

Required: No

Type: Array of ManagedRuleGroupConfig

Update requires: No interruption

Name

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Required: Yes

Type: String

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

Update requires: No interruption

RuleActionOverrides

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

Required: No

Type: Array of RuleActionOverride

Maximum: 100

Update requires: No interruption

ScopeDownStatement

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

Required: No

Type: Statement

Update requires: No interruption

VendorName

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 128

Update requires: No interruption

Version

The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

Required: No

Type: String

Pattern: ^[\w#:\.\-/]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

Examples

Configure the managed rule group statement for AWSManagedRulesATPRuleSet

The following shows an example ManagedRuleGroupStatement for the AWS WAF ATP managed rule group. The ManagedRuleGroupConfigs settings are provided as a number of individual ManagedRuleGroupConfig settings.

YAML

ManagedRuleGroupStatement:
  VendorName: AWS
  Name: AWSManagedRulesATPRuleSet
  ManagedRuleGroupConfigs:
    - LoginPath: /api/accounts/login
    - PayloadType: JSON
    - PasswordField:
        Identifier: /form/password
    - UsernameField:
        Identifier: /form/username

JSON

{
  "ManagedRuleGroupStatement": {
    "VendorName": "AWS",
    "Name": "AWSManagedRulesATPRuleSet",
    "ManagedRuleGroupConfigs": [
      {
        "LoginPath": "/api/accounts/login"
      },
      {
        "PayloadType": "JSON"
      },
      {
        "PasswordField": {
          "Identifier": "/form/password"
        }
      },
      {
        "UsernameField": {
          "Identifier": "/form/username"
        }
      }
    ]
  }
}

Configure a standard managed rule group statement

The following shows an example ManagedRuleGroupStatement for a managed rule group that doesn't require additional configuration.

YAML

ManagedRuleGroupStatement:
  VendorName: AWS
  Name: AWSManagedRulesCommonRuleSet

JSON

{
  "ManagedRuleGroupStatement": {
    "VendorName": "AWS",
    "Name": "AWSManagedRulesCommonRuleSet"
  }
}