Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.RegexPatternSetReferenceStatementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(Stable)
public static interface CfnRuleGroup.RegexPatternSetReferenceStatementProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.wafv2.*;
 Object all;
 Object allQueryArguments;
 Object method;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 Object uriPath;
 RegexPatternSetReferenceStatementProperty regexPatternSetReferenceStatementProperty = RegexPatternSetReferenceStatementProperty.builder()
         .arn("arn")
         .fieldToMatch(FieldToMatchProperty.builder()
                 .allQueryArguments(allQueryArguments)
                 .body(BodyProperty.builder()
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .cookies(CookiesProperty.builder()
                         .matchPattern(CookieMatchPatternProperty.builder()
                                 .all(all)
                                 .excludedCookies(List.of("excludedCookies"))
                                 .includedCookies(List.of("includedCookies"))
                                 .build())
                         .matchScope("matchScope")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .headers(HeadersProperty.builder()
                         .matchPattern(HeaderMatchPatternProperty.builder()
                                 .all(all)
                                 .excludedHeaders(List.of("excludedHeaders"))
                                 .includedHeaders(List.of("includedHeaders"))
                                 .build())
                         .matchScope("matchScope")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .jsonBody(JsonBodyProperty.builder()
                         .matchPattern(JsonMatchPatternProperty.builder()
                                 .all(all)
                                 .includedPaths(List.of("includedPaths"))
                                 .build())
                         .matchScope("matchScope")
                         // the properties below are optional
                         .invalidFallbackBehavior("invalidFallbackBehavior")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .method(method)
                 .queryString(queryString)
                 .singleHeader(singleHeader)
                 .singleQueryArgument(singleQueryArgument)
                 .uriPath(uriPath)
                 .build())
         .textTransformations(List.of(TextTransformationProperty.builder()
                 .priority(123)
                 .type("type")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Builder	A builder for CfnRuleGroup.RegexPatternSetReferenceStatementProperty
static final class	CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Jsii$Proxy	An implementation for CfnRuleGroup.RegexPatternSetReferenceStatementProperty

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Builder	builder()
String	getArn()	The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
Object	getFieldToMatch()	The part of the web request that you want AWS WAF to inspect.
Object	getTextTransformations()	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArn

@Stability(Stable)
@NotNull
String getArn()

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

getFieldToMatch

@Stability(Stable)
@NotNull
Object getFieldToMatch()

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

getTextTransformations

@Stability(Stable)
@NotNull
Object getTextTransformations()

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.

builder

@Stability(Stable)
static CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Builder builder()

Returns:

a CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Builder of CfnRuleGroup.RegexPatternSetReferenceStatementProperty