Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

AWS::WAFv2::RuleGroup JsonMatchPattern

RSS
Focus mode
AWS::WAFv2::RuleGroup JsonMatchPattern - AWS CloudFormation
SyntaxPropertiesExamples
Filter View

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

Syntax

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

JSON

{
  "All" : Json,
  "IncludedPaths" : [ String, ... ]
}

YAML

  All: Json
  IncludedPaths: 
    - String

Properties

All

Match all of the elements. See also MatchScope in the JsonBody FieldToMatch specification.

You must specify either this setting or the IncludedPaths setting, but not both.

Required: No

Type: Json

Update requires: No interruption

IncludedPaths

Match only the specified include paths. See also MatchScope in the JsonBody FieldToMatch specification.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Note

Don't use this option to include all paths. Instead, use the All setting.

Required: No

Type: Array of String

Minimum: 1

Update requires: No interruption

Examples

Set a JSON match pattern for all paths

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

YAML

MatchPattern:
  All: {}

JSON

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

Set a JSON match pattern with included paths

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

YAML

MatchPattern:
  IncludedPaths:
    - "/dogs/0/name"
    - "/cats/0/name"

JSON

"MatchPattern": {
  "IncludedPaths": [
    "/dogs/0/name",
    "/cats/0/name"
  ]
}

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.