AWS SDK for C++  1.9.130
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::JsonBody Class Reference

#include <JsonBody.h>

Public Member Functions

 JsonBody ()
 
 JsonBody (Aws::Utils::Json::JsonView jsonValue)
 
JsonBodyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const JsonMatchPatternGetMatchPattern () const
 
bool MatchPatternHasBeenSet () const
 
void SetMatchPattern (const JsonMatchPattern &value)
 
void SetMatchPattern (JsonMatchPattern &&value)
 
JsonBodyWithMatchPattern (const JsonMatchPattern &value)
 
JsonBodyWithMatchPattern (JsonMatchPattern &&value)
 
const JsonMatchScopeGetMatchScope () const
 
bool MatchScopeHasBeenSet () const
 
void SetMatchScope (const JsonMatchScope &value)
 
void SetMatchScope (JsonMatchScope &&value)
 
JsonBodyWithMatchScope (const JsonMatchScope &value)
 
JsonBodyWithMatchScope (JsonMatchScope &&value)
 
const BodyParsingFallbackBehaviorGetInvalidFallbackBehavior () const
 
bool InvalidFallbackBehaviorHasBeenSet () const
 
void SetInvalidFallbackBehavior (const BodyParsingFallbackBehavior &value)
 
void SetInvalidFallbackBehavior (BodyParsingFallbackBehavior &&value)
 
JsonBodyWithInvalidFallbackBehavior (const BodyParsingFallbackBehavior &value)
 
JsonBodyWithInvalidFallbackBehavior (BodyParsingFallbackBehavior &&value)
 

Detailed Description

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. WAF inspects only the parts of the JSON that result from the matches that you indicate.

Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }

See Also:

AWS API Reference

Definition at line 39 of file JsonBody.h.

Constructor & Destructor Documentation

◆ JsonBody() [1/2]

Aws::WAFV2::Model::JsonBody::JsonBody ( )

◆ JsonBody() [2/2]

Aws::WAFV2::Model::JsonBody::JsonBody ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetInvalidFallbackBehavior()

const BodyParsingFallbackBehavior& Aws::WAFV2::Model::JsonBody::GetInvalidFallbackBehavior ( ) const
inline

What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

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.

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"}

Definition at line 140 of file JsonBody.h.

◆ GetMatchPattern()

const JsonMatchPattern& Aws::WAFV2::Model::JsonBody::GetMatchPattern ( ) const
inline

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Definition at line 52 of file JsonBody.h.

◆ GetMatchScope()

const JsonMatchScope& Aws::WAFV2::Model::JsonBody::GetMatchScope ( ) const
inline

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Definition at line 89 of file JsonBody.h.

◆ InvalidFallbackBehaviorHasBeenSet()

bool Aws::WAFV2::Model::JsonBody::InvalidFallbackBehaviorHasBeenSet ( ) const
inline

What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

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.

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"}

Definition at line 160 of file JsonBody.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WAFV2::Model::JsonBody::Jsonize ( ) const

◆ MatchPatternHasBeenSet()

bool Aws::WAFV2::Model::JsonBody::MatchPatternHasBeenSet ( ) const
inline

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Definition at line 58 of file JsonBody.h.

◆ MatchScopeHasBeenSet()

bool Aws::WAFV2::Model::JsonBody::MatchScopeHasBeenSet ( ) const
inline

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Definition at line 95 of file JsonBody.h.

◆ operator=()

JsonBody& Aws::WAFV2::Model::JsonBody::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetInvalidFallbackBehavior() [1/2]

void Aws::WAFV2::Model::JsonBody::SetInvalidFallbackBehavior ( BodyParsingFallbackBehavior &&  value)
inline

What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

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.

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"}

Definition at line 200 of file JsonBody.h.

◆ SetInvalidFallbackBehavior() [2/2]

void Aws::WAFV2::Model::JsonBody::SetInvalidFallbackBehavior ( const BodyParsingFallbackBehavior value)
inline

What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

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.

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"}

Definition at line 180 of file JsonBody.h.

◆ SetMatchPattern() [1/2]

void Aws::WAFV2::Model::JsonBody::SetMatchPattern ( const JsonMatchPattern value)
inline

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Definition at line 64 of file JsonBody.h.

◆ SetMatchPattern() [2/2]

void Aws::WAFV2::Model::JsonBody::SetMatchPattern ( JsonMatchPattern &&  value)
inline

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Definition at line 70 of file JsonBody.h.

◆ SetMatchScope() [1/2]

void Aws::WAFV2::Model::JsonBody::SetMatchScope ( const JsonMatchScope value)
inline

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Definition at line 101 of file JsonBody.h.

◆ SetMatchScope() [2/2]

void Aws::WAFV2::Model::JsonBody::SetMatchScope ( JsonMatchScope &&  value)
inline

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Definition at line 107 of file JsonBody.h.

◆ WithInvalidFallbackBehavior() [1/2]

JsonBody& Aws::WAFV2::Model::JsonBody::WithInvalidFallbackBehavior ( BodyParsingFallbackBehavior &&  value)
inline

What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

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.

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"}

Definition at line 240 of file JsonBody.h.

◆ WithInvalidFallbackBehavior() [2/2]

JsonBody& Aws::WAFV2::Model::JsonBody::WithInvalidFallbackBehavior ( const BodyParsingFallbackBehavior value)
inline

What 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. 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. 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, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

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.

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"}

Definition at line 220 of file JsonBody.h.

◆ WithMatchPattern() [1/2]

JsonBody& Aws::WAFV2::Model::JsonBody::WithMatchPattern ( const JsonMatchPattern value)
inline

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Definition at line 76 of file JsonBody.h.

◆ WithMatchPattern() [2/2]

JsonBody& Aws::WAFV2::Model::JsonBody::WithMatchPattern ( JsonMatchPattern &&  value)
inline

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Definition at line 82 of file JsonBody.h.

◆ WithMatchScope() [1/2]

JsonBody& Aws::WAFV2::Model::JsonBody::WithMatchScope ( const JsonMatchScope value)
inline

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Definition at line 113 of file JsonBody.h.

◆ WithMatchScope() [2/2]

JsonBody& Aws::WAFV2::Model::JsonBody::WithMatchScope ( JsonMatchScope &&  value)
inline

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Definition at line 119 of file JsonBody.h.


The documentation for this class was generated from the following file: