amazonka-waf-regional-1.6.0: Amazon WAF Regional SDK.

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

Network.AWS.WAFRegional.UpdateIPSet

Contents

Description

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 .

Synopsis

Creating a Request

updateIPSet Source #

Creates a value of UpdateIPSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • uisIPSetId - The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets .
  • uisChangeToken - The value returned by the most recent call to GetChangeToken .
  • uisUpdates - 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

data UpdateIPSet Source #

See: updateIPSet smart constructor.

Instances

Eq UpdateIPSet Source # 
Data UpdateIPSet Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateIPSet -> c UpdateIPSet #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateIPSet #

toConstr :: UpdateIPSet -> Constr #

dataTypeOf :: UpdateIPSet -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateIPSet) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateIPSet) #

gmapT :: (forall b. Data b => b -> b) -> UpdateIPSet -> UpdateIPSet #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIPSet -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIPSet -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateIPSet -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateIPSet -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateIPSet -> m UpdateIPSet #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIPSet -> m UpdateIPSet #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIPSet -> m UpdateIPSet #

Read UpdateIPSet Source # 
Show UpdateIPSet Source # 
Generic UpdateIPSet Source # 

Associated Types

type Rep UpdateIPSet :: * -> * #

Hashable UpdateIPSet Source # 
ToJSON UpdateIPSet Source # 
NFData UpdateIPSet Source # 

Methods

rnf :: UpdateIPSet -> () #

AWSRequest UpdateIPSet Source # 
ToHeaders UpdateIPSet Source # 

Methods

toHeaders :: UpdateIPSet -> [Header] #

ToPath UpdateIPSet Source # 
ToQuery UpdateIPSet Source # 
type Rep UpdateIPSet Source # 
type Rep UpdateIPSet = D1 * (MetaData "UpdateIPSet" "Network.AWS.WAFRegional.UpdateIPSet" "amazonka-waf-regional-1.6.0-8hbXet7pAjcFZLYYuMOYQd" False) (C1 * (MetaCons "UpdateIPSet'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uisIPSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_uisChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_uisUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 IPSetUpdate))))))
type Rs UpdateIPSet Source # 

Request Lenses

uisIPSetId :: Lens' UpdateIPSet Text Source #

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

uisChangeToken :: Lens' UpdateIPSet Text Source #

The value returned by the most recent call to GetChangeToken .

uisUpdates :: 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

Destructuring the Response

updateIPSetResponse Source #

Creates a value of UpdateIPSetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • uisrsChangeToken - 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 .
  • uisrsResponseStatus - -- | The response status code.

data UpdateIPSetResponse Source #

See: updateIPSetResponse smart constructor.

Instances

Eq UpdateIPSetResponse Source # 
Data UpdateIPSetResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateIPSetResponse -> c UpdateIPSetResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateIPSetResponse #

toConstr :: UpdateIPSetResponse -> Constr #

dataTypeOf :: UpdateIPSetResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateIPSetResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateIPSetResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateIPSetResponse -> UpdateIPSetResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIPSetResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIPSetResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateIPSetResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateIPSetResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateIPSetResponse -> m UpdateIPSetResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIPSetResponse -> m UpdateIPSetResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIPSetResponse -> m UpdateIPSetResponse #

Read UpdateIPSetResponse Source # 
Show UpdateIPSetResponse Source # 
Generic UpdateIPSetResponse Source # 
NFData UpdateIPSetResponse Source # 

Methods

rnf :: UpdateIPSetResponse -> () #

type Rep UpdateIPSetResponse Source # 
type Rep UpdateIPSetResponse = D1 * (MetaData "UpdateIPSetResponse" "Network.AWS.WAFRegional.UpdateIPSet" "amazonka-waf-regional-1.6.0-8hbXet7pAjcFZLYYuMOYQd" False) (C1 * (MetaCons "UpdateIPSetResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uisrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uisrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

uisrsChangeToken :: 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 .

uisrsResponseStatus :: Lens' UpdateIPSetResponse Int Source #

  • - | The response status code.