Package software.amazon.awscdk.cfnpropertymixins.services.waf

Class CfnRulePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.waf.CfnRulePropsMixin

All Implemented Interfaces:

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

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

This is AWS WAF Classic documentation.

For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet , IPSet , and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

• An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
• A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot .

To match the settings in this Rule , a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.waf.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnRulePropsMixin cfnRulePropsMixin = CfnRulePropsMixin.Builder.create(CfnRuleMixinProps.builder()
         .metricName("metricName")
         .name("name")
         .predicates(List.of(PredicateProperty.builder()
                 .dataId("dataId")
                 .negated(false)
                 .type("type")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRulePropsMixin.Builder	A fluent builder for CfnRulePropsMixin.
static interface	CfnRulePropsMixin.PredicateProperty	Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

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
	CfnRulePropsMixin(CfnRuleMixinProps props)	Create a mixin to apply properties to AWS::WAF::Rule.
	CfnRulePropsMixin(CfnRuleMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::WAF::Rule.
protected	CfnRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRulePropsMixin(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 CfnRuleMixinProps	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

CfnRulePropsMixin

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

CfnRulePropsMixin

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

CfnRulePropsMixin

@Stability(Stable)
public CfnRulePropsMixin(@NotNull
 CfnRuleMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::WAF::Rule.

Parameters:

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

options - Mixin options.

CfnRulePropsMixin

@Stability(Stable)
public CfnRulePropsMixin(@NotNull
 CfnRuleMixinProps props)

Create a mixin to apply properties to AWS::WAF::Rule.

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 CfnRuleMixinProps getProps()

getStrategy

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