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

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

-- |
-- Module      : Amazonka.WAFV2.Types.CaptchaAction
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.WAFV2.Types.CaptchaAction where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.WAFV2.Types.CustomRequestHandling

-- | Specifies that WAF should run a @CAPTCHA@ check against the request:
--
-- -   If the request includes a valid, unexpired @CAPTCHA@ token, WAF
--     applies any custom request handling and labels that you\'ve
--     configured and then allows the web request inspection to proceed to
--     the next rule, similar to a @CountAction@.
--
-- -   If the request doesn\'t include a valid, unexpired token, WAF
--     discontinues the web ACL evaluation of the request and blocks it
--     from going to its intended destination.
--
--     WAF generates a response that it sends back to the client, which
--     includes the following:
--
--     -   The header @x-amzn-waf-action@ with a value of @captcha@.
--
--     -   The HTTP status code @405 Method Not Allowed@.
--
--     -   If the request contains an @Accept@ header with a value of
--         @text\/html@, the response includes a @CAPTCHA@ JavaScript page
--         interstitial.
--
-- You can configure the expiration time in the @CaptchaConfig@
-- @ImmunityTimeProperty@ setting at the rule and web ACL level. The rule
-- setting overrides the web ACL setting.
--
-- This action option is available for rules. It isn\'t available for web
-- ACL default actions.
--
-- /See:/ 'newCaptchaAction' smart constructor.
data CaptchaAction = CaptchaAction'
  { -- | Defines custom handling for the web request, used when the @CAPTCHA@
    -- inspection determines that the request\'s token is valid and unexpired.
    --
    -- For information about customizing web requests and responses, see
    -- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html Customizing web requests and responses in WAF>
    -- in the
    -- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html WAF Developer Guide>.
    CaptchaAction -> Maybe CustomRequestHandling
customRequestHandling :: Prelude.Maybe CustomRequestHandling
  }
  deriving (CaptchaAction -> CaptchaAction -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CaptchaAction -> CaptchaAction -> Bool
$c/= :: CaptchaAction -> CaptchaAction -> Bool
== :: CaptchaAction -> CaptchaAction -> Bool
$c== :: CaptchaAction -> CaptchaAction -> Bool
Prelude.Eq, ReadPrec [CaptchaAction]
ReadPrec CaptchaAction
Int -> ReadS CaptchaAction
ReadS [CaptchaAction]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CaptchaAction]
$creadListPrec :: ReadPrec [CaptchaAction]
readPrec :: ReadPrec CaptchaAction
$creadPrec :: ReadPrec CaptchaAction
readList :: ReadS [CaptchaAction]
$creadList :: ReadS [CaptchaAction]
readsPrec :: Int -> ReadS CaptchaAction
$creadsPrec :: Int -> ReadS CaptchaAction
Prelude.Read, Int -> CaptchaAction -> ShowS
[CaptchaAction] -> ShowS
CaptchaAction -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CaptchaAction] -> ShowS
$cshowList :: [CaptchaAction] -> ShowS
show :: CaptchaAction -> String
$cshow :: CaptchaAction -> String
showsPrec :: Int -> CaptchaAction -> ShowS
$cshowsPrec :: Int -> CaptchaAction -> ShowS
Prelude.Show, forall x. Rep CaptchaAction x -> CaptchaAction
forall x. CaptchaAction -> Rep CaptchaAction x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CaptchaAction x -> CaptchaAction
$cfrom :: forall x. CaptchaAction -> Rep CaptchaAction x
Prelude.Generic)

-- |
-- Create a value of 'CaptchaAction' 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:
--
-- 'customRequestHandling', 'captchaAction_customRequestHandling' - Defines custom handling for the web request, used when the @CAPTCHA@
-- inspection determines that the request\'s token is valid and unexpired.
--
-- For information about customizing web requests and responses, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html Customizing web requests and responses in WAF>
-- in the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html WAF Developer Guide>.
newCaptchaAction ::
  CaptchaAction
newCaptchaAction :: CaptchaAction
newCaptchaAction =
  CaptchaAction'
    { $sel:customRequestHandling:CaptchaAction' :: Maybe CustomRequestHandling
customRequestHandling =
        forall a. Maybe a
Prelude.Nothing
    }

-- | Defines custom handling for the web request, used when the @CAPTCHA@
-- inspection determines that the request\'s token is valid and unexpired.
--
-- For information about customizing web requests and responses, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html Customizing web requests and responses in WAF>
-- in the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html WAF Developer Guide>.
captchaAction_customRequestHandling :: Lens.Lens' CaptchaAction (Prelude.Maybe CustomRequestHandling)
captchaAction_customRequestHandling :: Lens' CaptchaAction (Maybe CustomRequestHandling)
captchaAction_customRequestHandling = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CaptchaAction' {Maybe CustomRequestHandling
customRequestHandling :: Maybe CustomRequestHandling
$sel:customRequestHandling:CaptchaAction' :: CaptchaAction -> Maybe CustomRequestHandling
customRequestHandling} -> Maybe CustomRequestHandling
customRequestHandling) (\s :: CaptchaAction
s@CaptchaAction' {} Maybe CustomRequestHandling
a -> CaptchaAction
s {$sel:customRequestHandling:CaptchaAction' :: Maybe CustomRequestHandling
customRequestHandling = Maybe CustomRequestHandling
a} :: CaptchaAction)

instance Data.FromJSON CaptchaAction where
  parseJSON :: Value -> Parser CaptchaAction
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CaptchaAction"
      ( \Object
x ->
          Maybe CustomRequestHandling -> CaptchaAction
CaptchaAction'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CustomRequestHandling")
      )

instance Prelude.Hashable CaptchaAction where
  hashWithSalt :: Int -> CaptchaAction -> Int
hashWithSalt Int
_salt CaptchaAction' {Maybe CustomRequestHandling
customRequestHandling :: Maybe CustomRequestHandling
$sel:customRequestHandling:CaptchaAction' :: CaptchaAction -> Maybe CustomRequestHandling
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CustomRequestHandling
customRequestHandling

instance Prelude.NFData CaptchaAction where
  rnf :: CaptchaAction -> ()
rnf CaptchaAction' {Maybe CustomRequestHandling
customRequestHandling :: Maybe CustomRequestHandling
$sel:customRequestHandling:CaptchaAction' :: CaptchaAction -> Maybe CustomRequestHandling
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CustomRequestHandling
customRequestHandling

instance Data.ToJSON CaptchaAction where
  toJSON :: CaptchaAction -> Value
toJSON CaptchaAction' {Maybe CustomRequestHandling
customRequestHandling :: Maybe CustomRequestHandling
$sel:customRequestHandling:CaptchaAction' :: CaptchaAction -> Maybe CustomRequestHandling
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CustomRequestHandling" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe CustomRequestHandling
customRequestHandling
          ]
      )