WAF / Client / create_ip_set

create_ip_set¶

WAF.Client.create_ip_set(**kwargs)¶

Note

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:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
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.

Request Syntax

response = client.create_ip_set(
    Name='string',
    ChangeToken='string'
)

Parameters:

Name (string) –
[REQUIRED]

A friendly name or description of the IPSet. You can’t change Name after you create the IPSet.
ChangeToken (string) –
[REQUIRED]

The value returned by the most recent call to GetChangeToken.

Return type:

dict

Returns:

Response Syntax

{
    'IPSet': {
        'IPSetId': 'string',
        'Name': 'string',
        'IPSetDescriptors': [
            {
                'Type': 'IPV4'|'IPV6',
                'Value': 'string'
            },
        ]
    },
    'ChangeToken': 'string'
}

Response Structure

(dict) –
- IPSet (dict) –
  
  The IPSet returned in the CreateIPSet response.
  - IPSetId (string) –
    
    The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).
    
    IPSetId is returned by CreateIPSet and by ListIPSets.
  - Name (string) –
    
    A friendly name or description of the IPSet. You can’t change the name of an IPSet after you create it.
  - IPSetDescriptors (list) –
    
    The IP address type ( IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
    - (dict) –
      
      Note
      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.
      
      Specifies the IP address type ( IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.
      - Type (string) –
        
        Specify IPV4 or IPV6.
      - Value (string) –
        
        Specify an IPv4 address by using CIDR notation. For example:
        
        To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
        
        To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
        
        Specify an IPv6 address by using CIDR notation. For example:
        
        To configure AWS WAF to allow, block, or count 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.
        
        To configure AWS WAF to allow, block, or count 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.
- ChangeToken (string) –
  
  The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Exceptions

Examples

The following example creates an IP match set named MyIPSetFriendlyName.

response = client.create_ip_set(
    ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    Name='MyIPSetFriendlyName',
)

print(response)

Expected Output:

{
    'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'IPSet': {
        'IPSetDescriptors': [
            {
                'Type': 'IPV4',
                'Value': '192.0.2.44/32',
            },
        ],
        'IPSetId': 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'Name': 'MyIPSetFriendlyName',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}