amazonka-waf-1.6.0: Amazon WAF 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.WAF.UpdateXSSMatchSet

Contents

Description

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet . For each XssMatchTuple object, you specify the following values:

  • Action : Whether to insert the object into or delete the object from the array. To change a XssMatchTuple , you delete the existing object and add a new one.
  • FieldToMatch : The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.
  • TextTransformation : Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

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

  • Submit a CreateXssMatchSet request.
  • Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
  • Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

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

updateXSSMatchSet #

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

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

  • uxmsXSSMatchSetId - The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets .
  • uxmsChangeToken - The value returned by the most recent call to GetChangeToken .
  • uxmsUpdates - An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet . For more information, see the applicable data types: * XssMatchSetUpdate : Contains Action and XssMatchTuple * XssMatchTuple : Contains FieldToMatch and TextTransformation * FieldToMatch : Contains Data and Type

data UpdateXSSMatchSet #

A request to update an XssMatchSet .

See: updateXSSMatchSet smart constructor.

Instances

Eq UpdateXSSMatchSet # 
Data UpdateXSSMatchSet # 

Methods

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

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

toConstr :: UpdateXSSMatchSet -> Constr #

dataTypeOf :: UpdateXSSMatchSet -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateXSSMatchSet # 
Show UpdateXSSMatchSet # 
Generic UpdateXSSMatchSet # 
Hashable UpdateXSSMatchSet # 
ToJSON UpdateXSSMatchSet # 
NFData UpdateXSSMatchSet # 

Methods

rnf :: UpdateXSSMatchSet -> () #

AWSRequest UpdateXSSMatchSet # 
ToHeaders UpdateXSSMatchSet # 
ToPath UpdateXSSMatchSet # 
ToQuery UpdateXSSMatchSet # 
type Rep UpdateXSSMatchSet # 
type Rep UpdateXSSMatchSet = D1 * (MetaData "UpdateXSSMatchSet" "Network.AWS.WAF.UpdateXSSMatchSet" "amazonka-waf-1.6.0-K7okww4xWnpBRydji27mKc" False) (C1 * (MetaCons "UpdateXSSMatchSet'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uxmsXSSMatchSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_uxmsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_uxmsUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 XSSMatchSetUpdate))))))
type Rs UpdateXSSMatchSet # 

Request Lenses

uxmsXSSMatchSetId :: Lens' UpdateXSSMatchSet Text #

The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets .

uxmsChangeToken :: Lens' UpdateXSSMatchSet Text #

The value returned by the most recent call to GetChangeToken .

uxmsUpdates :: Lens' UpdateXSSMatchSet (NonEmpty XSSMatchSetUpdate) #

An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet . For more information, see the applicable data types: * XssMatchSetUpdate : Contains Action and XssMatchTuple * XssMatchTuple : Contains FieldToMatch and TextTransformation * FieldToMatch : Contains Data and Type

Destructuring the Response

updateXSSMatchSetResponse #

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

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

  • uxmsrsChangeToken - The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .
  • uxmsrsResponseStatus - -- | The response status code.

data UpdateXSSMatchSetResponse #

The response to an UpdateXssMatchSets request.

See: updateXSSMatchSetResponse smart constructor.

Instances

Eq UpdateXSSMatchSetResponse # 
Data UpdateXSSMatchSetResponse # 

Methods

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

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

toConstr :: UpdateXSSMatchSetResponse -> Constr #

dataTypeOf :: UpdateXSSMatchSetResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateXSSMatchSetResponse # 
Show UpdateXSSMatchSetResponse # 
Generic UpdateXSSMatchSetResponse # 
NFData UpdateXSSMatchSetResponse # 
type Rep UpdateXSSMatchSetResponse # 
type Rep UpdateXSSMatchSetResponse = D1 * (MetaData "UpdateXSSMatchSetResponse" "Network.AWS.WAF.UpdateXSSMatchSet" "amazonka-waf-1.6.0-K7okww4xWnpBRydji27mKc" False) (C1 * (MetaCons "UpdateXSSMatchSetResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uxmsrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uxmsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

uxmsrsChangeToken :: Lens' UpdateXSSMatchSetResponse (Maybe Text) #

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

uxmsrsResponseStatus :: Lens' UpdateXSSMatchSetResponse Int #

  • - | The response status code.