AWS::WAFv2::RegexPatternSet
This is the latest version of AWS WAF, named AWS WAFV2, 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 AWS::WAFv2::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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::WAFv2::RegexPatternSet", "Properties" : { "Description" :
String
, "Name" :String
, "RegularExpressionList" :[ String, ... ]
, "Scope" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::WAFv2::RegexPatternSet Properties: Description:
String
Name:String
RegularExpressionList:- String
Scope:String
Tags:- Tag
Properties
Description
-
A description of the set that helps with identification.
Required: No
Type: String
Minimum:
1
Maximum:
256
Pattern:
^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$
Update requires: No interruption
Name
-
The name of the set. You cannot change the name after you create the set.
Required: No
Type: String
Minimum:
1
Maximum:
128
Pattern:
^[\w\-]+$
Update requires: Replacement
RegularExpressionList
-
The regular expression patterns in the set.
Required: Yes
Type: List of String
Update requires: No interruption
Scope
-
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
andREGIONAL
.Note For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.Required: Yes
Type: String
Update requires: Replacement
Tags
-
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.
Note 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.
Required: No
Type: List of Tag
Update requires: No interruption
Return values
Ref
The Ref
for the resource, containing the resource name, physical ID, and scope, formatted as follows: name|id|scope
.
For example: my-webacl-name|1234a1a-a1b1-12a1-abcd-a123b123456|REGIONAL
.
Fn::GetAtt
Examples
Create a regex pattern set
The following shows an example regex pattern set specification.
YAML
ExampleRegexPatternSet: Type: AWS::WAFv2::RegexPatternSet Properties: Name: ExampleRegexPatternSet Scope: REGIONAL Description: This is an example RegexPatternSet RegularExpressionList: - ^foobar$ - ^example$
JSON
"ExampleRegexPatternSet": { "Type": "AWS::WAFv2::RegexPatternSet", "Properties": { "Name": "ExampleRegexPatternSet1", "Scope": "REGIONAL", "Description": "This is an example RegexPatternSet", "RegularExpressionList": [ "^foobar$", "^example$" ] } }