Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.JsonMatchPatternProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.JsonMatchPatternProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(Stable)
public static interface CfnRuleGroup.JsonMatchPatternProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.wafv2.*;
 Object all;
 JsonMatchPatternProperty jsonMatchPatternProperty = JsonMatchPatternProperty.builder()
         .all(all)
         .includedPaths(List.of("includedPaths"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleGroup.JsonMatchPatternProperty.Builder	A builder for CfnRuleGroup.JsonMatchPatternProperty
static final class	CfnRuleGroup.JsonMatchPatternProperty.Jsii$Proxy	An implementation for CfnRuleGroup.JsonMatchPatternProperty

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.JsonMatchPatternProperty.Builder	builder()
default Object	getAll()	Match all of the elements.
default List<String>	getIncludedPaths()	Match only the specified include paths.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAll

@Stability(Stable)
@Nullable
default Object getAll()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html#cfn-wafv2-rulegroup-jsonmatchpattern-all

getIncludedPaths

@Stability(Stable)
@Nullable
default List<String> getIncludedPaths()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html#cfn-wafv2-rulegroup-jsonmatchpattern-includedpaths

builder

@Stability(Stable)
static CfnRuleGroup.JsonMatchPatternProperty.Builder builder()

Returns:

a CfnRuleGroup.JsonMatchPatternProperty.Builder of CfnRuleGroup.JsonMatchPatternProperty