Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.RuleGroupReferenceStatementProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWebACL.RuleGroupReferenceStatementProperty.Jsii$Proxy
Enclosing class:
CfnWebACL
@Stability(Stable) public static interface CfnWebACL.RuleGroupReferenceStatementProperty extends software.amazon.jsii.JsiiSerializable
A rule statement used to run the rules that are defined in a RuleGroup .

To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . You can only use a rule group reference statement at the top level inside a web ACL.

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.wafv2.*;
 RuleGroupReferenceStatementProperty ruleGroupReferenceStatementProperty = RuleGroupReferenceStatementProperty.builder()
         .arn("arn")
         // the properties below are optional
         .excludedRules(List.of(ExcludedRuleProperty.builder()
                 .name("name")
                 .build()))
         .ruleActionOverrides(List.of(RuleActionOverrideProperty.builder()
                 .actionToUse(RuleActionProperty.builder()
                         .allow(AllowActionProperty.builder()
                                 .customRequestHandling(CustomRequestHandlingProperty.builder()
                                         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .block(BlockActionProperty.builder()
                                 .customResponse(CustomResponseProperty.builder()
                                         .responseCode(123)
                                         // the properties below are optional
                                         .customResponseBodyKey("customResponseBodyKey")
                                         .responseHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .captcha(CaptchaActionProperty.builder()
                                 .customRequestHandling(CustomRequestHandlingProperty.builder()
                                         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .challenge(ChallengeActionProperty.builder()
                                 .customRequestHandling(CustomRequestHandlingProperty.builder()
                                         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .count(CountActionProperty.builder()
                                 .customRequestHandling(CustomRequestHandlingProperty.builder()
                                         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .name("name")
                 .build()))
         .build();

  • Method Details

    • getArn

      @Stability(Stable) @NotNull String getArn()
      The Amazon Resource Name (ARN) of the entity.

    • getExcludedRules

      @Stability(Stable) @Nullable default Object getExcludedRules()
      Rules in the referenced rule group whose actions are set to Count .

      Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

    • getRuleActionOverrides

      @Stability(Stable) @Nullable default Object getRuleActionOverrides()
      Action settings to use in the place of the rule actions that are configured inside the rule group.

      You specify one override for each rule whose action you want to change.

      You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

    • builder

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