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.UpdateRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Inserts or deletes Predicate objects in a Rule . Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet , that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule , a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule :

A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule . For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

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

Create and update the predicates that you want to include in the Rule .
Create the Rule . See CreateRule .
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule .
Create and update a WebACL that contains the Rule . See CreateWebACL .

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one 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

updateRule :: Text -> Text -> UpdateRule
data UpdateRule
urRuleId :: Lens' UpdateRule Text
urChangeToken :: Lens' UpdateRule Text
urUpdates :: Lens' UpdateRule [RuleUpdate]
updateRuleResponse :: Int -> UpdateRuleResponse
data UpdateRuleResponse
urrsChangeToken :: Lens' UpdateRuleResponse (Maybe Text)
urrsResponseStatus :: Lens' UpdateRuleResponse Int

Creating a Request

updateRule #

Arguments

:: Text	`urRuleId`
-> Text	`urChangeToken`
-> UpdateRule

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

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

urRuleId - The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules .
urChangeToken - The value returned by the most recent call to GetChangeToken .
urUpdates - An array of RuleUpdate objects that you want to insert into or delete from a Rule . For more information, see the applicable data types: * RuleUpdate : Contains Action and Predicate * Predicate : Contains DataId , Negated , and Type * FieldToMatch : Contains Data and Type

data UpdateRule #

See: updateRule smart constructor.

Instances

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

Request Lenses

urRuleId :: Lens' UpdateRule Text #

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules .

urChangeToken :: Lens' UpdateRule Text #

The value returned by the most recent call to GetChangeToken .

urUpdates :: Lens' UpdateRule [RuleUpdate] #

An array of RuleUpdate objects that you want to insert into or delete from a Rule . For more information, see the applicable data types: * RuleUpdate : Contains Action and Predicate * Predicate : Contains DataId , Negated , and Type * FieldToMatch : Contains Data and Type

Destructuring the Response

updateRuleResponse #

Arguments

:: Int	`urrsResponseStatus`
-> UpdateRuleResponse

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

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

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

data UpdateRuleResponse #

See: updateRuleResponse smart constructor.

Instances

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

Response Lenses

urrsChangeToken :: Lens' UpdateRuleResponse (Maybe Text) #

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

urrsResponseStatus :: Lens' UpdateRuleResponse Int #

- | The response status code.