Package software.amazon.awssdk.services.wafv2.model

Interface JsonBody.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JsonBody.Builder,JsonBody>, SdkBuilder<JsonBody.Builder,JsonBody>, SdkPojo
Enclosing class:
JsonBody
public static interface JsonBody.Builder extends SdkPojo, CopyableBuilder<JsonBody.Builder,JsonBody>

  • Method Details

    • matchPattern

      JsonBody.Builder matchPattern(JsonMatchPattern matchPattern)

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

      Parameters:
      matchPattern - The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchPattern

      default JsonBody.Builder matchPattern(Consumer<JsonMatchPattern.Builder> matchPattern)

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

      This is a convenience method that creates an instance of the JsonMatchPattern.Builder avoiding the need to create one manually via JsonMatchPattern.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matchPattern(JsonMatchPattern).

      Parameters:
      matchPattern - a consumer that will call methods on JsonMatchPattern.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • matchScope

      JsonBody.Builder matchScope(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • matchScope

      JsonBody.Builder matchScope(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • invalidFallbackBehavior

      JsonBody.Builder invalidFallbackBehavior(String 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"}

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • invalidFallbackBehavior

      JsonBody.Builder invalidFallbackBehavior(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"}

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • oversizeHandling

      JsonBody.Builder oversizeHandling(String 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • oversizeHandling

      JsonBody.Builder oversizeHandling(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: