Interface CfnRuleGroup.IRegexPatternSetReferenceStatementProperty

A rule statement used to search web request components for matches with regular expressions.

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

To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.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 all;
var allQueryArguments;
var method;
var queryString;
var singleHeader;
var singleQueryArgument;
var uriPath;

var regexPatternSetReferenceStatementProperty = new RegexPatternSetReferenceStatementProperty {
    Arn = "arn",
    FieldToMatch = new FieldToMatchProperty {
        AllQueryArguments = allQueryArguments,
        Body = new BodyProperty {
            OversizeHandling = "oversizeHandling"
        },
        Cookies = new CookiesProperty {
            MatchPattern = new CookieMatchPatternProperty {
                All = all,
                ExcludedCookies = new [] { "excludedCookies" },
                IncludedCookies = new [] { "includedCookies" }
            },
            MatchScope = "matchScope",
            OversizeHandling = "oversizeHandling"
        },
        Headers = new HeadersProperty {
            MatchPattern = new HeaderMatchPatternProperty {
                All = all,
                ExcludedHeaders = new [] { "excludedHeaders" },
                IncludedHeaders = new [] { "includedHeaders" }
            },
            MatchScope = "matchScope",
            OversizeHandling = "oversizeHandling"
        },
        Ja3Fingerprint = new JA3FingerprintProperty {
            FallbackBehavior = "fallbackBehavior"
        },
        Ja4Fingerprint = new JA4FingerprintProperty {
            FallbackBehavior = "fallbackBehavior"
        },
        JsonBody = new JsonBodyProperty {
            MatchPattern = new JsonMatchPatternProperty {
                All = all,
                IncludedPaths = new [] { "includedPaths" }
            },
            MatchScope = "matchScope",

            // the properties below are optional
            InvalidFallbackBehavior = "invalidFallbackBehavior",
            OversizeHandling = "oversizeHandling"
        },
        Method = method,
        QueryString = queryString,
        SingleHeader = singleHeader,
        SingleQueryArgument = singleQueryArgument,
        UriPath = uriPath
    },
    TextTransformations = new [] { new TextTransformationProperty {
        Priority = 123,
        Type = "type"
    } }
};

Synopsis

Properties

Arn

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
FieldToMatch

The part of the web request that you want AWS WAF to inspect.
TextTransformations

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

Properties

Arn

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

string Arn { get; }
Property Value

System.String

Remarks

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

FieldToMatch

The part of the web request that you want AWS WAF to inspect.

object FieldToMatch { get; }
Property Value

System.Object

Remarks

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

TextTransformations

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

object TextTransformations { get; }
Property Value

System.Object

Remarks

If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

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