Package software.amazon.awscdk.services.wafv2

Class CfnRegexPatternSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.wafv2.CfnRegexPatternSet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.172Z") @Stability(Stable) public class CfnRegexPatternSet extends CfnResource implements IInspectable
A CloudFormation AWS::WAFv2::RegexPatternSet.

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();

  • 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 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 -
      • scoped id of the resource.
      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.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key:value pairs associated with an AWS resource.

      The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

      To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

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

      A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service. Valid Values are CLOUDFRONT and REGIONAL .

      For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

    • setScope

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

      A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service. Valid Values are CLOUDFRONT and REGIONAL .

      For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

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

      You cannot change the name after you create the set.

    • setName

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

      You cannot change the name after you create the set.