AWS WAF

2016/10/06 - AWS WAF - 3 updated api methods

CreateIPSet (updated) Link ¶
Changes (response) 
{'IPSet': {'IPSetDescriptors': {'Type': {'IPV6'}}}}

Creates an IPSet, which you use to specify which web requests 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

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

string

param Name

[REQUIRED]

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

type ChangeToken

string

param ChangeToken

[REQUIRED]

The value returned by the most recent call to GetChangeToken.

rtype

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, this is the value of one of the following fields in CloudFront access logs:

        • c-ip , if the viewer did not use an HTTP proxy or a load balancer to send the request

        • x-forwarded-for , if the viewer did use an HTTP proxy or a load balancer to send the request

        • (dict) --

          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.

GetIPSet (updated) Link ¶
Changes (response) 
{'IPSet': {'IPSetDescriptors': {'Type': {'IPV6'}}}}

Returns the IPSet that is specified by IPSetId .

Request Syntax

client.get_ip_set(
    IPSetId='string'
)
type IPSetId

string

param IPSetId

[REQUIRED]

The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • IPSet (dict) --

      Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

      • IPSet: Contains IPSetDescriptors , IPSetId , and Name

      • IPSetDescriptors : Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

      • 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, this is the value of one of the following fields in CloudFront access logs:

        • c-ip , if the viewer did not use an HTTP proxy or a load balancer to send the request

        • x-forwarded-for , if the viewer did use an HTTP proxy or a load balancer to send the request

        • (dict) --

          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 .

UpdateIPSet (updated) Link ¶
Changes (request) 
{'Updates': {'IPSetDescriptor': {'Type': {'IPV6'}}}}

Inserts or deletes IPSetDescriptor objects in an IPSet . For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6 .

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255 ) or 192.0.2.44/32 (for the individual IP address 192.0.2.44 ).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

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

  • 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.

When you update an IPSet , you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

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

client.update_ip_set(
    IPSetId='string',
    ChangeToken='string',
    Updates=[
        {
            'Action': 'INSERT'|'DELETE',
            'IPSetDescriptor': {
                'Type': 'IPV4'|'IPV6',
                'Value': 'string'
            }
        },
    ]
)
type IPSetId

string

param IPSetId

[REQUIRED]

The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

type ChangeToken

string

param ChangeToken

[REQUIRED]

The value returned by the most recent call to GetChangeToken.

type Updates

list

param Updates

[REQUIRED]

An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

  • IPSetUpdate: Contains Action and IPSetDescriptor

  • IPSetDescriptor: Contains Type and Value

  • (dict) --

    Specifies the type of update to perform to an IPSet with UpdateIPSet.

    • Action (string) -- [REQUIRED]

      Specifies whether to insert or delete an IP address with UpdateIPSet.

    • IPSetDescriptor (dict) -- [REQUIRED]

      The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) that web requests originate from.

      • Type (string) -- [REQUIRED]

        Specify IPV4 or IPV6 .

      • Value (string) -- [REQUIRED]

        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 .

rtype

dict

returns

Response Syntax

{
    'ChangeToken': 'string'
}

Response Structure

  • (dict) --

    • ChangeToken (string) --

      The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.