This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::WAFv2::RegexPatternSet
<a name="aws-resource-wafv2-regexpatternset"></a>

**Note**  
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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). 

Use an [AWS::WAFv2::RegexPatternSet](#aws-resource-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
<a name="aws-resource-wafv2-regexpatternset-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-wafv2-regexpatternset-syntax.json"></a>

```
{
  "Type" : "AWS::WAFv2::RegexPatternSet",
  "Properties" : {
      "[Description](#cfn-wafv2-regexpatternset-description)" : String,
      "[Name](#cfn-wafv2-regexpatternset-name)" : String,
      "[RegularExpressionList](#cfn-wafv2-regexpatternset-regularexpressionlist)" : [ String, ... ],
      "[Scope](#cfn-wafv2-regexpatternset-scope)" : String,
      "[Tags](#cfn-wafv2-regexpatternset-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-wafv2-regexpatternset-syntax.yaml"></a>

```
Type: AWS::WAFv2::RegexPatternSet
Properties:
  [Description](#cfn-wafv2-regexpatternset-description): String
  [Name](#cfn-wafv2-regexpatternset-name): String
  [RegularExpressionList](#cfn-wafv2-regexpatternset-regularexpressionlist): 
    - String
  [Scope](#cfn-wafv2-regexpatternset-scope): String
  [Tags](#cfn-wafv2-regexpatternset-tags): 
    - Tag
```

## Properties
<a name="aws-resource-wafv2-regexpatternset-properties"></a>

`Description`  <a name="cfn-wafv2-regexpatternset-description"></a>
A description of the set that helps with identification.   
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9=:#@/\-,.][a-zA-Z0-9+=:#@/\-,.\s]+[a-zA-Z0-9+=:#@/\-,.]{1,256}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-wafv2-regexpatternset-name"></a>
The name of the set. You cannot change the name after you create the set.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9A-Za-z_-]{1,128}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RegularExpressionList`  <a name="cfn-wafv2-regexpatternset-regularexpressionlist"></a>
The regular expression patterns in the set.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Scope`  <a name="cfn-wafv2-regexpatternset-scope"></a>
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. For an AWS Amplify application, use `CLOUDFRONT`. 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, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are `CLOUDFRONT` and `REGIONAL`.  
For `CLOUDFRONT`, you must create your WAFv2 resources in the US East (N. Virginia) Region, `us-east-1`.
*Required*: Yes  
*Type*: String  
*Allowed values*: `CLOUDFRONT | REGIONAL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-wafv2-regexpatternset-tags"></a>
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. 
*Required*: No  
*Type*: Array of [Tag](aws-properties-wafv2-regexpatternset-tag.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-wafv2-regexpatternset-return-values"></a>

### Ref
<a name="aws-resource-wafv2-regexpatternset-return-values-ref"></a>

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
<a name="aws-resource-wafv2-regexpatternset-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-wafv2-regexpatternset-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the regex pattern set.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the regex pattern set.

## Examples
<a name="aws-resource-wafv2-regexpatternset--examples"></a>



### Create a regex pattern set
<a name="aws-resource-wafv2-regexpatternset--examples--Create_a_regex_pattern_set"></a>

The following shows an example regex pattern set specification. 

#### YAML
<a name="aws-resource-wafv2-regexpatternset--examples--Create_a_regex_pattern_set--yaml"></a>

```
 ExampleRegexPatternSet:
    Type: AWS::WAFv2::RegexPatternSet
    Properties:
      Name: ExampleRegexPatternSet
      Scope: REGIONAL
      Description: This is an example RegexPatternSet
      RegularExpressionList:
        - ^foobar$
        - ^example$
```

#### JSON
<a name="aws-resource-wafv2-regexpatternset--examples--Create_a_regex_pattern_set--json"></a>

```
 "ExampleRegexPatternSet": {
      "Type": "AWS::WAFv2::RegexPatternSet",
      "Properties": {
        "Name": "ExampleRegexPatternSet1",
        "Scope": "REGIONAL",
        "Description": "This is an example RegexPatternSet",
        "RegularExpressionList": [
          "^foobar$",
          "^example$"
        ]
      }
    }
```

# AWS::WAFv2::RegexPatternSet Tag
<a name="aws-properties-wafv2-regexpatternset-tag"></a>

A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. 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". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. 

## Syntax
<a name="aws-properties-wafv2-regexpatternset-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-wafv2-regexpatternset-tag-syntax.json"></a>

```
{
  "[Key](#cfn-wafv2-regexpatternset-tag-key)" : String,
  "[Value](#cfn-wafv2-regexpatternset-tag-value)" : String
}
```

### YAML
<a name="aws-properties-wafv2-regexpatternset-tag-syntax.yaml"></a>

```
  [Key](#cfn-wafv2-regexpatternset-tag-key): String
  [Value](#cfn-wafv2-regexpatternset-tag-value): String
```

## Properties
<a name="aws-properties-wafv2-regexpatternset-tag-properties"></a>

`Key`  <a name="cfn-wafv2-regexpatternset-tag-key"></a>
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-wafv2-regexpatternset-tag-value"></a>
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)