software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.JsonBodyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.JsonBodyProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(value=Stable)
public static interface CfnRuleGroup.JsonBodyProperty
extends software.amazon.jsii.JsiiSerializable

The body of a web request, inspected as JSON.

The body immediately follows the request headers. This is used in the FieldToMatch specification.

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate.

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;
 JsonBodyProperty jsonBodyProperty = JsonBodyProperty.builder()
         .matchPattern(JsonMatchPatternProperty.builder()
                 .all(all)
                 .includedPaths(List.of("includedPaths"))
                 .build())
         .matchScope("matchScope")
         // the properties below are optional
         .invalidFallbackBehavior("invalidFallbackBehavior")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRuleGroup.JsonBodyProperty.Builder	builder()
default String	getInvalidFallbackBehavior() What AWS WAF should do if it fails to completely parse the JSON body.
Object	getMatchPattern() The patterns to look for in the JSON body.
String	getMatchScope() The parts of the JSON to match against using the `MatchPattern` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMatchPattern

@Stability(value=Stable)
 @NotNull
Object getMatchPattern()

The patterns to look for in the JSON body.

AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

getMatchScope

@Stability(value=Stable)
 @NotNull
String getMatchScope()

The parts of the JSON to match against using the `MatchPattern` .

If you specify All , AWS WAF matches against keys and values.

getInvalidFallbackBehavior

@Stability(value=Stable)
 @Nullable
default String getInvalidFallbackBehavior()

What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:.

• EVALUATE_AS_STRING - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
• MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.

AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

AWS WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}
• Missing colon: {"key1":"value1","key2""value2"}
• Extra colons: {"key1"::"value1","key2""value2"}

builder

@Stability(value=Stable)
static CfnRuleGroup.JsonBodyProperty.Builder builder()

Returns:

a CfnRuleGroup.JsonBodyProperty.Builder of CfnRuleGroup.JsonBodyProperty