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::IPSet
<a name="aws-resource-wafv2-ipset"></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::IPSet](#aws-resource-wafv2-ipset) to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IP set that lists those IP addresses. 

You use an IP set by providing its Amazon Resource Name (ARN) to the rule statement `IPSetReferenceStatement`, when you add a rule to a rule group or web ACL. 

## Syntax
<a name="aws-resource-wafv2-ipset-syntax"></a>

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

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

```
{
  "Type" : "AWS::WAFv2::IPSet",
  "Properties" : {
      "[Addresses](#cfn-wafv2-ipset-addresses)" : [ String, ... ],
      "[Description](#cfn-wafv2-ipset-description)" : String,
      "[IPAddressVersion](#cfn-wafv2-ipset-ipaddressversion)" : String,
      "[Name](#cfn-wafv2-ipset-name)" : String,
      "[Scope](#cfn-wafv2-ipset-scope)" : String,
      "[Tags](#cfn-wafv2-ipset-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::WAFv2::IPSet
Properties:
  [Addresses](#cfn-wafv2-ipset-addresses): 
    - String
  [Description](#cfn-wafv2-ipset-description): String
  [IPAddressVersion](#cfn-wafv2-ipset-ipaddressversion): String
  [Name](#cfn-wafv2-ipset-name): String
  [Scope](#cfn-wafv2-ipset-scope): String
  [Tags](#cfn-wafv2-ipset-tags): 
    - Tag
```

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

`Addresses`  <a name="cfn-wafv2-ipset-addresses"></a>
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for `/0`.   
Example address strings:   
+ For requests that originated from the IP address 192.0.2.44, specify `192.0.2.44/32`.
+ For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24`.
+ For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`.
+ For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`.
For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).  
Example JSON `Addresses` specifications:   
+ Empty array: `"Addresses": []`
+ Array with one address: `"Addresses": ["192.0.2.44/32"]`
+ Array with three addresses: `"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]`
+ INVALID specification: `"Addresses": [""]` INVALID 
*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)

`Description`  <a name="cfn-wafv2-ipset-description"></a>
A description of the IP 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)

`IPAddressVersion`  <a name="cfn-wafv2-ipset-ipaddressversion"></a>
The version of the IP addresses, either `IPV4` or `IPV6`.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `IPV4 | IPV6`  
*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-ipset-name"></a>
The name of the IP set. You cannot change the name of an `IPSet` after you create it.  
*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)

`Scope`  <a name="cfn-wafv2-ipset-scope"></a>
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, 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-ipset-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-ipset-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-ipset-return-values"></a>

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

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

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

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



### Create an IP set
<a name="aws-resource-wafv2-ipset--examples--Create_an_IP_set"></a>

The following shows an example IP set specification. 

#### YAML
<a name="aws-resource-wafv2-ipset--examples--Create_an_IP_set--yaml"></a>

```
 SampleIPSet:
      Type: 'AWS::WAFv2::IPSet'
      Properties:
        Description: SampleIPSet
        Name: SampleIPSet
        Scope: REGIONAL
        IPAddressVersion: IPV4
        Addresses:
          - 1.2.1.1/32
```

#### JSON
<a name="aws-resource-wafv2-ipset--examples--Create_an_IP_set--json"></a>

```
 "SampleIPSet": {
      "Type": "AWS::WAFv2::IPSet",
      "Properties": {
        "Description": "SampleIPSet",
        "Name": "SampleIPSSet",
        "Scope": "REGIONAL",
        "IPAddressVersion": "IPV4",
        "Addresses": [
          "1.2.1.1/32"
        ]
      }
    }
```

# AWS::WAFv2::IPSet Tag
<a name="aws-properties-wafv2-ipset-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-ipset-tag-syntax"></a>

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

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

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

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

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

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

`Key`  <a name="cfn-wafv2-ipset-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-ipset-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)