Interface CfnWebACL.RuleProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnWebACL.RuleProperty extends
A combination of ByteMatchSet , IPSet , and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count.

For example, you might create a Rule that includes the following predicates:

  • An IPSet that causes AWS WAF to search for web requests that originate from the IP address
  • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot .

To match the settings in this Rule , a request must originate from AND include a User-Agent header for which the value is BadBot .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 RuleProperty ruleProperty = RuleProperty.builder()
  • Method Details

    • getAction

      @Stability(Stable) @NotNull Object getAction()
      The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.
    • getPriority

      @Stability(Stable) @NotNull Number getPriority()
      The order in which AWS WAF evaluates the rules in a web ACL.

      AWS WAF evaluates rules with a lower value before rules with a higher value. The value must be a unique integer. If you have multiple rules in a web ACL, the priority numbers do not need to be consecutive.

    • getRuleId

      @Stability(Stable) @NotNull String getRuleId()
      The ID of an AWS WAF Regional rule to associate with a web ACL.
    • builder

      @Stability(Stable) static CfnWebACL.RuleProperty.Builder builder()
      a CfnWebACL.RuleProperty.Builder of CfnWebACL.RuleProperty