Package software.amazon.awscdk.mixins.preview.services.wafv2.mixins

Interface CfnRuleGroupPropsMixin.RegexMatchStatementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroupPropsMixin.RegexMatchStatementProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroupPropsMixin

@Stability(Stable)
public static interface CfnRuleGroupPropsMixin.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.mixins.preview.services.wafv2.mixins.*;
 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())
                 .ja3Fingerprint(JA3FingerprintProperty.builder()
                         .fallbackBehavior("fallbackBehavior")
                         .build())
                 .ja4Fingerprint(JA4FingerprintProperty.builder()
                         .fallbackBehavior("fallbackBehavior")
                         .build())
                 .jsonBody(JsonBodyProperty.builder()
                         .invalidFallbackBehavior("invalidFallbackBehavior")
                         .matchPattern(JsonMatchPatternProperty.builder()
                                 .all(all)
                                 .includedPaths(List.of("includedPaths"))
                                 .build())
                         .matchScope("matchScope")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .method(method)
                 .queryString(queryString)
                 .singleHeader(singleHeader)
                 .singleQueryArgument(singleQueryArgument)
                 .uriFragment(UriFragmentProperty.builder()
                         .fallbackBehavior("fallbackBehavior")
                         .build())
                 .uriPath(uriPath)
                 .build())
         .regexString("regexString")
         .textTransformations(List.of(TextTransformationProperty.builder()
                 .priority(123)
                 .type("type")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html

Nested Class Summary

Nested Classes

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

Method Summary

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

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

Returns union: either IResolvable or CfnRuleGroupPropsMixin.FieldToMatchProperty

See Also:

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

getRegexString

@Stability(Stable)
@Nullable
default String getRegexString()

The string representing the regular expression.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html#cfn-wafv2-rulegroup-regexmatchstatement-regexstring

getTextTransformations

@Stability(Stable)
@Nullable
default 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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRuleGroupPropsMixin.TextTransformationProperty>

See Also:

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

builder

@Stability(Stable)
static CfnRuleGroupPropsMixin.RegexMatchStatementProperty.Builder builder()

Returns:

a CfnRuleGroupPropsMixin.RegexMatchStatementProperty.Builder of CfnRuleGroupPropsMixin.RegexMatchStatementProperty