Interface CfnWebACL.IRuleGroupReferenceStatementProperty
A rule statement used to run the rules that are defined in a RuleGroup .
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnWebACL.IRuleGroupReferenceStatementPropertySyntax (vb)
Public Interface CfnWebACL.IRuleGroupReferenceStatementPropertyRemarks
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 cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;
var ruleGroupReferenceStatementProperty = new RuleGroupReferenceStatementProperty {
Arn = "arn",
// the properties below are optional
ExcludedRules = new [] { new ExcludedRuleProperty {
Name = "name"
} },
RuleActionOverrides = new [] { new RuleActionOverrideProperty {
ActionToUse = new RuleActionProperty {
Allow = new AllowActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Block = new BlockActionProperty {
CustomResponse = new CustomResponseProperty {
ResponseCode = 123,
// the properties below are optional
CustomResponseBodyKey = "customResponseBodyKey",
ResponseHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Captcha = new CaptchaActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Challenge = new ChallengeActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Count = new CountActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
}
},
Name = "name"
} }
};Synopsis
Properties
| Arn | The Amazon Resource Name (ARN) of the entity. |
| ExcludedRules | Rules in the referenced rule group whose actions are set to |
| RuleActionOverrides | Action settings to use in the place of the rule actions that are configured inside the rule group. |
Properties
Arn
The Amazon Resource Name (ARN) of the entity.
string Arn { get; }Property Value
Remarks
ExcludedRules
Rules in the referenced rule group whose actions are set to Count .
object? ExcludedRules { get; }Property Value
Remarks
Instead of this option, use <code>RuleActionOverrides</code> . It accepts any valid action setting, including <code>Count</code> .
Type union: either IResolvable or (either IResolvable or CfnWebACL.IExcludedRuleProperty)[]
RuleActionOverrides
Action settings to use in the place of the rule actions that are configured inside the rule group.
object? RuleActionOverrides { get; }Property Value
Remarks
You specify one override for each rule whose action you want to change.
Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.
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.
Type union: either IResolvable or (either IResolvable or CfnWebACL.IRuleActionOverrideProperty)[]