Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Class CfnRuleGroupPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnRuleGroupPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.055Z")
@Stability(Stable)
public class CfnRuleGroupPropsMixin
extends Mixin
implements software.constructs.IMixin

This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

Use an RuleGroup to define a collection of rules for inspecting and controlling web requests. You use a rule group in an WebACL by providing its Amazon Resource Name (ARN) to the rule statement RuleGroupReferenceStatement , when you add rules to the web ACL.

When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Example:

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnRuleGroupPropsMixin.AndStatementProperty	A logical rule statement used to combine other rule statements with AND logic.
static interface	CfnRuleGroupPropsMixin.AsnMatchStatementProperty	A rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.
static interface	CfnRuleGroupPropsMixin.BodyProperty	Inspect the body of the web request.
static final class	CfnRuleGroupPropsMixin.Builder	A fluent builder for CfnRuleGroupPropsMixin.
static interface	CfnRuleGroupPropsMixin.ByteMatchStatementProperty	A rule statement that defines a string match search for AWS WAF to apply to web requests.
static interface	CfnRuleGroupPropsMixin.CaptchaConfigProperty	Specifies how AWS WAF should handle CAPTCHA evaluations.
static interface	CfnRuleGroupPropsMixin.ChallengeConfigProperty	Specifies how AWS WAF should handle Challenge evaluations.
static interface	CfnRuleGroupPropsMixin.CookieMatchPatternProperty	The filter to use to identify the subset of cookies to inspect in a web request.
static interface	CfnRuleGroupPropsMixin.CookiesProperty	Inspect the cookies in the web request.
static interface	CfnRuleGroupPropsMixin.CustomResponseBodyProperty	The response body to use in a custom response to a web request.
static interface	CfnRuleGroupPropsMixin.FieldToMatchProperty	Specifies a web request component to be used in a rule match statement or in a logging configuration.
static interface	CfnRuleGroupPropsMixin.ForwardedIPConfigurationProperty	The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin.
static interface	CfnRuleGroupPropsMixin.GeoMatchStatementProperty	A rule statement that labels web requests by country and region and that matches against web requests based on country code.
static interface	CfnRuleGroupPropsMixin.HeaderMatchPatternProperty	The filter to use to identify the subset of headers to inspect in a web request.
static interface	CfnRuleGroupPropsMixin.HeaderOrderProperty	The string containing the list of a web request's header names, ordered as they appear in the web request, separated by colons.
static interface	CfnRuleGroupPropsMixin.HeadersProperty	Inspect all headers in the web request.
static interface	CfnRuleGroupPropsMixin.ImmunityTimePropertyProperty	Used for CAPTCHA and challenge token settings.
static interface	CfnRuleGroupPropsMixin.IPSetForwardedIPConfigurationProperty	The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin.
static interface	CfnRuleGroupPropsMixin.IPSetReferenceStatementProperty	A rule statement used to detect web requests coming from particular IP addresses or address ranges.
static interface	CfnRuleGroupPropsMixin.JA3FingerprintProperty	Available for use with Amazon CloudFront distributions and Application Load Balancers.
static interface	CfnRuleGroupPropsMixin.JA4FingerprintProperty	Available for use with Amazon CloudFront distributions and Application Load Balancers.
static interface	CfnRuleGroupPropsMixin.JsonBodyProperty	Inspect the body of the web request as JSON.
static interface	CfnRuleGroupPropsMixin.JsonMatchPatternProperty	The patterns to look for in the JSON body.
static interface	CfnRuleGroupPropsMixin.LabelMatchStatementProperty	A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.
static interface	CfnRuleGroupPropsMixin.LabelProperty	A single label container.
static interface	CfnRuleGroupPropsMixin.LabelSummaryProperty	List of labels used by one or more of the rules of a RuleGroup .
static interface	CfnRuleGroupPropsMixin.NotStatementProperty	A logical rule statement used to negate the results of another rule statement.
static interface	CfnRuleGroupPropsMixin.OrStatementProperty	A logical rule statement used to combine other rule statements with OR logic.
static interface	CfnRuleGroupPropsMixin.RateBasedStatementCustomKeyProperty	Specifies a single custom aggregate key for a rate-base rule.
static interface	CfnRuleGroupPropsMixin.RateBasedStatementProperty	A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate.
static interface	CfnRuleGroupPropsMixin.RateLimitCookieProperty	Specifies a cookie as an aggregate key for a rate-based rule.
static interface	CfnRuleGroupPropsMixin.RateLimitHeaderProperty	Specifies a header as an aggregate key for a rate-based rule.
static interface	CfnRuleGroupPropsMixin.RateLimitJA3FingerprintProperty	Use the request's JA3 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key.
static interface	CfnRuleGroupPropsMixin.RateLimitJA4FingerprintProperty	Use the request's JA4 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key.
static interface	CfnRuleGroupPropsMixin.RateLimitLabelNamespaceProperty	Specifies a label namespace to use as an aggregate key for a rate-based rule.
static interface	CfnRuleGroupPropsMixin.RateLimitQueryArgumentProperty	Specifies a query argument in the request as an aggregate key for a rate-based rule.
static interface	CfnRuleGroupPropsMixin.RateLimitQueryStringProperty	Specifies the request's query string as an aggregate key for a rate-based rule.
static interface	CfnRuleGroupPropsMixin.RateLimitUriPathProperty	Specifies the request's URI path as an aggregate key for a rate-based rule.
static interface	CfnRuleGroupPropsMixin.RegexMatchStatementProperty	A rule statement used to search web request components for a match against a single regular expression.
static interface	CfnRuleGroupPropsMixin.RegexPatternSetReferenceStatementProperty	A rule statement used to search web request components for matches with regular expressions.
static interface	CfnRuleGroupPropsMixin.RuleActionProperty	The action that AWS WAF should take on a web request when it matches a rule's statement.
static interface	CfnRuleGroupPropsMixin.RuleProperty	A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way.
static interface	CfnRuleGroupPropsMixin.SizeConstraintStatementProperty	A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<).
static interface	CfnRuleGroupPropsMixin.SqliMatchStatementProperty	A rule statement that inspects for malicious SQL code.
static interface	CfnRuleGroupPropsMixin.StatementProperty	The processing guidance for a rule, used by AWS WAF to determine whether a web request matches the rule.
static interface	CfnRuleGroupPropsMixin.TextTransformationProperty	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
static interface	CfnRuleGroupPropsMixin.UriFragmentProperty	Inspect fragments of the request URI.
static interface	CfnRuleGroupPropsMixin.VisibilityConfigProperty	Defines and enables Amazon CloudWatch metrics and web request sample collection.
static interface	CfnRuleGroupPropsMixin.XssMatchStatementProperty	A rule statement that inspects for cross-site scripting (XSS) attacks.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnRuleGroupPropsMixin(CfnRuleGroupMixinProps props)	Create a mixin to apply properties to AWS::WAFv2::RuleGroup.
	CfnRuleGroupPropsMixin(CfnRuleGroupMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::WAFv2::RuleGroup.
protected	CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnRuleGroupMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnRuleGroupPropsMixin

protected CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnRuleGroupPropsMixin

protected CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRuleGroupPropsMixin

@Stability(Stable)
public CfnRuleGroupPropsMixin(@NotNull
 CfnRuleGroupMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::WAFv2::RuleGroup.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnRuleGroupPropsMixin

@Stability(Stable)
public CfnRuleGroupPropsMixin(@NotNull
 CfnRuleGroupMixinProps props)

Create a mixin to apply properties to AWS::WAFv2::RuleGroup.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnRuleGroupMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()