{-# 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.RuleActionOverride
-- 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.RuleActionOverride 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.RuleAction

-- | Action setting to use in the place of a rule action that is configured
-- inside the rule group. You specify one override for each rule whose
-- action you want to change.
--
-- You can use overrides for testing, for example you can override all of
-- rule actions to @Count@ and then monitor the resulting count metrics to
-- understand how the rule group would handle your web traffic. You can
-- also permanently override some or all actions, to modify how the rule
-- group manages your web traffic.
--
-- /See:/ 'newRuleActionOverride' smart constructor.
data RuleActionOverride = RuleActionOverride'
  { -- | The name of the rule to override.
    RuleActionOverride -> Text
name :: Prelude.Text,
    -- | The override action to use, in place of the configured action of the
    -- rule in the rule group.
    RuleActionOverride -> RuleAction
actionToUse :: RuleAction
  }
  deriving (RuleActionOverride -> RuleActionOverride -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RuleActionOverride -> RuleActionOverride -> Bool
$c/= :: RuleActionOverride -> RuleActionOverride -> Bool
== :: RuleActionOverride -> RuleActionOverride -> Bool
$c== :: RuleActionOverride -> RuleActionOverride -> Bool
Prelude.Eq, ReadPrec [RuleActionOverride]
ReadPrec RuleActionOverride
Int -> ReadS RuleActionOverride
ReadS [RuleActionOverride]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RuleActionOverride]
$creadListPrec :: ReadPrec [RuleActionOverride]
readPrec :: ReadPrec RuleActionOverride
$creadPrec :: ReadPrec RuleActionOverride
readList :: ReadS [RuleActionOverride]
$creadList :: ReadS [RuleActionOverride]
readsPrec :: Int -> ReadS RuleActionOverride
$creadsPrec :: Int -> ReadS RuleActionOverride
Prelude.Read, Int -> RuleActionOverride -> ShowS
[RuleActionOverride] -> ShowS
RuleActionOverride -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RuleActionOverride] -> ShowS
$cshowList :: [RuleActionOverride] -> ShowS
show :: RuleActionOverride -> String
$cshow :: RuleActionOverride -> String
showsPrec :: Int -> RuleActionOverride -> ShowS
$cshowsPrec :: Int -> RuleActionOverride -> ShowS
Prelude.Show, forall x. Rep RuleActionOverride x -> RuleActionOverride
forall x. RuleActionOverride -> Rep RuleActionOverride x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RuleActionOverride x -> RuleActionOverride
$cfrom :: forall x. RuleActionOverride -> Rep RuleActionOverride x
Prelude.Generic)

-- |
-- Create a value of 'RuleActionOverride' 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:
--
-- 'name', 'ruleActionOverride_name' - The name of the rule to override.
--
-- 'actionToUse', 'ruleActionOverride_actionToUse' - The override action to use, in place of the configured action of the
-- rule in the rule group.
newRuleActionOverride ::
  -- | 'name'
  Prelude.Text ->
  -- | 'actionToUse'
  RuleAction ->
  RuleActionOverride
newRuleActionOverride :: Text -> RuleAction -> RuleActionOverride
newRuleActionOverride Text
pName_ RuleAction
pActionToUse_ =
  RuleActionOverride'
    { $sel:name:RuleActionOverride' :: Text
name = Text
pName_,
      $sel:actionToUse:RuleActionOverride' :: RuleAction
actionToUse = RuleAction
pActionToUse_
    }

-- | The name of the rule to override.
ruleActionOverride_name :: Lens.Lens' RuleActionOverride Prelude.Text
ruleActionOverride_name :: Lens' RuleActionOverride Text
ruleActionOverride_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RuleActionOverride' {Text
name :: Text
$sel:name:RuleActionOverride' :: RuleActionOverride -> Text
name} -> Text
name) (\s :: RuleActionOverride
s@RuleActionOverride' {} Text
a -> RuleActionOverride
s {$sel:name:RuleActionOverride' :: Text
name = Text
a} :: RuleActionOverride)

-- | The override action to use, in place of the configured action of the
-- rule in the rule group.
ruleActionOverride_actionToUse :: Lens.Lens' RuleActionOverride RuleAction
ruleActionOverride_actionToUse :: Lens' RuleActionOverride RuleAction
ruleActionOverride_actionToUse = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RuleActionOverride' {RuleAction
actionToUse :: RuleAction
$sel:actionToUse:RuleActionOverride' :: RuleActionOverride -> RuleAction
actionToUse} -> RuleAction
actionToUse) (\s :: RuleActionOverride
s@RuleActionOverride' {} RuleAction
a -> RuleActionOverride
s {$sel:actionToUse:RuleActionOverride' :: RuleAction
actionToUse = RuleAction
a} :: RuleActionOverride)

instance Data.FromJSON RuleActionOverride where
  parseJSON :: Value -> Parser RuleActionOverride
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"RuleActionOverride"
      ( \Object
x ->
          Text -> RuleAction -> RuleActionOverride
RuleActionOverride'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Name")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"ActionToUse")
      )

instance Prelude.Hashable RuleActionOverride where
  hashWithSalt :: Int -> RuleActionOverride -> Int
hashWithSalt Int
_salt RuleActionOverride' {Text
RuleAction
actionToUse :: RuleAction
name :: Text
$sel:actionToUse:RuleActionOverride' :: RuleActionOverride -> RuleAction
$sel:name:RuleActionOverride' :: RuleActionOverride -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` RuleAction
actionToUse

instance Prelude.NFData RuleActionOverride where
  rnf :: RuleActionOverride -> ()
rnf RuleActionOverride' {Text
RuleAction
actionToUse :: RuleAction
name :: Text
$sel:actionToUse:RuleActionOverride' :: RuleActionOverride -> RuleAction
$sel:name:RuleActionOverride' :: RuleActionOverride -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf RuleAction
actionToUse

instance Data.ToJSON RuleActionOverride where
  toJSON :: RuleActionOverride -> Value
toJSON RuleActionOverride' {Text
RuleAction
actionToUse :: RuleAction
name :: Text
$sel:actionToUse:RuleActionOverride' :: RuleActionOverride -> RuleAction
$sel:name:RuleActionOverride' :: RuleActionOverride -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name),
            forall a. a -> Maybe a
Prelude.Just (Key
"ActionToUse" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= RuleAction
actionToUse)
          ]
      )