Interface CfnWebACLProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWebACLProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.077Z") @Stability(Stable) public interface CfnWebACLProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnWebACL.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.waf.*;
 CfnWebACLProps cfnWebACLProps = CfnWebACLProps.builder()
         .defaultAction(WafActionProperty.builder()
                 .type("type")
                 .build())
         .metricName("metricName")
         .name("name")
         // the properties below are optional
         .rules(List.of(ActivatedRuleProperty.builder()
                 .priority(123)
                 .ruleId("ruleId")
                 // the properties below are optional
                 .action(WafActionProperty.builder()
                         .type("type")
                         .build())
                 .build()))
         .build();
 
  • Method Details

    • getDefaultAction

      @Stability(Stable) @NotNull Object getDefaultAction()
      The action to perform if none of the Rules contained in the WebACL match.

      The action is specified by the WafAction object.

    • getMetricName

      @Stability(Stable) @NotNull String getMetricName()
      The name of the metrics for this WebACL .

      The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF , including "All" and "Default_Action." You can't change MetricName after you create the WebACL .

    • getName

      @Stability(Stable) @NotNull String getName()
      A friendly name or description of the WebACL .

      You can't change the name of a WebACL after you create it.

    • getRules

      @Stability(Stable) @Nullable default Object getRules()
      An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .
    • builder

      @Stability(Stable) static CfnWebACLProps.Builder builder()
      Returns:
      a CfnWebACLProps.Builder of CfnWebACLProps