AWS::WAFv2::RuleGroup - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
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::RuleGroup

Note

This is the latest version of Amazon WAF , named Amazon WAFV2, released in November, 2019. For information, including how to migrate your Amazon WAF resources from the prior release, see the Amazon WAF developer guide.

Use an AWS::WAFv2::RuleGroup to define a collection of rules for inspecting and controlling web requests. You use a rule group in an AWS::WAFv2::WebACL by providing its Amazon Resource Name (ARN) to the rule statement RuleGroupReferenceStatement, when you add rules to the web ACL.

When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Syntax

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

JSON

{
  "Type" : "AWS::WAFv2::RuleGroup",
  "Properties" : {
      "AvailableLabels" : [ LabelSummary, ... ],
      "Capacity" : Integer,
      "ConsumedLabels" : [ LabelSummary, ... ],
      "CustomResponseBodies" : {Key: Value, ...},
      "Description" : String,
      "Name" : String,
      "Rules" : [ Rule, ... ],
      "Scope" : String,
      "Tags" : [ Tag, ... ],
      "VisibilityConfig" : VisibilityConfig
    }
}

YAML

Type: AWS::WAFv2::RuleGroup
Properties:
  AvailableLabels: 
    - LabelSummary
  Capacity: Integer
  ConsumedLabels: 
    - LabelSummary
  CustomResponseBodies: 
    Key: Value
  Description: String
  Name: String
  Rules: 
    - Rule
  Scope: String
  Tags: 
    - Tag
  VisibilityConfig: 
    VisibilityConfig

Properties

AvailableLabels

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

Required: No

Type: Array of LabelSummary

Update requires: No interruption

Capacity

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, Amazon WAF enforces this limit.

Amazon WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. Amazon WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Required: Yes

Type: Integer

Minimum: 0

Update requires: No interruption

ConsumedLabels

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

Required: No

Type: Array of LabelSummary

Update requires: No interruption

CustomResponseBodies

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in Amazon WAF in the Amazon WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see Amazon WAF quotas in the Amazon WAF Developer Guide.

Required: No

Type: Object of CustomResponseBody

Update requires: No interruption

Description

A description of the rule group that helps with identification.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9=:#@/\-,.][a-zA-Z0-9+=:#@/\-,.\s]+[a-zA-Z0-9+=:#@/\-,.]{1,256}$

Update requires: No interruption

Name

The name of the rule group. You cannot change the name of a rule group after you create it.

Required: No

Type: String

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

Update requires: Replacement

Rules

The rule statements used to identify the web requests that you want to allow, block, or count. 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.

Required: No

Type: Array of Rule

Update requires: No interruption

Scope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an Amazon AppSync GraphQL API, an Amazon Cognito user pool, an Amazon App Runner service, or an Amazon Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL.

Note

For CLOUDFRONT, you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1.

Required: Yes

Type: String

Allowed values: CLOUDFRONT | REGIONAL

Update requires: Replacement

Tags

Key:value pairs associated with an Amazon resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon resource.

Note

To modify tags on existing resources, use the Amazon WAF APIs or command line interface. With Amazon CloudFormation, you can only add tags to Amazon WAF resources during resource creation.

Required: No

Type: Array of Tag

Minimum: 1

Update requires: No interruption

VisibilityConfig

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

Required: Yes

Type: VisibilityConfig

Update requires: No interruption

Return values

Ref

The Ref for the resource, containing the resource name, physical ID, and scope, formatted as follows: name|id|scope.

For example: my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the rule group.

Id

The ID of the rule group.

LabelNamespace

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

The syntax for the label namespace prefix for a rule group is the following: awswaf:<account ID>:rule group:<rule group name>:

When a rule with a label matches a web request, Amazon WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon.

Examples

Create a rule group

The following shows an example rule group specification.

YAML

 SampleRuleGroup:
      Type: 'AWS::WAFv2::RuleGroup'
      Properties:
        Name: SampleRuleGroup
        Scope: REGIONAL
        Description: SampleRuleGroup
        VisibilityConfig:
          SampledRequestsEnabled: true
          CloudWatchMetricsEnabled: true
          MetricName: SampleRuleGroupMetrics
        CustomResponseBodies:
          CustomResponseBodyKey1:
            ContentType: TEXT_PLAIN
            Content: this is a plain text
          CustomResponseBodyKey2:
            ContentType: APPLICATION_JSON
            Content: '{"jsonfieldname": "jsonfieldvalue"}'
          CustomResponseBodyKey3:
            ContentType: TEXT_HTML
            Content: <html>HTML text content</html>
        Capacity: 1000
        Rules:
          - Name: RuleOne
            Priority: 1
            Action:
              Allow:
                CustomRequestHandling:
                  InsertHeaders:
                    - Name: AllowActionHeader1Name
                      Value: AllowActionHeader1Value
                    - Name: AllowActionHeader2Name
                      Value: AllowActionHeader2Value
            VisibilityConfig:
              SampledRequestsEnabled: true
              CloudWatchMetricsEnabled: true
              MetricName: RuleOneMetric
            Statement:
              ByteMatchStatement:
                FieldToMatch:
                  AllQueryArguments: {}
                PositionalConstraint: CONTAINS
                SearchString: testagent
                TextTransformations:
                  - Priority: 1
                    Type: HTML_ENTITY_DECODE
          - Name: RuleTwo
            Priority: 2
            Action:
              Block:
                CustomResponse:
                  ResponseCode: 503
                  CustomResponseBodyKey: CustomResponseBodyKey1
                  ResponseHeaders:
                    - Name: BlockActionHeader1Name
                      Value: BlockActionHeader1Value
                    - Name: BlockActionHeader2Name
                      Value: BlockActionHeader2Value
            VisibilityConfig:
              SampledRequestsEnabled: true
              CloudWatchMetricsEnabled: true
              MetricName: RuleTwoMetric
            Statement:
              ByteMatchStatement:
                FieldToMatch:
                  SingleHeader:
                    Name: haystack
                PositionalConstraint: CONTAINS
                SearchString: badbot
                TextTransformations:
                  - Priority: 0
                    Type: NONE
          - Name: RuleThree
            Priority: 3
            Action:
              Count:
                CustomRequestHandling:
                  InsertHeaders:
                    - Name: CountActionHeader1Name
                      Value: CountActionHeader1Value
                    - Name: CountActionHeader2Name
                      Value: CountActionHeader2Value
            VisibilityConfig:
              SampledRequestsEnabled: true
              CloudWatchMetricsEnabled: true
              MetricName: RuleThreeMetric
            Statement:
              ByteMatchStatement:
                FieldToMatch:
                  Body: {}
                PositionalConstraint: CONTAINS
                SearchString: RegionOne
                TextTransformations:
                  - Priority: 0
                    Type: HTML_ENTITY_DECODE
          - Name: RuleFour
            Priority: 4
            Action:
              Allow: {}
            VisibilityConfig:
              SampledRequestsEnabled: true
              CloudWatchMetricsEnabled: true
              MetricName: RuleFourMetric
            Statement:
              SizeConstraintStatement:
                ComparisonOperator: GT
                Size: 1000
                FieldToMatch:
                  UriPath: {}
                TextTransformations:
                  - Priority: 0
                    Type: NONE

JSON

    "SampleRuleGroup": {
        "Type": "AWS::WAFv2::RuleGroup",
        "Properties": {
            "Name": "SampleRuleGroup",
            "Scope": "REGIONAL",
            "Description": "SampleRuleGroup",
            "VisibilityConfig": {
                "SampledRequestsEnabled": true,
                "CloudWatchMetricsEnabled": true,
                "MetricName": "SampleRuleGroupMetrics"
            },
            "CustomResponseBodies": {
                "CustomResponseBodyKey1": {
                    "ContentType": "TEXT_PLAIN",
                    "Content": "this is a plain text"
                },
                "CustomResponseBodyKey2": {
                    "ContentType": "APPLICATION_JSON",
                    "Content": "{\"jsonfieldname\": \"jsonfieldvalue\"}"
                },
                "CustomResponseBodyKey3": {
                    "ContentType": "TEXT_HTML",
                    "Content": "<html>HTML text content</html>"
                }
            },              
            "Capacity": 1000,
            "Rules": [
                {
                    "Name": "RuleOne",
                    "Priority": 1,
                    "Action": {
                        "Allow": {
                            "CustomRequestHandling": {
                                "InsertHeaders": [
                                    {
                                        "Name": "AllowActionHeader1Name",
                                        "Value": "AllowActionHeader1Value"
                                    },
                                    {
                                        "Name": "AllowActionHeader2Name",
                                        "Value": "AllowActionHeader2Value"
                                    }
                                ]
                            }
                        }
                    },
                    "VisibilityConfig": {
                        "SampledRequestsEnabled": true,
                        "CloudWatchMetricsEnabled": true,
                        "MetricName": "RuleOneMetric"
                    },
                    "Statement": {
                        "ByteMatchStatement": {
                            "FieldToMatch": {
                                "AllQueryArguments": {}
                            },
                            "PositionalConstraint": "CONTAINS",
                            "SearchString": "testagent",
                            "TextTransformations": [
                                {
                                    "Priority": 1,
                                    "Type": "HTML_ENTITY_DECODE"
                                }
                            ]
                        }
                    }
                },
                {
                    "Name": "RuleTwo",
                    "Priority": 2,
                    "Action": {
                        "Block": {
                            "CustomResponse": {
                                "ResponseCode": 503,
                                "CustomResponseBodyKey": "CustomResponseBodyKey1",
                                "ResponseHeaders": [
                                    {
                                        "Name": "BlockActionHeader1Name",
                                        "Value": "BlockActionHeader1Value"
                                    },
                                    {
                                        "Name": "BlockActionHeader2Name",
                                        "Value": "BlockActionHeader2Value"
                                    }
                                ]
                            }
                        }
                    },
                    "VisibilityConfig": {
                        "SampledRequestsEnabled": true,
                        "CloudWatchMetricsEnabled": true,
                        "MetricName": "RuleTwoMetric"
                    },
                    "Statement": {
                        "ByteMatchStatement": {
                            "FieldToMatch": {
                                "SingleHeader": {
                                    "Name": "haystack"
                                }
                            },
                            "PositionalConstraint": "CONTAINS",
                            "SearchString": "badbot",
                            "TextTransformations": [
                                {
                                    "Priority": 0,
                                    "Type": "NONE"
                                }
                            ]
                        }
                    }
                },
                {
                    "Name": "RuleThree",
                    "Priority": 3,
                    "Action": {
                        "Count": {
                            "CustomRequestHandling": {
                                "InsertHeaders": [
                                    {
                                        "Name": "CountActionHeader1Name",
                                        "Value": "CountActionHeader1Value"
                                    },
                                    {
                                        "Name": "CountActionHeader2Name",
                                        "Value": "CountActionHeader2Value"
                                    }
                                ]
                            }
                        }
                    },
                    "VisibilityConfig": {
                        "SampledRequestsEnabled": true,
                        "CloudWatchMetricsEnabled": true,
                        "MetricName": "RuleThreeMetric"
                    },
                    "Statement": {
                        "ByteMatchStatement": {
                            "FieldToMatch": {
                                "Body": {}
                            },
                            "PositionalConstraint": "CONTAINS",
                            "SearchString": "RegionOne",
                            "TextTransformations": [
                                {
                                    "Priority": 0,
                                    "Type": "HTML_ENTITY_DECODE"
                                }
                            ]
                        }
                    }
                },
                {
                    "Name": "RuleFour",
                    "Priority": 4,
                    "Action": {
                        "Allow": {}
                    },
                    "VisibilityConfig": {
                        "SampledRequestsEnabled": true,
                        "CloudWatchMetricsEnabled": true,
                        "MetricName": "RuleFourMetric"
                    },
                    "Statement": {
                        "SizeConstraintStatement": {
                            "ComparisonOperator": "GT",
                            "Size": 1000,
                            "FieldToMatch": {
                                "UriPath": {}
                            },
                            "TextTransformations": [
                                {
                                    "Priority": 0,
                                    "Type": "NONE"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }