{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.WAFRegional.CreateRateBasedRule
-- Copyright   : (c) 2013-2021 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)
--
-- This is __AWS WAF Classic__ documentation. For more information, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html AWS WAF Classic>
-- in the developer guide.
--
-- __For the latest version of AWS WAF__, use the AWS WAFV2 API and see the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html AWS WAF Developer Guide>.
-- With the latest version, AWS WAF has a single set of endpoints for
-- regional and global use.
--
-- 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
-- conditions 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 1,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 1,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 1,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 1,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:
--
-- 1.  Create and update the predicates that you want to include in the
--     rule. For more information, see CreateByteMatchSet, CreateIPSet, and
--     CreateSqlInjectionMatchSet.
--
-- 2.  Use GetChangeToken to get the change token that you provide in the
--     @ChangeToken@ parameter of a @CreateRule@ request.
--
-- 3.  Submit a @CreateRateBasedRule@ request.
--
-- 4.  Use @GetChangeToken@ to get the change token that you provide in the
--     @ChangeToken@ parameter of an UpdateRule request.
--
-- 5.  Submit an @UpdateRateBasedRule@ request to specify the predicates
--     that you want to include in the rule.
--
-- 6.  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
-- <https://docs.aws.amazon.com/waf/latest/developerguide/ AWS WAF Developer Guide>.
module Amazonka.WAFRegional.CreateRateBasedRule
  ( -- * Creating a Request
    CreateRateBasedRule (..),
    newCreateRateBasedRule,

    -- * Request Lenses
    createRateBasedRule_tags,
    createRateBasedRule_name,
    createRateBasedRule_metricName,
    createRateBasedRule_rateKey,
    createRateBasedRule_rateLimit,
    createRateBasedRule_changeToken,

    -- * Destructuring the Response
    CreateRateBasedRuleResponse (..),
    newCreateRateBasedRuleResponse,

    -- * Response Lenses
    createRateBasedRuleResponse_rule,
    createRateBasedRuleResponse_changeToken,
    createRateBasedRuleResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.WAFRegional.Types

-- | /See:/ 'newCreateRateBasedRule' smart constructor.
data CreateRateBasedRule = CreateRateBasedRule'
  { CreateRateBasedRule -> Maybe (NonEmpty Tag)
tags :: Prelude.Maybe (Prelude.NonEmpty Tag),
    -- | A friendly name or description of the RateBasedRule. You can\'t change
    -- the name of a @RateBasedRule@ after you create it.
    CreateRateBasedRule -> Text
name :: Prelude.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), with
    -- maximum length 128 and minimum length one. It can\'t contain whitespace
    -- or metric names reserved for AWS WAF, including \"All\" and
    -- \"Default_Action.\" You can\'t change the name of the metric after you
    -- create the @RateBasedRule@.
    CreateRateBasedRule -> Text
metricName :: Prelude.Text,
    -- | 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@.
    CreateRateBasedRule -> RateKey
rateKey :: RateKey,
    -- | 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.
    CreateRateBasedRule -> Natural
rateLimit :: Prelude.Natural,
    -- | 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.
    CreateRateBasedRule -> Text
changeToken :: Prelude.Text
  }
  deriving (CreateRateBasedRule -> CreateRateBasedRule -> Bool
(CreateRateBasedRule -> CreateRateBasedRule -> Bool)
-> (CreateRateBasedRule -> CreateRateBasedRule -> Bool)
-> Eq CreateRateBasedRule
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateRateBasedRule -> CreateRateBasedRule -> Bool
$c/= :: CreateRateBasedRule -> CreateRateBasedRule -> Bool
== :: CreateRateBasedRule -> CreateRateBasedRule -> Bool
$c== :: CreateRateBasedRule -> CreateRateBasedRule -> Bool
Prelude.Eq, ReadPrec [CreateRateBasedRule]
ReadPrec CreateRateBasedRule
Int -> ReadS CreateRateBasedRule
ReadS [CreateRateBasedRule]
(Int -> ReadS CreateRateBasedRule)
-> ReadS [CreateRateBasedRule]
-> ReadPrec CreateRateBasedRule
-> ReadPrec [CreateRateBasedRule]
-> Read CreateRateBasedRule
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateRateBasedRule]
$creadListPrec :: ReadPrec [CreateRateBasedRule]
readPrec :: ReadPrec CreateRateBasedRule
$creadPrec :: ReadPrec CreateRateBasedRule
readList :: ReadS [CreateRateBasedRule]
$creadList :: ReadS [CreateRateBasedRule]
readsPrec :: Int -> ReadS CreateRateBasedRule
$creadsPrec :: Int -> ReadS CreateRateBasedRule
Prelude.Read, Int -> CreateRateBasedRule -> ShowS
[CreateRateBasedRule] -> ShowS
CreateRateBasedRule -> String
(Int -> CreateRateBasedRule -> ShowS)
-> (CreateRateBasedRule -> String)
-> ([CreateRateBasedRule] -> ShowS)
-> Show CreateRateBasedRule
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateRateBasedRule] -> ShowS
$cshowList :: [CreateRateBasedRule] -> ShowS
show :: CreateRateBasedRule -> String
$cshow :: CreateRateBasedRule -> String
showsPrec :: Int -> CreateRateBasedRule -> ShowS
$cshowsPrec :: Int -> CreateRateBasedRule -> ShowS
Prelude.Show, (forall x. CreateRateBasedRule -> Rep CreateRateBasedRule x)
-> (forall x. Rep CreateRateBasedRule x -> CreateRateBasedRule)
-> Generic CreateRateBasedRule
forall x. Rep CreateRateBasedRule x -> CreateRateBasedRule
forall x. CreateRateBasedRule -> Rep CreateRateBasedRule x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CreateRateBasedRule x -> CreateRateBasedRule
$cfrom :: forall x. CreateRateBasedRule -> Rep CreateRateBasedRule x
Prelude.Generic)

-- |
-- Create a value of 'CreateRateBasedRule' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'tags', 'createRateBasedRule_tags' -
--
-- 'name', 'createRateBasedRule_name' - A friendly name or description of the RateBasedRule. You can\'t change
-- the name of a @RateBasedRule@ after you create it.
--
-- 'metricName', 'createRateBasedRule_metricName' - A friendly name or description for the metrics for this @RateBasedRule@.
-- The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with
-- maximum length 128 and minimum length one. It can\'t contain whitespace
-- or metric names reserved for AWS WAF, including \"All\" and
-- \"Default_Action.\" You can\'t change the name of the metric after you
-- create the @RateBasedRule@.
--
-- 'rateKey', '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@.
--
-- 'rateLimit', 'createRateBasedRule_rateLimit' - 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.
--
-- 'changeToken', 'createRateBasedRule_changeToken' - 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.
newCreateRateBasedRule ::
  -- | 'name'
  Prelude.Text ->
  -- | 'metricName'
  Prelude.Text ->
  -- | 'rateKey'
  RateKey ->
  -- | 'rateLimit'
  Prelude.Natural ->
  -- | 'changeToken'
  Prelude.Text ->
  CreateRateBasedRule
newCreateRateBasedRule :: Text -> Text -> RateKey -> Natural -> Text -> CreateRateBasedRule
newCreateRateBasedRule
  Text
pName_
  Text
pMetricName_
  RateKey
pRateKey_
  Natural
pRateLimit_
  Text
pChangeToken_ =
    CreateRateBasedRule' :: Maybe (NonEmpty Tag)
-> Text
-> Text
-> RateKey
-> Natural
-> Text
-> CreateRateBasedRule
CreateRateBasedRule'
      { $sel:tags:CreateRateBasedRule' :: Maybe (NonEmpty Tag)
tags = Maybe (NonEmpty Tag)
forall a. Maybe a
Prelude.Nothing,
        $sel:name:CreateRateBasedRule' :: Text
name = Text
pName_,
        $sel:metricName:CreateRateBasedRule' :: Text
metricName = Text
pMetricName_,
        $sel:rateKey:CreateRateBasedRule' :: RateKey
rateKey = RateKey
pRateKey_,
        $sel:rateLimit:CreateRateBasedRule' :: Natural
rateLimit = Natural
pRateLimit_,
        $sel:changeToken:CreateRateBasedRule' :: Text
changeToken = Text
pChangeToken_
      }

-- |
createRateBasedRule_tags :: Lens.Lens' CreateRateBasedRule (Prelude.Maybe (Prelude.NonEmpty Tag))
createRateBasedRule_tags :: (Maybe (NonEmpty Tag) -> f (Maybe (NonEmpty Tag)))
-> CreateRateBasedRule -> f CreateRateBasedRule
createRateBasedRule_tags = (CreateRateBasedRule -> Maybe (NonEmpty Tag))
-> (CreateRateBasedRule
    -> Maybe (NonEmpty Tag) -> CreateRateBasedRule)
-> Lens
     CreateRateBasedRule
     CreateRateBasedRule
     (Maybe (NonEmpty Tag))
     (Maybe (NonEmpty Tag))
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRule' {Maybe (NonEmpty Tag)
tags :: Maybe (NonEmpty Tag)
$sel:tags:CreateRateBasedRule' :: CreateRateBasedRule -> Maybe (NonEmpty Tag)
tags} -> Maybe (NonEmpty Tag)
tags) (\s :: CreateRateBasedRule
s@CreateRateBasedRule' {} Maybe (NonEmpty Tag)
a -> CreateRateBasedRule
s {$sel:tags:CreateRateBasedRule' :: Maybe (NonEmpty Tag)
tags = Maybe (NonEmpty Tag)
a} :: CreateRateBasedRule) ((Maybe (NonEmpty Tag) -> f (Maybe (NonEmpty Tag)))
 -> CreateRateBasedRule -> f CreateRateBasedRule)
-> ((Maybe (NonEmpty Tag) -> f (Maybe (NonEmpty Tag)))
    -> Maybe (NonEmpty Tag) -> f (Maybe (NonEmpty Tag)))
-> (Maybe (NonEmpty Tag) -> f (Maybe (NonEmpty Tag)))
-> CreateRateBasedRule
-> f CreateRateBasedRule
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso (NonEmpty Tag) (NonEmpty Tag) (NonEmpty Tag) (NonEmpty Tag)
-> Iso
     (Maybe (NonEmpty Tag))
     (Maybe (NonEmpty Tag))
     (Maybe (NonEmpty Tag))
     (Maybe (NonEmpty Tag))
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso (NonEmpty Tag) (NonEmpty Tag) (NonEmpty Tag) (NonEmpty Tag)
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A friendly name or description of the RateBasedRule. You can\'t change
-- the name of a @RateBasedRule@ after you create it.
createRateBasedRule_name :: Lens.Lens' CreateRateBasedRule Prelude.Text
createRateBasedRule_name :: (Text -> f Text) -> CreateRateBasedRule -> f CreateRateBasedRule
createRateBasedRule_name = (CreateRateBasedRule -> Text)
-> (CreateRateBasedRule -> Text -> CreateRateBasedRule)
-> Lens CreateRateBasedRule CreateRateBasedRule Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRule' {Text
name :: Text
$sel:name:CreateRateBasedRule' :: CreateRateBasedRule -> Text
name} -> Text
name) (\s :: CreateRateBasedRule
s@CreateRateBasedRule' {} Text
a -> CreateRateBasedRule
s {$sel:name:CreateRateBasedRule' :: Text
name = Text
a} :: CreateRateBasedRule)

-- | A friendly name or description for the metrics for this @RateBasedRule@.
-- The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with
-- maximum length 128 and minimum length one. It can\'t contain whitespace
-- or metric names reserved for AWS WAF, including \"All\" and
-- \"Default_Action.\" You can\'t change the name of the metric after you
-- create the @RateBasedRule@.
createRateBasedRule_metricName :: Lens.Lens' CreateRateBasedRule Prelude.Text
createRateBasedRule_metricName :: (Text -> f Text) -> CreateRateBasedRule -> f CreateRateBasedRule
createRateBasedRule_metricName = (CreateRateBasedRule -> Text)
-> (CreateRateBasedRule -> Text -> CreateRateBasedRule)
-> Lens CreateRateBasedRule CreateRateBasedRule Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRule' {Text
metricName :: Text
$sel:metricName:CreateRateBasedRule' :: CreateRateBasedRule -> Text
metricName} -> Text
metricName) (\s :: CreateRateBasedRule
s@CreateRateBasedRule' {} Text
a -> CreateRateBasedRule
s {$sel:metricName:CreateRateBasedRule' :: Text
metricName = Text
a} :: CreateRateBasedRule)

-- | 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@.
createRateBasedRule_rateKey :: Lens.Lens' CreateRateBasedRule RateKey
createRateBasedRule_rateKey :: (RateKey -> f RateKey)
-> CreateRateBasedRule -> f CreateRateBasedRule
createRateBasedRule_rateKey = (CreateRateBasedRule -> RateKey)
-> (CreateRateBasedRule -> RateKey -> CreateRateBasedRule)
-> Lens CreateRateBasedRule CreateRateBasedRule RateKey RateKey
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRule' {RateKey
rateKey :: RateKey
$sel:rateKey:CreateRateBasedRule' :: CreateRateBasedRule -> RateKey
rateKey} -> RateKey
rateKey) (\s :: CreateRateBasedRule
s@CreateRateBasedRule' {} RateKey
a -> CreateRateBasedRule
s {$sel:rateKey:CreateRateBasedRule' :: RateKey
rateKey = RateKey
a} :: CreateRateBasedRule)

-- | 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.
createRateBasedRule_rateLimit :: Lens.Lens' CreateRateBasedRule Prelude.Natural
createRateBasedRule_rateLimit :: (Natural -> f Natural)
-> CreateRateBasedRule -> f CreateRateBasedRule
createRateBasedRule_rateLimit = (CreateRateBasedRule -> Natural)
-> (CreateRateBasedRule -> Natural -> CreateRateBasedRule)
-> Lens CreateRateBasedRule CreateRateBasedRule Natural Natural
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRule' {Natural
rateLimit :: Natural
$sel:rateLimit:CreateRateBasedRule' :: CreateRateBasedRule -> Natural
rateLimit} -> Natural
rateLimit) (\s :: CreateRateBasedRule
s@CreateRateBasedRule' {} Natural
a -> CreateRateBasedRule
s {$sel:rateLimit:CreateRateBasedRule' :: Natural
rateLimit = Natural
a} :: CreateRateBasedRule)

-- | 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.
createRateBasedRule_changeToken :: Lens.Lens' CreateRateBasedRule Prelude.Text
createRateBasedRule_changeToken :: (Text -> f Text) -> CreateRateBasedRule -> f CreateRateBasedRule
createRateBasedRule_changeToken = (CreateRateBasedRule -> Text)
-> (CreateRateBasedRule -> Text -> CreateRateBasedRule)
-> Lens CreateRateBasedRule CreateRateBasedRule Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRule' {Text
changeToken :: Text
$sel:changeToken:CreateRateBasedRule' :: CreateRateBasedRule -> Text
changeToken} -> Text
changeToken) (\s :: CreateRateBasedRule
s@CreateRateBasedRule' {} Text
a -> CreateRateBasedRule
s {$sel:changeToken:CreateRateBasedRule' :: Text
changeToken = Text
a} :: CreateRateBasedRule)

instance Core.AWSRequest CreateRateBasedRule where
  type
    AWSResponse CreateRateBasedRule =
      CreateRateBasedRuleResponse
  request :: CreateRateBasedRule -> Request CreateRateBasedRule
request = Service -> CreateRateBasedRule -> Request CreateRateBasedRule
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy CreateRateBasedRule
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CreateRateBasedRule)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse CreateRateBasedRule))
-> Logger
-> Service
-> Proxy CreateRateBasedRule
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CreateRateBasedRule)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe RateBasedRule
-> Maybe Text -> Int -> CreateRateBasedRuleResponse
CreateRateBasedRuleResponse'
            (Maybe RateBasedRule
 -> Maybe Text -> Int -> CreateRateBasedRuleResponse)
-> Either String (Maybe RateBasedRule)
-> Either String (Maybe Text -> Int -> CreateRateBasedRuleResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe RateBasedRule)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"Rule")
            Either String (Maybe Text -> Int -> CreateRateBasedRuleResponse)
-> Either String (Maybe Text)
-> Either String (Int -> CreateRateBasedRuleResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Either String (Maybe Text)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"ChangeToken")
            Either String (Int -> CreateRateBasedRuleResponse)
-> Either String Int -> Either String CreateRateBasedRuleResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable CreateRateBasedRule

instance Prelude.NFData CreateRateBasedRule

instance Core.ToHeaders CreateRateBasedRule where
  toHeaders :: CreateRateBasedRule -> ResponseHeaders
toHeaders =
    ResponseHeaders -> CreateRateBasedRule -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const
      ( [ResponseHeaders] -> ResponseHeaders
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"AWSWAF_Regional_20161128.CreateRateBasedRule" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToJSON CreateRateBasedRule where
  toJSON :: CreateRateBasedRule -> Value
toJSON CreateRateBasedRule' {Natural
Maybe (NonEmpty Tag)
Text
RateKey
changeToken :: Text
rateLimit :: Natural
rateKey :: RateKey
metricName :: Text
name :: Text
tags :: Maybe (NonEmpty Tag)
$sel:changeToken:CreateRateBasedRule' :: CreateRateBasedRule -> Text
$sel:rateLimit:CreateRateBasedRule' :: CreateRateBasedRule -> Natural
$sel:rateKey:CreateRateBasedRule' :: CreateRateBasedRule -> RateKey
$sel:metricName:CreateRateBasedRule' :: CreateRateBasedRule -> Text
$sel:name:CreateRateBasedRule' :: CreateRateBasedRule -> Text
$sel:tags:CreateRateBasedRule' :: CreateRateBasedRule -> Maybe (NonEmpty Tag)
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Tags" Text -> NonEmpty Tag -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (NonEmpty Tag -> Pair) -> Maybe (NonEmpty Tag) -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Tag)
tags,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Name" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
name),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"MetricName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
metricName),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"RateKey" Text -> RateKey -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= RateKey
rateKey),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"RateLimit" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Natural
rateLimit),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"ChangeToken" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
changeToken)
          ]
      )

instance Core.ToPath CreateRateBasedRule where
  toPath :: CreateRateBasedRule -> ByteString
toPath = ByteString -> CreateRateBasedRule -> ByteString
forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Core.ToQuery CreateRateBasedRule where
  toQuery :: CreateRateBasedRule -> QueryString
toQuery = QueryString -> CreateRateBasedRule -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newCreateRateBasedRuleResponse' smart constructor.
data CreateRateBasedRuleResponse = CreateRateBasedRuleResponse'
  { -- | The RateBasedRule that is returned in the @CreateRateBasedRule@
    -- response.
    CreateRateBasedRuleResponse -> Maybe RateBasedRule
rule :: Prelude.Maybe RateBasedRule,
    -- | 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.
    CreateRateBasedRuleResponse -> Maybe Text
changeToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    CreateRateBasedRuleResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool
(CreateRateBasedRuleResponse
 -> CreateRateBasedRuleResponse -> Bool)
-> (CreateRateBasedRuleResponse
    -> CreateRateBasedRuleResponse -> Bool)
-> Eq CreateRateBasedRuleResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool
$c/= :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool
== :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool
$c== :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool
Prelude.Eq, ReadPrec [CreateRateBasedRuleResponse]
ReadPrec CreateRateBasedRuleResponse
Int -> ReadS CreateRateBasedRuleResponse
ReadS [CreateRateBasedRuleResponse]
(Int -> ReadS CreateRateBasedRuleResponse)
-> ReadS [CreateRateBasedRuleResponse]
-> ReadPrec CreateRateBasedRuleResponse
-> ReadPrec [CreateRateBasedRuleResponse]
-> Read CreateRateBasedRuleResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateRateBasedRuleResponse]
$creadListPrec :: ReadPrec [CreateRateBasedRuleResponse]
readPrec :: ReadPrec CreateRateBasedRuleResponse
$creadPrec :: ReadPrec CreateRateBasedRuleResponse
readList :: ReadS [CreateRateBasedRuleResponse]
$creadList :: ReadS [CreateRateBasedRuleResponse]
readsPrec :: Int -> ReadS CreateRateBasedRuleResponse
$creadsPrec :: Int -> ReadS CreateRateBasedRuleResponse
Prelude.Read, Int -> CreateRateBasedRuleResponse -> ShowS
[CreateRateBasedRuleResponse] -> ShowS
CreateRateBasedRuleResponse -> String
(Int -> CreateRateBasedRuleResponse -> ShowS)
-> (CreateRateBasedRuleResponse -> String)
-> ([CreateRateBasedRuleResponse] -> ShowS)
-> Show CreateRateBasedRuleResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateRateBasedRuleResponse] -> ShowS
$cshowList :: [CreateRateBasedRuleResponse] -> ShowS
show :: CreateRateBasedRuleResponse -> String
$cshow :: CreateRateBasedRuleResponse -> String
showsPrec :: Int -> CreateRateBasedRuleResponse -> ShowS
$cshowsPrec :: Int -> CreateRateBasedRuleResponse -> ShowS
Prelude.Show, (forall x.
 CreateRateBasedRuleResponse -> Rep CreateRateBasedRuleResponse x)
-> (forall x.
    Rep CreateRateBasedRuleResponse x -> CreateRateBasedRuleResponse)
-> Generic CreateRateBasedRuleResponse
forall x.
Rep CreateRateBasedRuleResponse x -> CreateRateBasedRuleResponse
forall x.
CreateRateBasedRuleResponse -> Rep CreateRateBasedRuleResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CreateRateBasedRuleResponse x -> CreateRateBasedRuleResponse
$cfrom :: forall x.
CreateRateBasedRuleResponse -> Rep CreateRateBasedRuleResponse x
Prelude.Generic)

-- |
-- Create a value of 'CreateRateBasedRuleResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'rule', 'createRateBasedRuleResponse_rule' - The RateBasedRule that is returned in the @CreateRateBasedRule@
-- response.
--
-- 'changeToken', 'createRateBasedRuleResponse_changeToken' - 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.
--
-- 'httpStatus', 'createRateBasedRuleResponse_httpStatus' - The response's http status code.
newCreateRateBasedRuleResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  CreateRateBasedRuleResponse
newCreateRateBasedRuleResponse :: Int -> CreateRateBasedRuleResponse
newCreateRateBasedRuleResponse Int
pHttpStatus_ =
  CreateRateBasedRuleResponse' :: Maybe RateBasedRule
-> Maybe Text -> Int -> CreateRateBasedRuleResponse
CreateRateBasedRuleResponse'
    { $sel:rule:CreateRateBasedRuleResponse' :: Maybe RateBasedRule
rule =
        Maybe RateBasedRule
forall a. Maybe a
Prelude.Nothing,
      $sel:changeToken:CreateRateBasedRuleResponse' :: Maybe Text
changeToken = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:CreateRateBasedRuleResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The RateBasedRule that is returned in the @CreateRateBasedRule@
-- response.
createRateBasedRuleResponse_rule :: Lens.Lens' CreateRateBasedRuleResponse (Prelude.Maybe RateBasedRule)
createRateBasedRuleResponse_rule :: (Maybe RateBasedRule -> f (Maybe RateBasedRule))
-> CreateRateBasedRuleResponse -> f CreateRateBasedRuleResponse
createRateBasedRuleResponse_rule = (CreateRateBasedRuleResponse -> Maybe RateBasedRule)
-> (CreateRateBasedRuleResponse
    -> Maybe RateBasedRule -> CreateRateBasedRuleResponse)
-> Lens
     CreateRateBasedRuleResponse
     CreateRateBasedRuleResponse
     (Maybe RateBasedRule)
     (Maybe RateBasedRule)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRuleResponse' {Maybe RateBasedRule
rule :: Maybe RateBasedRule
$sel:rule:CreateRateBasedRuleResponse' :: CreateRateBasedRuleResponse -> Maybe RateBasedRule
rule} -> Maybe RateBasedRule
rule) (\s :: CreateRateBasedRuleResponse
s@CreateRateBasedRuleResponse' {} Maybe RateBasedRule
a -> CreateRateBasedRuleResponse
s {$sel:rule:CreateRateBasedRuleResponse' :: Maybe RateBasedRule
rule = Maybe RateBasedRule
a} :: CreateRateBasedRuleResponse)

-- | 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.
createRateBasedRuleResponse_changeToken :: Lens.Lens' CreateRateBasedRuleResponse (Prelude.Maybe Prelude.Text)
createRateBasedRuleResponse_changeToken :: (Maybe Text -> f (Maybe Text))
-> CreateRateBasedRuleResponse -> f CreateRateBasedRuleResponse
createRateBasedRuleResponse_changeToken = (CreateRateBasedRuleResponse -> Maybe Text)
-> (CreateRateBasedRuleResponse
    -> Maybe Text -> CreateRateBasedRuleResponse)
-> Lens
     CreateRateBasedRuleResponse
     CreateRateBasedRuleResponse
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRuleResponse' {Maybe Text
changeToken :: Maybe Text
$sel:changeToken:CreateRateBasedRuleResponse' :: CreateRateBasedRuleResponse -> Maybe Text
changeToken} -> Maybe Text
changeToken) (\s :: CreateRateBasedRuleResponse
s@CreateRateBasedRuleResponse' {} Maybe Text
a -> CreateRateBasedRuleResponse
s {$sel:changeToken:CreateRateBasedRuleResponse' :: Maybe Text
changeToken = Maybe Text
a} :: CreateRateBasedRuleResponse)

-- | The response's http status code.
createRateBasedRuleResponse_httpStatus :: Lens.Lens' CreateRateBasedRuleResponse Prelude.Int
createRateBasedRuleResponse_httpStatus :: (Int -> f Int)
-> CreateRateBasedRuleResponse -> f CreateRateBasedRuleResponse
createRateBasedRuleResponse_httpStatus = (CreateRateBasedRuleResponse -> Int)
-> (CreateRateBasedRuleResponse
    -> Int -> CreateRateBasedRuleResponse)
-> Lens
     CreateRateBasedRuleResponse CreateRateBasedRuleResponse Int Int
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateRateBasedRuleResponse' {Int
httpStatus :: Int
$sel:httpStatus:CreateRateBasedRuleResponse' :: CreateRateBasedRuleResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: CreateRateBasedRuleResponse
s@CreateRateBasedRuleResponse' {} Int
a -> CreateRateBasedRuleResponse
s {$sel:httpStatus:CreateRateBasedRuleResponse' :: Int
httpStatus = Int
a} :: CreateRateBasedRuleResponse)

instance Prelude.NFData CreateRateBasedRuleResponse