Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.WAF.CreateByteMatchSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a ByteMatchSet . You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot . You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet , perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.
Submit a CreateByteMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value 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 .

Creating a Request

createByteMatchSet #

Arguments

:: Text	`cbmsName`
-> Text	`cbmsChangeToken`
-> CreateByteMatchSet

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

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

cbmsName - A friendly name or description of the ByteMatchSet . You can't change Name after you create a ByteMatchSet .
cbmsChangeToken - The value returned by the most recent call to GetChangeToken .

data CreateByteMatchSet #

See: createByteMatchSet smart constructor.

Instances

Eq CreateByteMatchSet #
Methods (==) :: CreateByteMatchSet -> CreateByteMatchSet -> Bool # (/=) :: CreateByteMatchSet -> CreateByteMatchSet -> Bool #
Data CreateByteMatchSet #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateByteMatchSet -> c CreateByteMatchSet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateByteMatchSet # toConstr :: CreateByteMatchSet -> Constr # dataTypeOf :: CreateByteMatchSet -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateByteMatchSet) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateByteMatchSet) # gmapT :: (forall b. Data b => b -> b) -> CreateByteMatchSet -> CreateByteMatchSet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateByteMatchSet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateByteMatchSet -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateByteMatchSet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateByteMatchSet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateByteMatchSet -> m CreateByteMatchSet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateByteMatchSet -> m CreateByteMatchSet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateByteMatchSet -> m CreateByteMatchSet #
Read CreateByteMatchSet #
Methods readsPrec :: Int -> ReadS CreateByteMatchSet # readList :: ReadS [CreateByteMatchSet] # readPrec :: ReadPrec CreateByteMatchSet # readListPrec :: ReadPrec [CreateByteMatchSet] #
Show CreateByteMatchSet #
Methods showsPrec :: Int -> CreateByteMatchSet -> ShowS # show :: CreateByteMatchSet -> String # showList :: [CreateByteMatchSet] -> ShowS #
Generic CreateByteMatchSet #
Associated Types type Rep CreateByteMatchSet :: * -> * # Methods from :: CreateByteMatchSet -> Rep CreateByteMatchSet x # to :: Rep CreateByteMatchSet x -> CreateByteMatchSet #
Hashable CreateByteMatchSet #
Methods hashWithSalt :: Int -> CreateByteMatchSet -> Int # hash :: CreateByteMatchSet -> Int #
ToJSON CreateByteMatchSet #
Methods toJSON :: CreateByteMatchSet -> Value # toEncoding :: CreateByteMatchSet -> Encoding # toJSONList :: [CreateByteMatchSet] -> Value # toEncodingList :: [CreateByteMatchSet] -> Encoding #
NFData CreateByteMatchSet #
Methods rnf :: CreateByteMatchSet -> () #
AWSRequest CreateByteMatchSet #
Associated Types type Rs CreateByteMatchSet :: * # Methods request :: CreateByteMatchSet -> Request CreateByteMatchSet # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateByteMatchSet -> ClientResponse -> m (Response CreateByteMatchSet) #
ToHeaders CreateByteMatchSet #
Methods toHeaders :: CreateByteMatchSet -> [Header] #
ToPath CreateByteMatchSet #
Methods toPath :: CreateByteMatchSet -> ByteString #
ToQuery CreateByteMatchSet #
Methods toQuery :: CreateByteMatchSet -> QueryString #
type Rep CreateByteMatchSet #
type Rep CreateByteMatchSet = D1 * (MetaData "CreateByteMatchSet" "Network.AWS.WAF.CreateByteMatchSet" "amazonka-waf-1.6.0-K7okww4xWnpBRydji27mKc" False) (C1 * (MetaCons "CreateByteMatchSet'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_cbmsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cbmsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs CreateByteMatchSet #
type Rs CreateByteMatchSet = CreateByteMatchSetResponse

Request Lenses

cbmsName :: Lens' CreateByteMatchSet Text #

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

cbmsChangeToken :: Lens' CreateByteMatchSet Text #

The value returned by the most recent call to GetChangeToken .

Destructuring the Response

createByteMatchSetResponse #

Arguments

:: Int	`cbmsrsResponseStatus`
-> CreateByteMatchSetResponse

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

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

cbmsrsByteMatchSet - A ByteMatchSet that contains no ByteMatchTuple objects.
cbmsrsChangeToken - The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .
cbmsrsResponseStatus - -- | The response status code.

data CreateByteMatchSetResponse #

See: createByteMatchSetResponse smart constructor.

Instances

Eq CreateByteMatchSetResponse #
Methods (==) :: CreateByteMatchSetResponse -> CreateByteMatchSetResponse -> Bool # (/=) :: CreateByteMatchSetResponse -> CreateByteMatchSetResponse -> Bool #
Data CreateByteMatchSetResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateByteMatchSetResponse -> c CreateByteMatchSetResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateByteMatchSetResponse # toConstr :: CreateByteMatchSetResponse -> Constr # dataTypeOf :: CreateByteMatchSetResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateByteMatchSetResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateByteMatchSetResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateByteMatchSetResponse -> CreateByteMatchSetResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateByteMatchSetResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateByteMatchSetResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateByteMatchSetResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateByteMatchSetResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateByteMatchSetResponse -> m CreateByteMatchSetResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateByteMatchSetResponse -> m CreateByteMatchSetResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateByteMatchSetResponse -> m CreateByteMatchSetResponse #
Read CreateByteMatchSetResponse #
Methods readsPrec :: Int -> ReadS CreateByteMatchSetResponse # readList :: ReadS [CreateByteMatchSetResponse] # readPrec :: ReadPrec CreateByteMatchSetResponse # readListPrec :: ReadPrec [CreateByteMatchSetResponse] #
Show CreateByteMatchSetResponse #
Methods showsPrec :: Int -> CreateByteMatchSetResponse -> ShowS # show :: CreateByteMatchSetResponse -> String # showList :: [CreateByteMatchSetResponse] -> ShowS #
Generic CreateByteMatchSetResponse #
Associated Types type Rep CreateByteMatchSetResponse :: * -> * # Methods from :: CreateByteMatchSetResponse -> Rep CreateByteMatchSetResponse x # to :: Rep CreateByteMatchSetResponse x -> CreateByteMatchSetResponse #
NFData CreateByteMatchSetResponse #
Methods rnf :: CreateByteMatchSetResponse -> () #
type Rep CreateByteMatchSetResponse #
type Rep CreateByteMatchSetResponse = D1 * (MetaData "CreateByteMatchSetResponse" "Network.AWS.WAF.CreateByteMatchSet" "amazonka-waf-1.6.0-K7okww4xWnpBRydji27mKc" False) (C1 * (MetaCons "CreateByteMatchSetResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_cbmsrsByteMatchSet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ByteMatchSet))) ((::) (S1 * (MetaSel (Just Symbol "_cbmsrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbmsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

cbmsrsByteMatchSet :: Lens' CreateByteMatchSetResponse (Maybe ByteMatchSet) #

A ByteMatchSet that contains no ByteMatchTuple objects.

cbmsrsChangeToken :: Lens' CreateByteMatchSetResponse (Maybe Text) #

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

cbmsrsResponseStatus :: Lens' CreateByteMatchSetResponse Int #

- | The response status code.