interface JsonMatchPatternProperty

Language	Type name
.NET	`Amazon.CDK.AWS.WAFv2.CfnRuleGroup.JsonMatchPatternProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnRuleGroup_JsonMatchPatternProperty`
Java	`software.amazon.awscdk.services.wafv2.CfnRuleGroup.JsonMatchPatternProperty`
Python	`aws_cdk.aws_wafv2.CfnRuleGroup.JsonMatchPatternProperty`
TypeScript	`aws-cdk-lib` » `aws_wafv2` » `CfnRuleGroup` » `JsonMatchPatternProperty`

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';

declare const all: any;
const jsonMatchPatternProperty: wafv2.CfnRuleGroup.JsonMatchPatternProperty = {
  all: all,
  includedPaths: ['includedPaths'],
};

Properties

Name	Type	Description
all?	`any`	Match all of the elements. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification.
includedPaths?	`string[]`	Match only the specified include paths. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification.

all?

Type: any (optional)

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.

includedPaths?

Type: string[] (optional)

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.

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