amazonka-waf-1.4.3: gen/Network/AWS/WAF/CreateXSSMatchSet.hs
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TypeFamilies #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Network.AWS.WAF.CreateXSSMatchSet
-- Copyright : (c) 2013-2016 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Creates an < XssMatchSet>, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
--
-- To create and configure an 'XssMatchSet', perform the following steps:
--
-- 1. Use < GetChangeToken> to get the change token that you provide in the 'ChangeToken' parameter of a 'CreateXssMatchSet' request.
-- 2. Submit a 'CreateXssMatchSet' request.
-- 3. Use 'GetChangeToken' to get the change token that you provide in the 'ChangeToken' parameter of an < UpdateXssMatchSet> request.
-- 4. Submit an < UpdateXssMatchSet> request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.
--
-- For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <http://docs.aws.amazon.com/waf/latest/developerguide/ AWS WAF Developer Guide>.
module Network.AWS.WAF.CreateXSSMatchSet
(
-- * Creating a Request
createXSSMatchSet
, CreateXSSMatchSet
-- * Request Lenses
, cxmsName
, cxmsChangeToken
-- * Destructuring the Response
, createXSSMatchSetResponse
, CreateXSSMatchSetResponse
-- * Response Lenses
, cxmsrsXSSMatchSet
, cxmsrsChangeToken
, cxmsrsResponseStatus
) where
import Network.AWS.Lens
import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
import Network.AWS.WAF.Types
import Network.AWS.WAF.Types.Product
-- | A request to create an < XssMatchSet>.
--
-- /See:/ 'createXSSMatchSet' smart constructor.
data CreateXSSMatchSet = CreateXSSMatchSet'
{ _cxmsName :: !Text
, _cxmsChangeToken :: !Text
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'CreateXSSMatchSet' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'cxmsName'
--
-- * 'cxmsChangeToken'
createXSSMatchSet
:: Text -- ^ 'cxmsName'
-> Text -- ^ 'cxmsChangeToken'
-> CreateXSSMatchSet
createXSSMatchSet pName_ pChangeToken_ =
CreateXSSMatchSet'
{ _cxmsName = pName_
, _cxmsChangeToken = pChangeToken_
}
-- | A friendly name or description for the < XssMatchSet> that you\'re creating. You can\'t change 'Name' after you create the 'XssMatchSet'.
cxmsName :: Lens' CreateXSSMatchSet Text
cxmsName = lens _cxmsName (\ s a -> s{_cxmsName = a});
-- | The value returned by the most recent call to < GetChangeToken>.
cxmsChangeToken :: Lens' CreateXSSMatchSet Text
cxmsChangeToken = lens _cxmsChangeToken (\ s a -> s{_cxmsChangeToken = a});
instance AWSRequest CreateXSSMatchSet where
type Rs CreateXSSMatchSet = CreateXSSMatchSetResponse
request = postJSON waf
response
= receiveJSON
(\ s h x ->
CreateXSSMatchSetResponse' <$>
(x .?> "XssMatchSet") <*> (x .?> "ChangeToken") <*>
(pure (fromEnum s)))
instance Hashable CreateXSSMatchSet
instance NFData CreateXSSMatchSet
instance ToHeaders CreateXSSMatchSet where
toHeaders
= const
(mconcat
["X-Amz-Target" =#
("AWSWAF_20150824.CreateXssMatchSet" :: ByteString),
"Content-Type" =#
("application/x-amz-json-1.1" :: ByteString)])
instance ToJSON CreateXSSMatchSet where
toJSON CreateXSSMatchSet'{..}
= object
(catMaybes
[Just ("Name" .= _cxmsName),
Just ("ChangeToken" .= _cxmsChangeToken)])
instance ToPath CreateXSSMatchSet where
toPath = const "/"
instance ToQuery CreateXSSMatchSet where
toQuery = const mempty
-- | The response to a 'CreateXssMatchSet' request.
--
-- /See:/ 'createXSSMatchSetResponse' smart constructor.
data CreateXSSMatchSetResponse = CreateXSSMatchSetResponse'
{ _cxmsrsXSSMatchSet :: !(Maybe XSSMatchSet)
, _cxmsrsChangeToken :: !(Maybe Text)
, _cxmsrsResponseStatus :: !Int
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'CreateXSSMatchSetResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'cxmsrsXSSMatchSet'
--
-- * 'cxmsrsChangeToken'
--
-- * 'cxmsrsResponseStatus'
createXSSMatchSetResponse
:: Int -- ^ 'cxmsrsResponseStatus'
-> CreateXSSMatchSetResponse
createXSSMatchSetResponse pResponseStatus_ =
CreateXSSMatchSetResponse'
{ _cxmsrsXSSMatchSet = Nothing
, _cxmsrsChangeToken = Nothing
, _cxmsrsResponseStatus = pResponseStatus_
}
-- | An < XssMatchSet>.
cxmsrsXSSMatchSet :: Lens' CreateXSSMatchSetResponse (Maybe XSSMatchSet)
cxmsrsXSSMatchSet = lens _cxmsrsXSSMatchSet (\ s a -> s{_cxmsrsXSSMatchSet = a});
-- | The 'ChangeToken' that you used to submit the 'CreateXssMatchSet' request. You can also use this value to query the status of the request. For more information, see < GetChangeTokenStatus>.
cxmsrsChangeToken :: Lens' CreateXSSMatchSetResponse (Maybe Text)
cxmsrsChangeToken = lens _cxmsrsChangeToken (\ s a -> s{_cxmsrsChangeToken = a});
-- | The response status code.
cxmsrsResponseStatus :: Lens' CreateXSSMatchSetResponse Int
cxmsrsResponseStatus = lens _cxmsrsResponseStatus (\ s a -> s{_cxmsrsResponseStatus = a});
instance NFData CreateXSSMatchSetResponse