AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

  2. Submit a CreateIPSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateIPSet and EndCreateIPSet.

Namespace: Amazon.WAFRegional
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<CreateIPSetResponse> CreateIPSetAsync(
         String name,
         String changeToken,
         CancellationToken cancellationToken
)

Parameters

name
Type: System.String

A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

changeToken
Type: System.String

The value returned by the most recent call to GetChangeToken.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateIPSet service method, as returned by WAFRegional.

Exceptions

ExceptionCondition
WAFDisallowedNameException The name specified is invalid.
WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: You specified an invalid parameter name. You specified an invalid value. You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. You tried to create a WebACL with a DefaultActionType other than ALLOW, BLOCK, or COUNT. You tried to create a RateBasedRule with a RateKey value other than IP. You tried to update a WebACL with a WafActionType other than ALLOW, BLOCK, or COUNT. You tried to update a ByteMatchSet with a FieldToMatchType other than HEADER, METHOD, QUERY_STRING, URI, or BODY. You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also