Class CfnLoggingConfiguration.JsonBodyProperty.Builder

java.lang.Object
software.amazon.awscdk.services.wafv2.CfnLoggingConfiguration.JsonBodyProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnLoggingConfiguration.JsonBodyProperty>
Enclosing interface:
CfnLoggingConfiguration.JsonBodyProperty

@Stability(Stable) public static final class CfnLoggingConfiguration.JsonBodyProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnLoggingConfiguration.JsonBodyProperty>
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • matchPattern

      @Stability(Stable) public CfnLoggingConfiguration.JsonBodyProperty.Builder matchPattern(IResolvable matchPattern)
      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

      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 CfnLoggingConfiguration.JsonBodyProperty.Builder matchScope(String matchScope)
      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.

      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:
      this
    • invalidFallbackBehavior

      @Stability(Stable) public CfnLoggingConfiguration.JsonBodyProperty.Builder invalidFallbackBehavior(String invalidFallbackBehavior)
      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
    • build

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