AWS::WAFv2::WebACL CookieMatchPattern - 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::WebACL CookieMatchPattern

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

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

Syntax

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

JSON

{
  "All" : Json,
  "ExcludedCookies" : [ String, ... ],
  "IncludedCookies" : [ String, ... ]
}

YAML

  All: Json
  ExcludedCookies: 
    - String
  IncludedCookies: 
    - String

Properties

All

Inspect all cookies.

Required: No

Type: Json

Update requires: No interruption

ExcludedCookies

Inspect only the cookies whose keys don't match any of the strings specified here.

Required: No

Type: Array of String

Minimum: 1 | 1

Maximum: 60 | 199

Update requires: No interruption

IncludedCookies

Inspect only the cookies that have a key that matches one of the strings specified here.

Required: No

Type: Array of String

Minimum: 1 | 1

Maximum: 60 | 199

Update requires: No interruption

Examples

Set a cookie match pattern for all paths

The following shows an example cookie match pattern specification for all paths.

YAML

MatchPattern:
  All: {}

JSON

"MatchPattern": {
  "All": {}
}

Set a cookie match pattern with included paths

The following shows an example cookie match pattern specification with included paths.

YAML

MatchPattern:
  IncludedCookies:
      - "session-id"
      - "session-id-time"

JSON

"MatchPattern": {
  "IncludedCookies": [
    "session-id",
    "session-id-time"
  ]
}