Class JsonBody

java.lang.Object
software.amazon.awssdk.services.wafv2.model.JsonBody
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JsonBody.Builder,JsonBody>
@Generated("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" }

For additional information about this request component option, see JSON body in the WAF Developer Guide.

See Also:

  • Method Details

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

      All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the 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.

      All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

      See Also:

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

      All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the 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.

      All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

      See Also:

    • 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 parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

      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 parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

      See Also:

    • 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 parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

      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 parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

      See Also:

    • 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. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

      • For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

      • For Amplify, use the CloudFront limit.

      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. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

      • For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

      • For Amplify, use the CloudFront limit.

      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:

    • 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. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

      • For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

      • For Amplify, use the CloudFront limit.

      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. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.

      • For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.

      • For Amplify, use the CloudFront limit.

      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:

    • toBuilder

      public JsonBody.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JsonBody.Builder,JsonBody>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.