{-# 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.NetworkFirewall.Types.IPSetReference
-- 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.NetworkFirewall.Types.IPSetReference 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

-- | Configures one or more IP set references for a Suricata-compatible rule
-- group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set
-- reference is a rule variable that references a resource that you create
-- and manage in another Amazon Web Services service, such as an Amazon VPC
-- prefix list. Network Firewall IP set references enable you to
-- dynamically update the contents of your rules. When you create, update,
-- or delete the IP set you are referencing in your rule, Network Firewall
-- automatically updates the rule\'s content with the changes. For more
-- information about IP set references in Network Firewall, see
-- <https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references Using IP set references>
-- in the /Network Firewall Developer Guide/.
--
-- Network Firewall currently supports only
-- <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html Amazon VPC prefix lists>
-- as IP set references.
--
-- /See:/ 'newIPSetReference' smart constructor.
data IPSetReference = IPSetReference'
  { -- | The Amazon Resource Name (ARN) of the resource that you are referencing
    -- in your rule group.
    IPSetReference -> Maybe Text
referenceArn :: Prelude.Maybe Prelude.Text
  }
  deriving (IPSetReference -> IPSetReference -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: IPSetReference -> IPSetReference -> Bool
$c/= :: IPSetReference -> IPSetReference -> Bool
== :: IPSetReference -> IPSetReference -> Bool
$c== :: IPSetReference -> IPSetReference -> Bool
Prelude.Eq, ReadPrec [IPSetReference]
ReadPrec IPSetReference
Int -> ReadS IPSetReference
ReadS [IPSetReference]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [IPSetReference]
$creadListPrec :: ReadPrec [IPSetReference]
readPrec :: ReadPrec IPSetReference
$creadPrec :: ReadPrec IPSetReference
readList :: ReadS [IPSetReference]
$creadList :: ReadS [IPSetReference]
readsPrec :: Int -> ReadS IPSetReference
$creadsPrec :: Int -> ReadS IPSetReference
Prelude.Read, Int -> IPSetReference -> ShowS
[IPSetReference] -> ShowS
IPSetReference -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [IPSetReference] -> ShowS
$cshowList :: [IPSetReference] -> ShowS
show :: IPSetReference -> String
$cshow :: IPSetReference -> String
showsPrec :: Int -> IPSetReference -> ShowS
$cshowsPrec :: Int -> IPSetReference -> ShowS
Prelude.Show, forall x. Rep IPSetReference x -> IPSetReference
forall x. IPSetReference -> Rep IPSetReference x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep IPSetReference x -> IPSetReference
$cfrom :: forall x. IPSetReference -> Rep IPSetReference x
Prelude.Generic)

-- |
-- Create a value of 'IPSetReference' 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:
--
-- 'referenceArn', 'iPSetReference_referenceArn' - The Amazon Resource Name (ARN) of the resource that you are referencing
-- in your rule group.
newIPSetReference ::
  IPSetReference
newIPSetReference :: IPSetReference
newIPSetReference =
  IPSetReference' {$sel:referenceArn:IPSetReference' :: Maybe Text
referenceArn = forall a. Maybe a
Prelude.Nothing}

-- | The Amazon Resource Name (ARN) of the resource that you are referencing
-- in your rule group.
iPSetReference_referenceArn :: Lens.Lens' IPSetReference (Prelude.Maybe Prelude.Text)
iPSetReference_referenceArn :: Lens' IPSetReference (Maybe Text)
iPSetReference_referenceArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IPSetReference' {Maybe Text
referenceArn :: Maybe Text
$sel:referenceArn:IPSetReference' :: IPSetReference -> Maybe Text
referenceArn} -> Maybe Text
referenceArn) (\s :: IPSetReference
s@IPSetReference' {} Maybe Text
a -> IPSetReference
s {$sel:referenceArn:IPSetReference' :: Maybe Text
referenceArn = Maybe Text
a} :: IPSetReference)

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

instance Prelude.Hashable IPSetReference where
  hashWithSalt :: Int -> IPSetReference -> Int
hashWithSalt Int
_salt IPSetReference' {Maybe Text
referenceArn :: Maybe Text
$sel:referenceArn:IPSetReference' :: IPSetReference -> Maybe Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
referenceArn

instance Prelude.NFData IPSetReference where
  rnf :: IPSetReference -> ()
rnf IPSetReference' {Maybe Text
referenceArn :: Maybe Text
$sel:referenceArn:IPSetReference' :: IPSetReference -> Maybe Text
..} = forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
referenceArn

instance Data.ToJSON IPSetReference where
  toJSON :: IPSetReference -> Value
toJSON IPSetReference' {Maybe Text
referenceArn :: Maybe Text
$sel:referenceArn:IPSetReference' :: IPSetReference -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [(Key
"ReferenceArn" 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 Text
referenceArn]
      )