Package software.amazon.awscdk.services.wafv2

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.wafv2.CfnRegexPatternSet
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IRegexPatternSetRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:31.458Z") @Stability(Stable) public class CfnRegexPatternSet extends CfnResource implements IInspectable, IRegexPatternSetRef, ITaggable

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 RegexPatternSet to have AWS WAF inspect a web request component for a specific set of regular expression patterns.

You use a regex pattern set by providing its Amazon Resource Name (ARN) to the rule statement RegexPatternSetReferenceStatement , when you add a rule to a rule group or web ACL.

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.*;
 CfnRegexPatternSet cfnRegexPatternSet = CfnRegexPatternSet.Builder.create(this, "MyCfnRegexPatternSet")
         .regularExpressionList(List.of("regularExpressionList"))
         .scope("scope")
         // the properties below are optional
         .description("description")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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::WAFv2::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

    • arnForRegexPatternSet

      @Stability(Stable) @NotNull public static String arnForRegexPatternSet(@NotNull IRegexPatternSetRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnRegexPatternSet

      @Stability(Stable) @NotNull public static Boolean isCfnRegexPatternSet(@NotNull Object x)
      Checks whether the given object is a CfnRegexPatternSet.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the regex pattern set.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the regex pattern set.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getRegularExpressionList

      @Stability(Stable) @NotNull public List<String> getRegularExpressionList()
      The regular expression patterns in the set.

    • setRegularExpressionList

      @Stability(Stable) public void setRegularExpressionList(@NotNull List<String> value)
      The regular expression patterns in the set.

    • getScope

      @Stability(Stable) @NotNull public String getScope()
      Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

    • setScope

      @Stability(Stable) public void setScope(@NotNull String value)
      Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the set that helps with identification.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the set that helps with identification.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the set.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the set.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key:value pairs associated with an AWS resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key:value pairs associated with an AWS resource.