aws-cdk-lib.aws_wafv2.CfnWebACL.RegexMatchStatementProperty

interface RegexMatchStatementProperty

LanguageType name
.NETAmazon.CDK.AWS.WAFv2.CfnWebACL.RegexMatchStatementProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnWebACL_RegexMatchStatementProperty
Javasoftware.amazon.awscdk.services.wafv2.CfnWebACL.RegexMatchStatementProperty
Pythonaws_cdk.aws_wafv2.CfnWebACL.RegexMatchStatementProperty
TypeScript aws-cdk-lib » aws_wafv2 » CfnWebACL » RegexMatchStatementProperty

A rule statement used to search web request components for a match against a single regular expression.

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 regexMatchStatementProperty: wafv2.CfnWebACL.RegexMatchStatementProperty = {
  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',
    },
    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,
  },
  regexString: 'regexString',
  textTransformations: [{
    priority: 123,
    type: 'type',
  }],
};

Properties

NameTypeDescription
fieldToMatchIResolvable | FieldToMatchPropertyThe part of the web request that you want AWS WAF to inspect.
regexStringstringThe string representing the regular expression.
textTransformationsIResolvable | IResolvable | TextTransformationProperty[]Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

fieldToMatch

Type: IResolvable | FieldToMatchProperty

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


regexString

Type: string

The string representing the regular expression.


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.