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 IRuleGroupReferenceStatementProperty
Syntax (vb)
Public Interface IRuleGroupReferenceStatementProperty
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html

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 Count .
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

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-arn

ExcludedRules

Rules in the referenced rule group whose actions are set to Count .

virtual object ExcludedRules { get; }
Property Value

System.Object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-excludedrules

RuleActionOverrides

Action settings to use in the place of the rule actions that are configured inside the rule group.

virtual object RuleActionOverrides { get; }
Property Value

System.Object

Remarks

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

Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting.

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html#cfn-wafv2-webacl-rulegroupreferencestatement-ruleactionoverrides