software.amazon.awssdk.services.wafv2.model

Class JsonBody

java.lang.Object

software.amazon.awssdk.services.wafv2.model.JsonBody

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JsonBody.Builder,JsonBody>

@Generated(value="software.amazon.awssdk:codegen")
public final class JsonBody
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JsonBody.Builder,JsonBody>

Inspect the body of the web request as JSON. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JsonBody.Builder

Method Summary

Modifier and Type	Method and Description
static JsonBody.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
BodyParsingFallbackBehavior	invalidFallbackBehavior() What WAF should do if it fails to completely parse the JSON body.
String	invalidFallbackBehaviorAsString() What WAF should do if it fails to completely parse the JSON body.
JsonMatchPattern	matchPattern() The patterns to look for in the JSON body.
JsonMatchScope	matchScope() The parts of the JSON to match against using the MatchPattern.
String	matchScopeAsString() The parts of the JSON to match against using the MatchPattern.
OversizeHandling	oversizeHandling() What WAF should do if the body is larger than WAF can inspect.
String	oversizeHandlingAsString() What WAF should do if the body is larger than WAF can inspect.
List<SdkField<?>>	sdkFields()
static Class<? extends JsonBody.Builder>	serializableBuilderClass()
JsonBody.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

matchPattern

public final JsonMatchPattern matchPattern()

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

Returns:

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

matchScope

public final JsonMatchScope matchScope()

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

If the service returns an enum value that is not available in the current SDK version, matchScope will return JsonMatchScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchScopeAsString().

Returns:

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

See Also:

JsonMatchScope

matchScopeAsString

public final String matchScopeAsString()

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

If the service returns an enum value that is not available in the current SDK version, matchScope will return JsonMatchScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchScopeAsString().

Returns:

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

See Also:

JsonMatchScope

invalidFallbackBehavior

public final BodyParsingFallbackBehavior invalidFallbackBehavior()

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

If the service returns an enum value that is not available in the current SDK version, invalidFallbackBehavior will return BodyParsingFallbackBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invalidFallbackBehaviorAsString().

Returns:

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

See Also:

BodyParsingFallbackBehavior

invalidFallbackBehaviorAsString

public final String invalidFallbackBehaviorAsString()

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

If the service returns an enum value that is not available in the current SDK version, invalidFallbackBehavior will return BodyParsingFallbackBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invalidFallbackBehaviorAsString().

Returns:

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

See Also:

BodyParsingFallbackBehavior

oversizeHandling

public final OversizeHandling oversizeHandling()

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.

The default limit is 8 KB (8,192 bytes) for regional resources and 16 KB (16,384 bytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

The options for oversize handling are the following:

• CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.

• 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.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

If the service returns an enum value that is not available in the current SDK version, oversizeHandling will return OversizeHandling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from oversizeHandlingAsString().

Returns:

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.

The default limit is 8 KB (8,192 bytes) for regional resources and 16 KB (16,384 bytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

The options for oversize handling are the following:

• CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.

• 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.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

See Also:

OversizeHandling

oversizeHandlingAsString

public final String oversizeHandlingAsString()

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.

The default limit is 8 KB (8,192 bytes) for regional resources and 16 KB (16,384 bytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

The options for oversize handling are the following:

• CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.

• 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.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

If the service returns an enum value that is not available in the current SDK version, oversizeHandling will return OversizeHandling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from oversizeHandlingAsString().

Returns:

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service only forwards the contents that are below the limit to WAF for inspection.

The default limit is 8 KB (8,192 bytes) for regional resources and 16 KB (16,384 bytes) for CloudFront distributions. For CloudFront distributions, you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

The options for oversize handling are the following:

• CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.

• 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.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

Default: CONTINUE

See Also:

OversizeHandling

toBuilder

public JsonBody.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JsonBody.Builder,JsonBody>

builder

public static JsonBody.Builder builder()

serializableBuilderClass

public static Class<? extends JsonBody.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo