Network.AWS.WAF.CreateRateBasedRule

Creates a RateBasedRule . The RateBasedRule contains a RateLimit , which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit .

If you add more than one predicate to a RateBasedRule , a request not only must exceed the RateLimit , but it also must match all the specifications 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 meet the conditions in 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 must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, 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.

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

• Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet , CreateIPSet , and CreateSqlInjectionMatchSet .
• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
• Submit a CreateRateBasedRule request.
• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
• Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.
• Create and update a WebACL that contains the RateBasedRule . For more information, see CreateWebACL .

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

createRateBasedRule

Arguments

:: Text

crbrName

-> Text

crbrMetricName

-> RateKey

crbrRateKey

-> Natural

crbrRateLimit

-> Text

crbrChangeToken

-> CreateRateBasedRule

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

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

• crbrName - A friendly name or description of the RateBasedRule . You can't change the name of a RateBasedRule after you create it.
• crbrMetricName - A friendly name or description for the metrics for this RateBasedRule . The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule .
• crbrRateKey - The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP . IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule .
• crbrRateLimit - The maximum number of requests, which have an identical value in the field that is specified by 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.
• crbrChangeToken - The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .

data CreateRateBasedRule

See: createRateBasedRule smart constructor.

Instances

Eq CreateRateBasedRule

Methods

(==) :: CreateRateBasedRule -> CreateRateBasedRule -> Bool

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

Data CreateRateBasedRule

Methods

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

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

toConstr :: CreateRateBasedRule -> Constr

dataTypeOf :: CreateRateBasedRule -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateRateBasedRule

Methods

readsPrec :: Int -> ReadS CreateRateBasedRule

readList :: ReadS [CreateRateBasedRule]

readPrec :: ReadPrec CreateRateBasedRule

readListPrec :: ReadPrec [CreateRateBasedRule]

Show CreateRateBasedRule

Methods

showsPrec :: Int -> CreateRateBasedRule -> ShowS

show :: CreateRateBasedRule -> String

showList :: [CreateRateBasedRule] -> ShowS

Generic CreateRateBasedRule

Associated Types

type Rep CreateRateBasedRule :: * -> *

Methods

from :: CreateRateBasedRule -> Rep CreateRateBasedRule x

to :: Rep CreateRateBasedRule x -> CreateRateBasedRule

Hashable CreateRateBasedRule

Methods

hashWithSalt :: Int -> CreateRateBasedRule -> Int

hash :: CreateRateBasedRule -> Int

ToJSON CreateRateBasedRule

Methods

toJSON :: CreateRateBasedRule -> Value

toEncoding :: CreateRateBasedRule -> Encoding

toJSONList :: [CreateRateBasedRule] -> Value

toEncodingList :: [CreateRateBasedRule] -> Encoding

NFData CreateRateBasedRule

Methods

rnf :: CreateRateBasedRule -> ()

AWSRequest CreateRateBasedRule

Associated Types

type Rs CreateRateBasedRule :: *

Methods

request :: CreateRateBasedRule -> Request CreateRateBasedRule

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

ToQuery CreateRateBasedRule

Methods

toQuery :: CreateRateBasedRule -> QueryString

ToPath CreateRateBasedRule

Methods

toPath :: CreateRateBasedRule -> ByteString

ToHeaders CreateRateBasedRule

Methods

toHeaders :: CreateRateBasedRule -> [Header]

type Rep CreateRateBasedRule

type Rep CreateRateBasedRule = D1 (MetaData "CreateRateBasedRule" "Network.AWS.WAF.CreateRateBasedRule" "amazonka-waf-1.5.0-7MotG1cKFRJDGEqr7Xc0q6" False) (C1 (MetaCons "CreateRateBasedRule'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_crbrName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_crbrMetricName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_crbrRateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RateKey)) ((:*:) (S1 (MetaSel (Just Symbol "_crbrRateLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) (S1 (MetaSel (Just Symbol "_crbrChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateRateBasedRule

type Rs CreateRateBasedRule = CreateRateBasedRuleResponse

Request Lenses

crbrName :: Lens' CreateRateBasedRule Text

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

crbrMetricName :: Lens' CreateRateBasedRule Text

A friendly name or description for the metrics for this RateBasedRule . The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule .

crbrRateKey :: Lens' CreateRateBasedRule RateKey

The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP . IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule .

crbrRateLimit :: Lens' CreateRateBasedRule Natural

The maximum number of requests, which have an identical value in the field that is specified by 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.

crbrChangeToken :: Lens' CreateRateBasedRule Text

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

Destructuring the Response

createRateBasedRuleResponse

Arguments

:: Int

crbrrsResponseStatus

-> CreateRateBasedRuleResponse

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

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

• crbrrsRule - The RateBasedRule that is returned in the CreateRateBasedRule response.
• crbrrsChangeToken - The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .
• crbrrsResponseStatus - -- | The response status code.

data CreateRateBasedRuleResponse

See: createRateBasedRuleResponse smart constructor.

Instances

Eq CreateRateBasedRuleResponse

Methods

(==) :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool

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

Data CreateRateBasedRuleResponse

Methods

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

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

toConstr :: CreateRateBasedRuleResponse -> Constr

dataTypeOf :: CreateRateBasedRuleResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateRateBasedRuleResponse

Methods

readsPrec :: Int -> ReadS CreateRateBasedRuleResponse

readList :: ReadS [CreateRateBasedRuleResponse]

readPrec :: ReadPrec CreateRateBasedRuleResponse

readListPrec :: ReadPrec [CreateRateBasedRuleResponse]

Show CreateRateBasedRuleResponse

Methods

showsPrec :: Int -> CreateRateBasedRuleResponse -> ShowS

show :: CreateRateBasedRuleResponse -> String

showList :: [CreateRateBasedRuleResponse] -> ShowS

Generic CreateRateBasedRuleResponse

Associated Types

type Rep CreateRateBasedRuleResponse :: * -> *

Methods

from :: CreateRateBasedRuleResponse -> Rep CreateRateBasedRuleResponse x

to :: Rep CreateRateBasedRuleResponse x -> CreateRateBasedRuleResponse

NFData CreateRateBasedRuleResponse

Methods

rnf :: CreateRateBasedRuleResponse -> ()

type Rep CreateRateBasedRuleResponse

type Rep CreateRateBasedRuleResponse = D1 (MetaData "CreateRateBasedRuleResponse" "Network.AWS.WAF.CreateRateBasedRule" "amazonka-waf-1.5.0-7MotG1cKFRJDGEqr7Xc0q6" False) (C1 (MetaCons "CreateRateBasedRuleResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_crbrrsRule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RateBasedRule))) ((:*:) (S1 (MetaSel (Just Symbol "_crbrrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crbrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

crbrrsRule :: Lens' CreateRateBasedRuleResponse (Maybe RateBasedRule)

The RateBasedRule that is returned in the CreateRateBasedRule response.

crbrrsChangeToken :: Lens' CreateRateBasedRuleResponse (Maybe Text)

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

crbrrsResponseStatus :: Lens' CreateRateBasedRuleResponse Int

• - | The response status code.