interface RegexPatternSetReferenceStatementProperty

Language	Type name
.NET	`Amazon.CDK.AWS.WAFv2.CfnRuleGroup.RegexPatternSetReferenceStatementProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnRuleGroup_RegexPatternSetReferenceStatementProperty`
Java	`software.amazon.awscdk.services.wafv2.CfnRuleGroup.RegexPatternSetReferenceStatementProperty`
Python	`aws_cdk.aws_wafv2.CfnRuleGroup.RegexPatternSetReferenceStatementProperty`
TypeScript	`aws-cdk-lib` » `aws_wafv2` » `CfnRuleGroup` » `RegexPatternSetReferenceStatementProperty`

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

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';

declare const all: any;
declare const allQueryArguments: any;
declare const method: any;
declare const queryString: any;
declare const singleHeader: any;
declare const singleQueryArgument: any;
declare const uriPath: any;
const regexPatternSetReferenceStatementProperty: wafv2.CfnRuleGroup.RegexPatternSetReferenceStatementProperty = {
  arn: 'arn',
  fieldToMatch: {
    allQueryArguments: allQueryArguments,
    body: {
      oversizeHandling: 'oversizeHandling',
    },
    cookies: {
      matchPattern: {
        all: all,
        excludedCookies: ['excludedCookies'],
        includedCookies: ['includedCookies'],
      },
      matchScope: 'matchScope',
      oversizeHandling: 'oversizeHandling',
    },
    headers: {
      matchPattern: {
        all: all,
        excludedHeaders: ['excludedHeaders'],
        includedHeaders: ['includedHeaders'],
      },
      matchScope: 'matchScope',
      oversizeHandling: 'oversizeHandling',
    },
    ja3Fingerprint: {
      fallbackBehavior: 'fallbackBehavior',
    },
    jsonBody: {
      matchPattern: {
        all: all,
        includedPaths: ['includedPaths'],
      },
      matchScope: 'matchScope',

      // the properties below are optional
      invalidFallbackBehavior: 'invalidFallbackBehavior',
      oversizeHandling: 'oversizeHandling',
    },
    method: method,
    queryString: queryString,
    singleHeader: singleHeader,
    singleQueryArgument: singleQueryArgument,
    uriPath: uriPath,
  },
  textTransformations: [{
    priority: 123,
    type: 'type',
  }],
};

Properties

Name	Type	Description
arn	`string`	The Amazon Resource Name (ARN) of the `RegexPatternSet` that this statement references.
fieldToMatch	`IResolvable` `\|` `FieldToMatchProperty`	The part of the web request that you want AWS WAF to inspect.
textTransformations	`IResolvable` `\|` `IResolvable` `\|` `TextTransformationProperty[]`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

arn

Type: string

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

fieldToMatch

Type: IResolvable | FieldToMatchProperty

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

textTransformations

Type: IResolvable | IResolvable | TextTransformationProperty[]

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

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.