software.amazon.awscdk.services.wafv2

Interface CfnWebACL.ManagedRuleGroupStatementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.ManagedRuleGroupStatementProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(value=Stable)
public static interface CfnWebACL.ManagedRuleGroupStatementProperty
extends software.amazon.jsii.JsiiSerializable

A rule statement used to run the rules that are defined in a managed rule group.

To use this, provide the vendor name and the name of the rule group in this statement.

You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.

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 body;
 Object method;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 StatementProperty statementProperty_;
 Object uriPath;
 ManagedRuleGroupStatementProperty managedRuleGroupStatementProperty = ManagedRuleGroupStatementProperty.builder()
         .name("name")
         .vendorName("vendorName")
         // the properties below are optional
         .excludedRules(List.of(ExcludedRuleProperty.builder()
                 .name("name")
                 .build()))
         .managedRuleGroupConfigs(List.of(ManagedRuleGroupConfigProperty.builder()
                 .loginPath("loginPath")
                 .passwordField(FieldIdentifierProperty.builder()
                         .identifier("identifier")
                         .build())
                 .payloadType("payloadType")
                 .usernameField(FieldIdentifierProperty.builder()
                         .identifier("identifier")
                         .build())
                 .build()))
         .scopeDownStatement(StatementProperty.builder()
                 .andStatement(AndStatementProperty.builder()
                         .statements(List.of(statementProperty_))
                         .build())
                 .byteMatchStatement(ByteMatchStatementProperty.builder()
                         .fieldToMatch(FieldToMatchProperty.builder()
                                 .allQueryArguments(allQueryArguments)
                                 .body(body)
                                 .jsonBody(JsonBodyProperty.builder()
                                         .matchPattern(JsonMatchPatternProperty.builder()
                                                 .all(all)
                                                 .includedPaths(List.of("includedPaths"))
                                                 .build())
                                         .matchScope("matchScope")
                                         // the properties below are optional
                                         .invalidFallbackBehavior("invalidFallbackBehavior")
                                         .build())
                                 .method(method)
                                 .queryString(queryString)
                                 .singleHeader(singleHeader)
                                 .singleQueryArgument(singleQueryArgument)
                                 .uriPath(uriPath)
                                 .build())
                         .positionalConstraint("positionalConstraint")
                         .textTransformations(List.of(TextTransformationProperty.builder()
                                 .priority(123)
                                 .type("type")
                                 .build()))
                         // the properties below are optional
                         .searchString("searchString")
                         .searchStringBase64("searchStringBase64")
                         .build())
                 .geoMatchStatement(GeoMatchStatementProperty.builder()
                         .countryCodes(List.of("countryCodes"))
                         .forwardedIpConfig(ForwardedIPConfigurationProperty.builder()
                                 .fallbackBehavior("fallbackBehavior")
                                 .headerName("headerName")
                                 .build())
                         .build())
                 .ipSetReferenceStatement(Map.of(
                         "arn", "arn",
                         // the properties below are optional
                         "ipSetForwardedIpConfig", Map.of(
                                 "fallbackBehavior", "fallbackBehavior",
                                 "headerName", "headerName",
                                 "position", "position")))
                 .labelMatchStatement(LabelMatchStatementProperty.builder()
                         .key("key")
                         .scope("scope")
                         .build())
                 .managedRuleGroupStatement(ManagedRuleGroupStatementProperty.builder()
                         .name("name")
                         .vendorName("vendorName")
                         // the properties below are optional
                         .excludedRules(List.of(ExcludedRuleProperty.builder()
                                 .name("name")
                                 .build()))
                         .managedRuleGroupConfigs(List.of(ManagedRuleGroupConfigProperty.builder()
                                 .loginPath("loginPath")
                                 .passwordField(FieldIdentifierProperty.builder()
                                         .identifier("identifier")
                                         .build())
                                 .payloadType("payloadType")
                                 .usernameField(FieldIdentifierProperty.builder()
                                         .identifier("identifier")
                                         .build())
                                 .build()))
                         .scopeDownStatement(statementProperty_)
                         .version("version")
                         .build())
                 .notStatement(NotStatementProperty.builder()
                         .statement(statementProperty_)
                         .build())
                 .orStatement(OrStatementProperty.builder()
                         .statements(List.of(statementProperty_))
                         .build())
                 .rateBasedStatement(RateBasedStatementProperty.builder()
                         .aggregateKeyType("aggregateKeyType")
                         .limit(123)
                         // the properties below are optional
                         .forwardedIpConfig(ForwardedIPConfigurationProperty.builder()
                                 .fallbackBehavior("fallbackBehavior")
                                 .headerName("headerName")
                                 .build())
                         .scopeDownStatement(statementProperty_)
                         .build())
                 .regexMatchStatement(RegexMatchStatementProperty.builder()
                         .fieldToMatch(FieldToMatchProperty.builder()
                                 .allQueryArguments(allQueryArguments)
                                 .body(body)
                                 .jsonBody(JsonBodyProperty.builder()
                                         .matchPattern(JsonMatchPatternProperty.builder()
                                                 .all(all)
                                                 .includedPaths(List.of("includedPaths"))
                                                 .build())
                                         .matchScope("matchScope")
                                         // the properties below are optional
                                         .invalidFallbackBehavior("invalidFallbackBehavior")
                                         .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())
                 .regexPatternSetReferenceStatement(RegexPatternSetReferenceStatementProperty.builder()
                         .arn("arn")
                         .fieldToMatch(FieldToMatchProperty.builder()
                                 .allQueryArguments(allQueryArguments)
                                 .body(body)
                                 .jsonBody(JsonBodyProperty.builder()
                                         .matchPattern(JsonMatchPatternProperty.builder()
                                                 .all(all)
                                                 .includedPaths(List.of("includedPaths"))
                                                 .build())
                                         .matchScope("matchScope")
                                         // the properties below are optional
                                         .invalidFallbackBehavior("invalidFallbackBehavior")
                                         .build())
                                 .method(method)
                                 .queryString(queryString)
                                 .singleHeader(singleHeader)
                                 .singleQueryArgument(singleQueryArgument)
                                 .uriPath(uriPath)
                                 .build())
                         .textTransformations(List.of(TextTransformationProperty.builder()
                                 .priority(123)
                                 .type("type")
                                 .build()))
                         .build())
                 .ruleGroupReferenceStatement(RuleGroupReferenceStatementProperty.builder()
                         .arn("arn")
                         // the properties below are optional
                         .excludedRules(List.of(ExcludedRuleProperty.builder()
                                 .name("name")
                                 .build()))
                         .build())
                 .sizeConstraintStatement(SizeConstraintStatementProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .fieldToMatch(FieldToMatchProperty.builder()
                                 .allQueryArguments(allQueryArguments)
                                 .body(body)
                                 .jsonBody(JsonBodyProperty.builder()
                                         .matchPattern(JsonMatchPatternProperty.builder()
                                                 .all(all)
                                                 .includedPaths(List.of("includedPaths"))
                                                 .build())
                                         .matchScope("matchScope")
                                         // the properties below are optional
                                         .invalidFallbackBehavior("invalidFallbackBehavior")
                                         .build())
                                 .method(method)
                                 .queryString(queryString)
                                 .singleHeader(singleHeader)
                                 .singleQueryArgument(singleQueryArgument)
                                 .uriPath(uriPath)
                                 .build())
                         .size(123)
                         .textTransformations(List.of(TextTransformationProperty.builder()
                                 .priority(123)
                                 .type("type")
                                 .build()))
                         .build())
                 .sqliMatchStatement(SqliMatchStatementProperty.builder()
                         .fieldToMatch(FieldToMatchProperty.builder()
                                 .allQueryArguments(allQueryArguments)
                                 .body(body)
                                 .jsonBody(JsonBodyProperty.builder()
                                         .matchPattern(JsonMatchPatternProperty.builder()
                                                 .all(all)
                                                 .includedPaths(List.of("includedPaths"))
                                                 .build())
                                         .matchScope("matchScope")
                                         // the properties below are optional
                                         .invalidFallbackBehavior("invalidFallbackBehavior")
                                         .build())
                                 .method(method)
                                 .queryString(queryString)
                                 .singleHeader(singleHeader)
                                 .singleQueryArgument(singleQueryArgument)
                                 .uriPath(uriPath)
                                 .build())
                         .textTransformations(List.of(TextTransformationProperty.builder()
                                 .priority(123)
                                 .type("type")
                                 .build()))
                         .build())
                 .xssMatchStatement(XssMatchStatementProperty.builder()
                         .fieldToMatch(FieldToMatchProperty.builder()
                                 .allQueryArguments(allQueryArguments)
                                 .body(body)
                                 .jsonBody(JsonBodyProperty.builder()
                                         .matchPattern(JsonMatchPatternProperty.builder()
                                                 .all(all)
                                                 .includedPaths(List.of("includedPaths"))
                                                 .build())
                                         .matchScope("matchScope")
                                         // the properties below are optional
                                         .invalidFallbackBehavior("invalidFallbackBehavior")
                                         .build())
                                 .method(method)
                                 .queryString(queryString)
                                 .singleHeader(singleHeader)
                                 .singleQueryArgument(singleQueryArgument)
                                 .uriPath(uriPath)
                                 .build())
                         .textTransformations(List.of(TextTransformationProperty.builder()
                                 .priority(123)
                                 .type("type")
                                 .build()))
                         .build())
                 .build())
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWebACL.ManagedRuleGroupStatementProperty.Builder A builder for CfnWebACL.ManagedRuleGroupStatementProperty
static class	CfnWebACL.ManagedRuleGroupStatementProperty.Jsii$Proxy An implementation for CfnWebACL.ManagedRuleGroupStatementProperty

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.ManagedRuleGroupStatementProperty.Builder	builder()
default Object	getExcludedRules() The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is configured in the rule.
default Object	getManagedRuleGroupConfigs() Additional information that's used by a managed rule group.
String	getName() The name of the managed rule group.
default Object	getScopeDownStatement() Statement nested inside a managed rule group statement to narrow the scope of the requests that AWS WAF evaluates using the rule group.
String	getVendorName() The name of the managed rule group vendor.
default String	getVersion() The version of the managed rule group to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the managed rule group.

You use this, along with the vendor name, to identify the rule group.

getVendorName

@Stability(value=Stable)
 @NotNull
String getVendorName()

The name of the managed rule group vendor.

You use this, along with the rule group name, to identify the rule group.

getExcludedRules

@Stability(value=Stable)
 @Nullable
default Object getExcludedRules()

The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is configured in the rule.

This effectively excludes the rule from acting on web requests.

getManagedRuleGroupConfigs

@Stability(value=Stable)
 @Nullable
default Object getManagedRuleGroupConfigs()

Additional information that's used by a managed rule group. Most managed rule groups don't require this.

Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet , to provide information about the sign-in page of your application.

You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField . The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath , PasswordField , PayloadType and UsernameField .

getScopeDownStatement

@Stability(value=Stable)
 @Nullable
default Object getScopeDownStatement()

Statement nested inside a managed rule group statement to narrow the scope of the requests that AWS WAF evaluates using the rule group.

Requests that match the scope-down statement are evaluated using the rule group. Requests that don't match the scope-down statement are not a match for the managed rule group statement, without any further evaluation.

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

The version of the managed rule group to use.

If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

builder

@Stability(value=Stable)
static CfnWebACL.ManagedRuleGroupStatementProperty.Builder builder()

Returns:

a CfnWebACL.ManagedRuleGroupStatementProperty.Builder of CfnWebACL.ManagedRuleGroupStatementProperty