Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.RegexMatchStatementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.RegexMatchStatementProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

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

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 software.amazon.awscdk.services.wafv2.*;
 Object all;
 Object allQueryArguments;
 Object method;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 Object uriPath;
 RegexMatchStatementProperty regexMatchStatementProperty = RegexMatchStatementProperty.builder()
         .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())
         .regexString("regexString")
         .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.RegexMatchStatementProperty.Builder	A builder for CfnRuleGroup.RegexMatchStatementProperty
static final class	CfnRuleGroup.RegexMatchStatementProperty.Jsii$Proxy	An implementation for CfnRuleGroup.RegexMatchStatementProperty

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.RegexMatchStatementProperty.Builder	builder()
Object	getFieldToMatch()	The part of the web request that you want AWS WAF to inspect.
String	getRegexString()	The string representing the regular expression.
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

getFieldToMatch

@Stability(Stable)
@NotNull
Object getFieldToMatch()

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

getRegexString

@Stability(Stable)
@NotNull
String getRegexString()

The string representing the regular expression.

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.RegexMatchStatementProperty.Builder builder()

Returns:

a CfnRuleGroup.RegexMatchStatementProperty.Builder of CfnRuleGroup.RegexMatchStatementProperty