Package software.amazon.awscdk.services.waf.regional

Class CfnRegexPatternSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.waf.regional.CfnRegexPatternSet

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IRegexPatternSetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:15.782Z")
@Stability(Stable)
public class CfnRegexPatternSet
extends CfnResource
implements IInspectable, IRegexPatternSetRef

The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t .

You can then configure AWS WAF to reject those requests.

Note that you can only create regex pattern sets using a AWS CloudFormation template. To add the regex pattern sets created through AWS CloudFormation to a RegexMatchSet, use the AWS WAF console, API, or command line interface (CLI). For more information, see UpdateRegexMatchSet .

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.waf.regional.*;
 CfnRegexPatternSet cfnRegexPatternSet = CfnRegexPatternSet.Builder.create(this, "MyCfnRegexPatternSet")
         .name("name")
         .regexPatternStrings(List.of("regexPatternStrings"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-regexpatternset.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRegexPatternSet.Builder	A fluent builder for CfnRegexPatternSet.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.regional.IRegexPatternSetRef

IRegexPatternSetRef.Jsii$Default, IRegexPatternSetRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnRegexPatternSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRegexPatternSet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnRegexPatternSet(software.constructs.Construct scope, String id, CfnRegexPatternSetProps props)	Create a new AWS::WAFRegional::RegexPatternSet.

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getName()	A friendly name or description of the RegexPatternSet .
RegexPatternSetReference	getRegexPatternSetRef()	A reference to a RegexPatternSet resource.
List<String>	getRegexPatternStrings()	Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t .
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value)	A friendly name or description of the RegexPatternSet .
void	setRegexPatternStrings(List<String> value)	Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnRegexPatternSet

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

CfnRegexPatternSet

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

CfnRegexPatternSet

@Stability(Stable)
public CfnRegexPatternSet(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnRegexPatternSetProps props)

Create a new AWS::WAFRegional::RegexPatternSet.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRegexPatternSetRef

@Stability(Stable)
@NotNull
public RegexPatternSetReference getRegexPatternSetRef()

A reference to a RegexPatternSet resource.

Specified by:

getRegexPatternSetRef in interface IRegexPatternSetRef

getName

@Stability(Stable)
@NotNull
public String getName()

A friendly name or description of the RegexPatternSet .

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

A friendly name or description of the RegexPatternSet .

getRegexPatternStrings

@Stability(Stable)
@NotNull
public List<String> getRegexPatternStrings()

Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t .

setRegexPatternStrings

@Stability(Stable)
public void setRegexPatternStrings(@NotNull
 List<String> value)

Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t .