Network.AWS.WAF.UpdateRateBasedRule

Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet , that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

If you add more than one predicate to a RateBasedRule , a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule :

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

Further, you specify a RateLimit of 15,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot . Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule :

• A ByteMatchSet with FieldToMatch of URI
• A PositionalConstraint of STARTS_WITH
• A TargetString of login

Further, you specify a RateLimit of 15,000.

By adding this RateBasedRule to a WebACL , you could limit requests to your login page without affecting the rest of your site.

Creating a Request

updateRateBasedRule

Arguments

:: Text

urbrRuleId

-> Text

urbrChangeToken

-> Natural

urbrRateLimit

-> UpdateRateBasedRule

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

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

• urbrRuleId - The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules .
• urbrChangeToken - The value returned by the most recent call to GetChangeToken .
• urbrUpdates - An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule .
• urbrRateLimit - The maximum number of requests, which have an identical value in the field specified by the RateKey , allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

data UpdateRateBasedRule

See: updateRateBasedRule smart constructor.

Instances

Eq UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

(==) :: UpdateRateBasedRule -> UpdateRateBasedRule -> Bool

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

Data UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

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

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

toConstr :: UpdateRateBasedRule -> Constr

dataTypeOf :: UpdateRateBasedRule -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateRateBasedRule)

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

gmapT :: (forall b. Data b => b -> b) -> UpdateRateBasedRule -> UpdateRateBasedRule

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

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

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

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

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

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

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

Read UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

readsPrec :: Int -> ReadS UpdateRateBasedRule

readList :: ReadS [UpdateRateBasedRule]

readPrec :: ReadPrec UpdateRateBasedRule

readListPrec :: ReadPrec [UpdateRateBasedRule]

Show UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

showsPrec :: Int -> UpdateRateBasedRule -> ShowS

show :: UpdateRateBasedRule -> String

showList :: [UpdateRateBasedRule] -> ShowS

Generic UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Associated Types

type Rep UpdateRateBasedRule :: Type -> Type

Methods

from :: UpdateRateBasedRule -> Rep UpdateRateBasedRule x

to :: Rep UpdateRateBasedRule x -> UpdateRateBasedRule

Hashable UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

hashWithSalt :: Int -> UpdateRateBasedRule -> Int

hash :: UpdateRateBasedRule -> Int

ToJSON UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

toJSON :: UpdateRateBasedRule -> Value

toEncoding :: UpdateRateBasedRule -> Encoding

toJSONList :: [UpdateRateBasedRule] -> Value

toEncodingList :: [UpdateRateBasedRule] -> Encoding

AWSRequest UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Associated Types

type Rs UpdateRateBasedRule :: Type

Methods

request :: UpdateRateBasedRule -> Request UpdateRateBasedRule

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateRateBasedRule -> ClientResponse -> m (Response UpdateRateBasedRule)

ToHeaders UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

toHeaders :: UpdateRateBasedRule -> [Header]

ToPath UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

toPath :: UpdateRateBasedRule -> ByteString

ToQuery UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

toQuery :: UpdateRateBasedRule -> QueryString

NFData UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

rnf :: UpdateRateBasedRule -> ()

type Rep UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

type Rep UpdateRateBasedRule = D1 (MetaData "UpdateRateBasedRule" "Network.AWS.WAF.UpdateRateBasedRule" "amazonka-waf-1.6.1-AAUMqlxoZ2N3dlHnZE2nzz" False) (C1 (MetaCons "UpdateRateBasedRule'" PrefixI True) ((S1 (MetaSel (Just "_urbrRuleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_urbrChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_urbrUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [RuleUpdate]) :*: S1 (MetaSel (Just "_urbrRateLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

type Rs UpdateRateBasedRule

Defined in Network.AWS.WAF.UpdateRateBasedRule

type Rs UpdateRateBasedRule = UpdateRateBasedRuleResponse

Request Lenses

urbrRuleId :: Lens' UpdateRateBasedRule Text

The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules .

urbrChangeToken :: Lens' UpdateRateBasedRule Text

The value returned by the most recent call to GetChangeToken .

urbrUpdates :: Lens' UpdateRateBasedRule [RuleUpdate]

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule .

urbrRateLimit :: Lens' UpdateRateBasedRule Natural

The maximum number of requests, which have an identical value in the field specified by the RateKey , allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Destructuring the Response

updateRateBasedRuleResponse

Arguments

:: Int

urbrrsResponseStatus

-> UpdateRateBasedRuleResponse

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

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

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

data UpdateRateBasedRuleResponse

See: updateRateBasedRuleResponse smart constructor.

Instances

Eq UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

(==) :: UpdateRateBasedRuleResponse -> UpdateRateBasedRuleResponse -> Bool

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

Data UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

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

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

toConstr :: UpdateRateBasedRuleResponse -> Constr

dataTypeOf :: UpdateRateBasedRuleResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateRateBasedRuleResponse)

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

gmapT :: (forall b. Data b => b -> b) -> UpdateRateBasedRuleResponse -> UpdateRateBasedRuleResponse

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

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

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

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

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

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

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

Read UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

readsPrec :: Int -> ReadS UpdateRateBasedRuleResponse

readList :: ReadS [UpdateRateBasedRuleResponse]

readPrec :: ReadPrec UpdateRateBasedRuleResponse

readListPrec :: ReadPrec [UpdateRateBasedRuleResponse]

Show UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

showsPrec :: Int -> UpdateRateBasedRuleResponse -> ShowS

show :: UpdateRateBasedRuleResponse -> String

showList :: [UpdateRateBasedRuleResponse] -> ShowS

Generic UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

Associated Types

type Rep UpdateRateBasedRuleResponse :: Type -> Type

Methods

from :: UpdateRateBasedRuleResponse -> Rep UpdateRateBasedRuleResponse x

to :: Rep UpdateRateBasedRuleResponse x -> UpdateRateBasedRuleResponse

NFData UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

Methods

rnf :: UpdateRateBasedRuleResponse -> ()

type Rep UpdateRateBasedRuleResponse

Defined in Network.AWS.WAF.UpdateRateBasedRule

type Rep UpdateRateBasedRuleResponse = D1 (MetaData "UpdateRateBasedRuleResponse" "Network.AWS.WAF.UpdateRateBasedRule" "amazonka-waf-1.6.1-AAUMqlxoZ2N3dlHnZE2nzz" False) (C1 (MetaCons "UpdateRateBasedRuleResponse'" PrefixI True) (S1 (MetaSel (Just "_urbrrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_urbrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

urbrrsChangeToken :: Lens' UpdateRateBasedRuleResponse (Maybe Text)

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

urbrrsResponseStatus :: Lens' UpdateRateBasedRuleResponse Int

• - | The response status code.