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(value=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()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWebACL.RuleGroupReferenceStatementProperty.Builder A builder for CfnWebACL.RuleGroupReferenceStatementProperty
static class	CfnWebACL.RuleGroupReferenceStatementProperty.Jsii$Proxy An implementation for CfnWebACL.RuleGroupReferenceStatementProperty

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.RuleGroupReferenceStatementProperty.Builder	builder()
String	getArn() The Amazon Resource Name (ARN) of the entity.
default Object	getExcludedRules() The rules in the referenced rule group whose actions are set to `Count` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArn

@Stability(value=Stable)
 @NotNull
String getArn()

The Amazon Resource Name (ARN) of the entity.

getExcludedRules

@Stability(value=Stable)
 @Nullable
default Object getExcludedRules()

The rules in the referenced rule group whose actions are set to `Count` .

When you exclude a rule, AWS WAF evaluates it exactly as it would if the rule action setting were Count . This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

builder

@Stability(value=Stable)
static CfnWebACL.RuleGroupReferenceStatementProperty.Builder builder()

Returns:

a CfnWebACL.RuleGroupReferenceStatementProperty.Builder of CfnWebACL.RuleGroupReferenceStatementProperty