libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.UpdateIPSet

Description

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.

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 IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. 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:

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

You can insert a maximum of 1000 addresses in a single request.

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

Synopsis

Creating a Request

data UpdateIPSet Source #

See: newUpdateIPSet smart constructor.

Constructors

UpdateIPSet' 

Fields

  • iPSetId :: Text

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

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

  • updates :: NonEmpty IPSetUpdate

    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

    You can insert a maximum of 1000 addresses in a single request.

Instances

Instances details
Eq UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

(==) :: UpdateIPSet -> UpdateIPSet -> Bool #

(/=) :: UpdateIPSet -> UpdateIPSet -> Bool #

Read UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

readsPrec :: Int -> ReadS UpdateIPSet #

readList :: ReadS [UpdateIPSet] #

readPrec :: ReadPrec UpdateIPSet #

readListPrec :: ReadPrec [UpdateIPSet] #

Show UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

showsPrec :: Int -> UpdateIPSet -> ShowS #

show :: UpdateIPSet -> String #

showList :: [UpdateIPSet] -> ShowS #

Generic UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Associated Types

type Rep UpdateIPSet :: Type -> Type #

Methods

from :: UpdateIPSet -> Rep UpdateIPSet x #

to :: Rep UpdateIPSet x -> UpdateIPSet #

NFData UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

rnf :: UpdateIPSet -> () #

Hashable UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

hashWithSalt :: Int -> UpdateIPSet -> Int #

hash :: UpdateIPSet -> Int #

ToJSON UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

toJSON :: UpdateIPSet -> Value #

toEncoding :: UpdateIPSet -> Encoding #

toJSONList :: [UpdateIPSet] -> Value #

toEncodingList :: [UpdateIPSet] -> Encoding #

AWSRequest UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Associated Types

type AWSResponse UpdateIPSet #

Methods

request :: UpdateIPSet -> Request UpdateIPSet #

response :: MonadResource m => Logger -> Service -> Proxy UpdateIPSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateIPSet))) #

ToHeaders UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

toHeaders :: UpdateIPSet -> [Header] #

ToPath UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

toPath :: UpdateIPSet -> ByteString #

ToQuery UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

toQuery :: UpdateIPSet -> QueryString #

type Rep UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

type Rep UpdateIPSet = D1 ('MetaData "UpdateIPSet" "Amazonka.WAF.UpdateIPSet" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "UpdateIPSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "iPSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty IPSetUpdate)))))
type AWSResponse UpdateIPSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

type AWSResponse UpdateIPSet = UpdateIPSetResponse

newUpdateIPSet Source #

Arguments

:: Text

$sel:iPSetId:UpdateIPSet'

-> Text

$sel:changeToken:UpdateIPSet'

-> NonEmpty IPSetUpdate

$sel:updates:UpdateIPSet'

-> UpdateIPSet 

Create a value of UpdateIPSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:iPSetId:UpdateIPSet', updateIPSet_iPSetId - The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

$sel:changeToken:UpdateIPSet', updateIPSet_changeToken - The value returned by the most recent call to GetChangeToken.

$sel:updates:UpdateIPSet', updateIPSet_updates - 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

You can insert a maximum of 1000 addresses in a single request.

Request Lenses

updateIPSet_iPSetId :: Lens' UpdateIPSet Text Source #

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

updateIPSet_changeToken :: Lens' UpdateIPSet Text Source #

The value returned by the most recent call to GetChangeToken.

updateIPSet_updates :: Lens' UpdateIPSet (NonEmpty IPSetUpdate) Source #

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

You can insert a maximum of 1000 addresses in a single request.

Destructuring the Response

data UpdateIPSetResponse Source #

See: newUpdateIPSetResponse smart constructor.

Constructors

UpdateIPSetResponse' 

Fields

  • changeToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq UpdateIPSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

(==) :: UpdateIPSetResponse -> UpdateIPSetResponse -> Bool #

(/=) :: UpdateIPSetResponse -> UpdateIPSetResponse -> Bool #

Read UpdateIPSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

readsPrec :: Int -> ReadS UpdateIPSetResponse #

readList :: ReadS [UpdateIPSetResponse] #

readPrec :: ReadPrec UpdateIPSetResponse #

readListPrec :: ReadPrec [UpdateIPSetResponse] #

Show UpdateIPSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

showsPrec :: Int -> UpdateIPSetResponse -> ShowS #

show :: UpdateIPSetResponse -> String #

showList :: [UpdateIPSetResponse] -> ShowS #

Generic UpdateIPSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Associated Types

type Rep UpdateIPSetResponse :: Type -> Type #

Methods

from :: UpdateIPSetResponse -> Rep UpdateIPSetResponse x #

to :: Rep UpdateIPSetResponse x -> UpdateIPSetResponse #

NFData UpdateIPSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

Methods

rnf :: UpdateIPSetResponse -> () #

type Rep UpdateIPSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateIPSet

type Rep UpdateIPSetResponse = D1 ('MetaData "UpdateIPSetResponse" "Amazonka.WAF.UpdateIPSet" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "UpdateIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateIPSetResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateIPSetResponse'

-> UpdateIPSetResponse 

Create a value of UpdateIPSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:changeToken:UpdateIPSet', updateIPSetResponse_changeToken - 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.

$sel:httpStatus:UpdateIPSetResponse', updateIPSetResponse_httpStatus - The response's http status code.

Response Lenses

updateIPSetResponse_changeToken :: Lens' UpdateIPSetResponse (Maybe Text) Source #

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.

updateIPSetResponse_httpStatus :: Lens' UpdateIPSetResponse Int Source #

The response's http status code.