{-# 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.IPSetReferenceStatement
-- 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.IPSetReferenceStatement 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.IPSetForwardedIPConfig

-- | A rule statement used to detect web requests coming from particular IP
-- addresses or address ranges. To use this, create an IPSet that specifies
-- the addresses you want to detect, then use the ARN of that set in this
-- statement. To create an IP set, see CreateIPSet.
--
-- Each IP set rule statement references an IP set. You create and maintain
-- the set independent of your rules. This allows you to use the single set
-- in multiple rules. When you update the referenced set, WAF automatically
-- updates all rules that reference it.
--
-- /See:/ 'newIPSetReferenceStatement' smart constructor.
data IPSetReferenceStatement = IPSetReferenceStatement'
  { -- | The configuration for inspecting IP addresses in an HTTP header that you
    -- specify, instead of using the IP address that\'s reported by the web
    -- request origin. Commonly, this is the X-Forwarded-For (XFF) header, but
    -- you can specify any header name.
    --
    -- If the specified header isn\'t present in the request, WAF doesn\'t
    -- apply the rule to the web request at all.
    IPSetReferenceStatement -> Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig :: Prelude.Maybe IPSetForwardedIPConfig,
    -- | The Amazon Resource Name (ARN) of the IPSet that this statement
    -- references.
    IPSetReferenceStatement -> Text
arn :: Prelude.Text
  }
  deriving (IPSetReferenceStatement -> IPSetReferenceStatement -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: IPSetReferenceStatement -> IPSetReferenceStatement -> Bool
$c/= :: IPSetReferenceStatement -> IPSetReferenceStatement -> Bool
== :: IPSetReferenceStatement -> IPSetReferenceStatement -> Bool
$c== :: IPSetReferenceStatement -> IPSetReferenceStatement -> Bool
Prelude.Eq, ReadPrec [IPSetReferenceStatement]
ReadPrec IPSetReferenceStatement
Int -> ReadS IPSetReferenceStatement
ReadS [IPSetReferenceStatement]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [IPSetReferenceStatement]
$creadListPrec :: ReadPrec [IPSetReferenceStatement]
readPrec :: ReadPrec IPSetReferenceStatement
$creadPrec :: ReadPrec IPSetReferenceStatement
readList :: ReadS [IPSetReferenceStatement]
$creadList :: ReadS [IPSetReferenceStatement]
readsPrec :: Int -> ReadS IPSetReferenceStatement
$creadsPrec :: Int -> ReadS IPSetReferenceStatement
Prelude.Read, Int -> IPSetReferenceStatement -> ShowS
[IPSetReferenceStatement] -> ShowS
IPSetReferenceStatement -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [IPSetReferenceStatement] -> ShowS
$cshowList :: [IPSetReferenceStatement] -> ShowS
show :: IPSetReferenceStatement -> String
$cshow :: IPSetReferenceStatement -> String
showsPrec :: Int -> IPSetReferenceStatement -> ShowS
$cshowsPrec :: Int -> IPSetReferenceStatement -> ShowS
Prelude.Show, forall x. Rep IPSetReferenceStatement x -> IPSetReferenceStatement
forall x. IPSetReferenceStatement -> Rep IPSetReferenceStatement x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep IPSetReferenceStatement x -> IPSetReferenceStatement
$cfrom :: forall x. IPSetReferenceStatement -> Rep IPSetReferenceStatement x
Prelude.Generic)

-- |
-- Create a value of 'IPSetReferenceStatement' 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:
--
-- 'iPSetForwardedIPConfig', 'iPSetReferenceStatement_iPSetForwardedIPConfig' - The configuration for inspecting IP addresses in an HTTP header that you
-- specify, instead of using the IP address that\'s reported by the web
-- request origin. Commonly, this is the X-Forwarded-For (XFF) header, but
-- you can specify any header name.
--
-- If the specified header isn\'t present in the request, WAF doesn\'t
-- apply the rule to the web request at all.
--
-- 'arn', 'iPSetReferenceStatement_arn' - The Amazon Resource Name (ARN) of the IPSet that this statement
-- references.
newIPSetReferenceStatement ::
  -- | 'arn'
  Prelude.Text ->
  IPSetReferenceStatement
newIPSetReferenceStatement :: Text -> IPSetReferenceStatement
newIPSetReferenceStatement Text
pARN_ =
  IPSetReferenceStatement'
    { $sel:iPSetForwardedIPConfig:IPSetReferenceStatement' :: Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig =
        forall a. Maybe a
Prelude.Nothing,
      $sel:arn:IPSetReferenceStatement' :: Text
arn = Text
pARN_
    }

-- | The configuration for inspecting IP addresses in an HTTP header that you
-- specify, instead of using the IP address that\'s reported by the web
-- request origin. Commonly, this is the X-Forwarded-For (XFF) header, but
-- you can specify any header name.
--
-- If the specified header isn\'t present in the request, WAF doesn\'t
-- apply the rule to the web request at all.
iPSetReferenceStatement_iPSetForwardedIPConfig :: Lens.Lens' IPSetReferenceStatement (Prelude.Maybe IPSetForwardedIPConfig)
iPSetReferenceStatement_iPSetForwardedIPConfig :: Lens' IPSetReferenceStatement (Maybe IPSetForwardedIPConfig)
iPSetReferenceStatement_iPSetForwardedIPConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IPSetReferenceStatement' {Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig :: Maybe IPSetForwardedIPConfig
$sel:iPSetForwardedIPConfig:IPSetReferenceStatement' :: IPSetReferenceStatement -> Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig} -> Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig) (\s :: IPSetReferenceStatement
s@IPSetReferenceStatement' {} Maybe IPSetForwardedIPConfig
a -> IPSetReferenceStatement
s {$sel:iPSetForwardedIPConfig:IPSetReferenceStatement' :: Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig = Maybe IPSetForwardedIPConfig
a} :: IPSetReferenceStatement)

-- | The Amazon Resource Name (ARN) of the IPSet that this statement
-- references.
iPSetReferenceStatement_arn :: Lens.Lens' IPSetReferenceStatement Prelude.Text
iPSetReferenceStatement_arn :: Lens' IPSetReferenceStatement Text
iPSetReferenceStatement_arn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IPSetReferenceStatement' {Text
arn :: Text
$sel:arn:IPSetReferenceStatement' :: IPSetReferenceStatement -> Text
arn} -> Text
arn) (\s :: IPSetReferenceStatement
s@IPSetReferenceStatement' {} Text
a -> IPSetReferenceStatement
s {$sel:arn:IPSetReferenceStatement' :: Text
arn = Text
a} :: IPSetReferenceStatement)

instance Data.FromJSON IPSetReferenceStatement where
  parseJSON :: Value -> Parser IPSetReferenceStatement
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"IPSetReferenceStatement"
      ( \Object
x ->
          Maybe IPSetForwardedIPConfig -> Text -> IPSetReferenceStatement
IPSetReferenceStatement'
            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
"IPSetForwardedIPConfig")
            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
"ARN")
      )

instance Prelude.Hashable IPSetReferenceStatement where
  hashWithSalt :: Int -> IPSetReferenceStatement -> Int
hashWithSalt Int
_salt IPSetReferenceStatement' {Maybe IPSetForwardedIPConfig
Text
arn :: Text
iPSetForwardedIPConfig :: Maybe IPSetForwardedIPConfig
$sel:arn:IPSetReferenceStatement' :: IPSetReferenceStatement -> Text
$sel:iPSetForwardedIPConfig:IPSetReferenceStatement' :: IPSetReferenceStatement -> Maybe IPSetForwardedIPConfig
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
arn

instance Prelude.NFData IPSetReferenceStatement where
  rnf :: IPSetReferenceStatement -> ()
rnf IPSetReferenceStatement' {Maybe IPSetForwardedIPConfig
Text
arn :: Text
iPSetForwardedIPConfig :: Maybe IPSetForwardedIPConfig
$sel:arn:IPSetReferenceStatement' :: IPSetReferenceStatement -> Text
$sel:iPSetForwardedIPConfig:IPSetReferenceStatement' :: IPSetReferenceStatement -> Maybe IPSetForwardedIPConfig
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe IPSetForwardedIPConfig
iPSetForwardedIPConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
arn

instance Data.ToJSON IPSetReferenceStatement where
  toJSON :: IPSetReferenceStatement -> Value
toJSON IPSetReferenceStatement' {Maybe IPSetForwardedIPConfig
Text
arn :: Text
iPSetForwardedIPConfig :: Maybe IPSetForwardedIPConfig
$sel:arn:IPSetReferenceStatement' :: IPSetReferenceStatement -> Text
$sel:iPSetForwardedIPConfig:IPSetReferenceStatement' :: IPSetReferenceStatement -> Maybe IPSetForwardedIPConfig
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"IPSetForwardedIPConfig" 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 IPSetForwardedIPConfig
iPSetForwardedIPConfig,
            forall a. a -> Maybe a
Prelude.Just (Key
"ARN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
arn)
          ]
      )