AWS::WAFv2::RuleGroup Headers - Amazon CloudFormation
SyntaxPropertiesExamples
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 Headers

Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.

Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

Syntax

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

JSON

{
  "MatchPattern" : HeaderMatchPattern,
  "MatchScope" : String,
  "OversizeHandling" : String
}

Properties

MatchPattern

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }

Required: Yes

Type: HeaderMatchPattern

Update requires: No interruption

MatchScope

The parts of the headers to match with the rule inspection criteria. If you specify All, Amazon WAF inspects both keys and values.

Required: Yes

Type: String

Allowed values: ALL | KEY | VALUE

Update requires: No interruption

OversizeHandling

What Amazon WAF should do if the headers of the request are larger than Amazon WAF can inspect. Amazon WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to Amazon WAF.

The options for oversize handling are the following:

  • CONTINUE - Inspect the headers normally, according to the rule inspection criteria.

  • MATCH - Treat the web request as matching the rule statement. Amazon WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

Required: Yes

Type: String

Allowed values: CONTINUE | MATCH | NO_MATCH

Update requires: No interruption

Examples

Set the Headers specification

The following shows an example Headers field to match specification.

YAML

FieldToMatch:
  Headers:
    MatchPattern:
      IncludedHeaders:
      - "User-Agent"
      - "Referer"
    MatchScope: ALL 
    OversizeHandling: MATCH

JSON

"FieldToMatch": {
  "Headers": {
    "MatchPattern": {
      "IncludedHeaders": [
        "User-Agent",
        "Referer"
      ]
    },
    "MatchScope": "ALL",
    "OversizeHandling": "MATCH" 
  }
}