Package software.amazon.awscdk.services.wafv2

Class CfnWebACL.JsonBodyProperty.Builder

java.lang.Object
software.amazon.awscdk.services.wafv2.CfnWebACL.JsonBodyProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebACL.JsonBodyProperty>
Enclosing interface:
CfnWebACL.JsonBodyProperty
@Stability(Stable) public static final class CfnWebACL.JsonBodyProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnWebACL.JsonBodyProperty>
A builder for CfnWebACL.JsonBodyProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • matchPattern

      @Stability(Stable) public CfnWebACL.JsonBodyProperty.Builder matchPattern(IResolvable matchPattern)
      Sets the value of CfnWebACL.JsonBodyProperty.getMatchPattern()
      Parameters:
      matchPattern - The patterns to look for in the JSON body. This parameter is required. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
      Returns:
      this

    • matchPattern

      @Stability(Stable) public CfnWebACL.JsonBodyProperty.Builder matchPattern(CfnWebACL.JsonMatchPatternProperty matchPattern)
      Sets the value of CfnWebACL.JsonBodyProperty.getMatchPattern()
      Parameters:
      matchPattern - The patterns to look for in the JSON body. This parameter is required. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
      Returns:
      this

    • matchScope

      @Stability(Stable) public CfnWebACL.JsonBodyProperty.Builder matchScope(String matchScope)
      Sets the value of CfnWebACL.JsonBodyProperty.getMatchScope()
      Parameters:
      matchScope - The parts of the JSON to match against using the MatchPattern . This parameter is required. If you specify All , AWS WAF matches against keys and values.
      Returns:
      this

    • invalidFallbackBehavior

      @Stability(Stable) public CfnWebACL.JsonBodyProperty.Builder invalidFallbackBehavior(String invalidFallbackBehavior)
      Sets the value of CfnWebACL.JsonBodyProperty.getInvalidFallbackBehavior()
      Parameters:
      invalidFallbackBehavior - 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"}
      Returns:
      this

    • oversizeHandling

      @Stability(Stable) public CfnWebACL.JsonBodyProperty.Builder oversizeHandling(String oversizeHandling)
      Sets the value of CfnWebACL.JsonBodyProperty.getOversizeHandling()
      Parameters:
      oversizeHandling - What AWS WAF should do if the body is larger than AWS WAF can inspect. AWS 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 AWS WAF for inspection.

      The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) 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. AWS 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:
      this

    • build

      @Stability(Stable) public CfnWebACL.JsonBodyProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWebACL.JsonBodyProperty>
      Returns:
      a new instance of CfnWebACL.JsonBodyProperty
      Throws:
      NullPointerException - if any required attribute was not provided