Network.AWS.WAF.UpdateRule

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:

1. Create and update the predicates that you want to include in the Rule.
2. Create the Rule. See CreateRule.
3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
4. Submit an UpdateRule request to add predicates to the Rule.
5. 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.

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
• urChangeToken
• urUpdates

data UpdateRule

See: updateRule smart constructor.

Instances

Eq UpdateRule

Methods

(==) :: UpdateRule -> UpdateRule -> Bool

(/=) :: UpdateRule -> UpdateRule -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS UpdateRule

readList :: ReadS [UpdateRule]

readPrec :: ReadPrec UpdateRule

readListPrec :: ReadPrec [UpdateRule]

Show UpdateRule

Methods

showsPrec :: Int -> UpdateRule -> ShowS

show :: UpdateRule -> String

showList :: [UpdateRule] -> ShowS

Generic UpdateRule

Associated Types

type Rep UpdateRule :: * -> *

Methods

from :: UpdateRule -> Rep UpdateRule x

to :: Rep UpdateRule x -> UpdateRule

Hashable UpdateRule

Methods

hashWithSalt :: Int -> UpdateRule -> Int

hash :: UpdateRule -> Int

NFData UpdateRule

Methods

rnf :: UpdateRule -> ()

AWSRequest UpdateRule

Associated Types

type Rs UpdateRule :: *

Methods

request :: UpdateRule -> Request UpdateRule

response :: MonadResource m => Logger -> Service -> Proxy * UpdateRule -> ClientResponse -> m (Response UpdateRule)

ToPath UpdateRule

Methods

toPath :: UpdateRule -> ByteString

ToHeaders UpdateRule

Methods

toHeaders :: UpdateRule -> [Header]

ToQuery UpdateRule

Methods

toQuery :: UpdateRule -> QueryString

ToJSON UpdateRule

Methods

toJSON :: UpdateRule -> Value

toEncoding :: UpdateRule -> Encoding

type Rep UpdateRule

type Rep UpdateRule = D1 (MetaData "UpdateRule" "Network.AWS.WAF.UpdateRule" "amazonka-waf-1.4.4-K3x8K12pZOvBUcPz67So7N" False) (C1 (MetaCons "UpdateRule'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_urRuleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_urChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_urUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [RuleUpdate])))))

type Rs 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
• urrsResponseStatus

data UpdateRuleResponse

See: updateRuleResponse smart constructor.

Instances

Eq UpdateRuleResponse

Methods

(==) :: UpdateRuleResponse -> UpdateRuleResponse -> Bool

(/=) :: UpdateRuleResponse -> UpdateRuleResponse -> Bool

Data UpdateRuleResponse

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

Methods

readsPrec :: Int -> ReadS UpdateRuleResponse

readList :: ReadS [UpdateRuleResponse]

readPrec :: ReadPrec UpdateRuleResponse

readListPrec :: ReadPrec [UpdateRuleResponse]

Show UpdateRuleResponse

Methods

showsPrec :: Int -> UpdateRuleResponse -> ShowS

show :: UpdateRuleResponse -> String

showList :: [UpdateRuleResponse] -> ShowS

Generic UpdateRuleResponse

Associated Types

type Rep UpdateRuleResponse :: * -> *

Methods

from :: UpdateRuleResponse -> Rep UpdateRuleResponse x

to :: Rep UpdateRuleResponse x -> UpdateRuleResponse

NFData UpdateRuleResponse

Methods

rnf :: UpdateRuleResponse -> ()

type Rep UpdateRuleResponse

type Rep UpdateRuleResponse = D1 (MetaData "UpdateRuleResponse" "Network.AWS.WAF.UpdateRule" "amazonka-waf-1.4.4-K3x8K12pZOvBUcPz67So7N" False) (C1 (MetaCons "UpdateRuleResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_urrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_urrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.