{-# 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.Lightsail.Types.HeaderObject
-- 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.Lightsail.Types.HeaderObject where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Lightsail.Types.ForwardValues
import Amazonka.Lightsail.Types.HeaderEnum
import qualified Amazonka.Prelude as Prelude

-- | Describes the request headers that a Lightsail distribution bases
-- caching on.
--
-- For the headers that you specify, your distribution caches separate
-- versions of the specified content based on the header values in viewer
-- requests. For example, suppose viewer requests for @logo.jpg@ contain a
-- custom @product@ header that has a value of either @acme@ or @apex@, and
-- you configure your distribution to cache your content based on values in
-- the @product@ header. Your distribution forwards the @product@ header to
-- the origin and caches the response from the origin once for each header
-- value.
--
-- /See:/ 'newHeaderObject' smart constructor.
data HeaderObject = HeaderObject'
  { -- | The specific headers to forward to your distribution\'s origin.
    HeaderObject -> Maybe [HeaderEnum]
headersAllowList :: Prelude.Maybe [HeaderEnum],
    -- | The headers that you want your distribution to forward to your origin
    -- and base caching on.
    --
    -- You can configure your distribution to do one of the following:
    --
    -- -   __@all@__ - Forward all headers to your origin.
    --
    -- -   __@none@__ - Forward only the default headers.
    --
    -- -   __@allow-list@__ - Forward only the headers you specify using the
    --     @headersAllowList@ parameter.
    HeaderObject -> Maybe ForwardValues
option :: Prelude.Maybe ForwardValues
  }
  deriving (HeaderObject -> HeaderObject -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HeaderObject -> HeaderObject -> Bool
$c/= :: HeaderObject -> HeaderObject -> Bool
== :: HeaderObject -> HeaderObject -> Bool
$c== :: HeaderObject -> HeaderObject -> Bool
Prelude.Eq, ReadPrec [HeaderObject]
ReadPrec HeaderObject
Int -> ReadS HeaderObject
ReadS [HeaderObject]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HeaderObject]
$creadListPrec :: ReadPrec [HeaderObject]
readPrec :: ReadPrec HeaderObject
$creadPrec :: ReadPrec HeaderObject
readList :: ReadS [HeaderObject]
$creadList :: ReadS [HeaderObject]
readsPrec :: Int -> ReadS HeaderObject
$creadsPrec :: Int -> ReadS HeaderObject
Prelude.Read, Int -> HeaderObject -> ShowS
[HeaderObject] -> ShowS
HeaderObject -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HeaderObject] -> ShowS
$cshowList :: [HeaderObject] -> ShowS
show :: HeaderObject -> String
$cshow :: HeaderObject -> String
showsPrec :: Int -> HeaderObject -> ShowS
$cshowsPrec :: Int -> HeaderObject -> ShowS
Prelude.Show, forall x. Rep HeaderObject x -> HeaderObject
forall x. HeaderObject -> Rep HeaderObject x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep HeaderObject x -> HeaderObject
$cfrom :: forall x. HeaderObject -> Rep HeaderObject x
Prelude.Generic)

-- |
-- Create a value of 'HeaderObject' 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:
--
-- 'headersAllowList', 'headerObject_headersAllowList' - The specific headers to forward to your distribution\'s origin.
--
-- 'option', 'headerObject_option' - The headers that you want your distribution to forward to your origin
-- and base caching on.
--
-- You can configure your distribution to do one of the following:
--
-- -   __@all@__ - Forward all headers to your origin.
--
-- -   __@none@__ - Forward only the default headers.
--
-- -   __@allow-list@__ - Forward only the headers you specify using the
--     @headersAllowList@ parameter.
newHeaderObject ::
  HeaderObject
newHeaderObject :: HeaderObject
newHeaderObject =
  HeaderObject'
    { $sel:headersAllowList:HeaderObject' :: Maybe [HeaderEnum]
headersAllowList = forall a. Maybe a
Prelude.Nothing,
      $sel:option:HeaderObject' :: Maybe ForwardValues
option = forall a. Maybe a
Prelude.Nothing
    }

-- | The specific headers to forward to your distribution\'s origin.
headerObject_headersAllowList :: Lens.Lens' HeaderObject (Prelude.Maybe [HeaderEnum])
headerObject_headersAllowList :: Lens' HeaderObject (Maybe [HeaderEnum])
headerObject_headersAllowList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HeaderObject' {Maybe [HeaderEnum]
headersAllowList :: Maybe [HeaderEnum]
$sel:headersAllowList:HeaderObject' :: HeaderObject -> Maybe [HeaderEnum]
headersAllowList} -> Maybe [HeaderEnum]
headersAllowList) (\s :: HeaderObject
s@HeaderObject' {} Maybe [HeaderEnum]
a -> HeaderObject
s {$sel:headersAllowList:HeaderObject' :: Maybe [HeaderEnum]
headersAllowList = Maybe [HeaderEnum]
a} :: HeaderObject) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The headers that you want your distribution to forward to your origin
-- and base caching on.
--
-- You can configure your distribution to do one of the following:
--
-- -   __@all@__ - Forward all headers to your origin.
--
-- -   __@none@__ - Forward only the default headers.
--
-- -   __@allow-list@__ - Forward only the headers you specify using the
--     @headersAllowList@ parameter.
headerObject_option :: Lens.Lens' HeaderObject (Prelude.Maybe ForwardValues)
headerObject_option :: Lens' HeaderObject (Maybe ForwardValues)
headerObject_option = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HeaderObject' {Maybe ForwardValues
option :: Maybe ForwardValues
$sel:option:HeaderObject' :: HeaderObject -> Maybe ForwardValues
option} -> Maybe ForwardValues
option) (\s :: HeaderObject
s@HeaderObject' {} Maybe ForwardValues
a -> HeaderObject
s {$sel:option:HeaderObject' :: Maybe ForwardValues
option = Maybe ForwardValues
a} :: HeaderObject)

instance Data.FromJSON HeaderObject where
  parseJSON :: Value -> Parser HeaderObject
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"HeaderObject"
      ( \Object
x ->
          Maybe [HeaderEnum] -> Maybe ForwardValues -> HeaderObject
HeaderObject'
            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
"headersAllowList"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"option")
      )

instance Prelude.Hashable HeaderObject where
  hashWithSalt :: Int -> HeaderObject -> Int
hashWithSalt Int
_salt HeaderObject' {Maybe [HeaderEnum]
Maybe ForwardValues
option :: Maybe ForwardValues
headersAllowList :: Maybe [HeaderEnum]
$sel:option:HeaderObject' :: HeaderObject -> Maybe ForwardValues
$sel:headersAllowList:HeaderObject' :: HeaderObject -> Maybe [HeaderEnum]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [HeaderEnum]
headersAllowList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ForwardValues
option

instance Prelude.NFData HeaderObject where
  rnf :: HeaderObject -> ()
rnf HeaderObject' {Maybe [HeaderEnum]
Maybe ForwardValues
option :: Maybe ForwardValues
headersAllowList :: Maybe [HeaderEnum]
$sel:option:HeaderObject' :: HeaderObject -> Maybe ForwardValues
$sel:headersAllowList:HeaderObject' :: HeaderObject -> Maybe [HeaderEnum]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [HeaderEnum]
headersAllowList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ForwardValues
option

instance Data.ToJSON HeaderObject where
  toJSON :: HeaderObject -> Value
toJSON HeaderObject' {Maybe [HeaderEnum]
Maybe ForwardValues
option :: Maybe ForwardValues
headersAllowList :: Maybe [HeaderEnum]
$sel:option:HeaderObject' :: HeaderObject -> Maybe ForwardValues
$sel:headersAllowList:HeaderObject' :: HeaderObject -> Maybe [HeaderEnum]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"headersAllowList" 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 [HeaderEnum]
headersAllowList,
            (Key
"option" 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 ForwardValues
option
          ]
      )