Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateIPSet

Creates an IPSet, which you use 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 IPSet that lists those IP addresses.

Request Syntax


{
   "Addresses": [ "string" ],
   "Description": "string",
   "IPAddressVersion": "string",
   "Name": "string",
   "Scope": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Addresses

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.

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: .*\S.*

Required: Yes

Description

A description of the IP set that helps with identification.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$

Required: No

IPAddressVersion

The version of the IP addresses, either IPV4 or IPV6.

Type: String

Valid Values: IPV4 | IPV6

Required: Yes

Name

The name of the IP set. You cannot change the name of an IPSet after you create it.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[\w\-]+$

Required: Yes

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, an AWS App Runner service, or an AWS Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.

Type: String

Valid Values: CLOUDFRONT | REGIONAL

Required: Yes

Tags

An array of key:value pairs to associate with the resource.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

Response Syntax


{
   "Summary": { 
      "ARN": "string",
      "Description": "string",
      "Id": "string",
      "LockToken": "string",
      "Name": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Summary

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

Type: IPSetSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

WAFDuplicateItemException

AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

HTTP Status Code: 400

WAFInternalErrorException

Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

WAFInvalidOperationException

The operation isn't valid.

HTTP Status Code: 400

WAFInvalidParameterException

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

HTTP Status Code: 400

WAFLimitsExceededException

AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide.

HTTP Status Code: 400

WAFOptimisticLockException

AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

HTTP Status Code: 400

WAFTagOperationException

An error occurred during the tagging operation. Retry your request.

HTTP Status Code: 400

WAFTagOperationInternalErrorException

AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

HTTP Status Code: 500