Interface CfnRuleGroup.IRuleProperty

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way.

Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnRuleGroup.IRuleProperty
Syntax (vb)
Public Interface CfnRuleGroup.IRuleProperty
Remarks

Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

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

ExampleMetadata: fixture=_generated

Synopsis

Properties

Action

The action that AWS WAF should take on a web request when it matches the rule statement.
CaptchaConfig

Specifies how AWS WAF should handle CAPTCHA evaluations.
ChallengeConfig

Specifies how AWS WAF should handle Challenge evaluations.
Name

The name of the rule.
Priority

If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority .
RuleLabels

Labels to apply to web requests that match the rule match statement.
Statement

The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
VisibilityConfig

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Properties

Action

The action that AWS WAF should take on a web request when it matches the rule statement.

object? Action { get; }
Property Value

object

Remarks

Settings at the web ACL level can override the rule action setting.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-action

Type union: either IResolvable or CfnRuleGroup.IRuleActionProperty

CaptchaConfig

Specifies how AWS WAF should handle CAPTCHA evaluations.

object? CaptchaConfig { get; }
Property Value

object

Remarks

If you don't specify this, AWS WAF uses the CAPTCHA configuration that's defined for the web ACL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-captchaconfig

Type union: either IResolvable or CfnRuleGroup.ICaptchaConfigProperty

ChallengeConfig

Specifies how AWS WAF should handle Challenge evaluations.

object? ChallengeConfig { get; }
Property Value

object

Remarks

If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-challengeconfig

Type union: either IResolvable or CfnRuleGroup.IChallengeConfigProperty

Name

The name of the rule.

string Name { get; }
Property Value

string

Remarks

If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. AWS WAF doesn't automatically update the metric name when you update the rule name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-name

Priority

If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority .

double Priority { get; }
Property Value

double

Remarks

AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-priority

RuleLabels

Labels to apply to web requests that match the rule match statement.

object? RuleLabels { get; }
Property Value

object

Remarks

AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

    For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-rulelabels

    Type union: either IResolvable or (either IResolvable or CfnRuleGroup.ILabelProperty)[]

    Statement

    The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

    object Statement { get; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-statement

    Type union: either IResolvable or CfnRuleGroup.IStatementProperty

    VisibilityConfig

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    object VisibilityConfig { get; }
    Property Value

    object

    Remarks

    If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-visibilityconfig

    Type union: either IResolvable or CfnRuleGroup.IVisibilityConfigProperty