{-# 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.CloudFront.Types.OriginAccessControlConfig
-- 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.CloudFront.Types.OriginAccessControlConfig where

import Amazonka.CloudFront.Types.OriginAccessControlOriginTypes
import Amazonka.CloudFront.Types.OriginAccessControlSigningBehaviors
import Amazonka.CloudFront.Types.OriginAccessControlSigningProtocols
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

-- | A CloudFront origin access control configuration.
--
-- /See:/ 'newOriginAccessControlConfig' smart constructor.
data OriginAccessControlConfig = OriginAccessControlConfig'
  { -- | A description of the origin access control.
    OriginAccessControlConfig -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | A name to identify the origin access control.
    OriginAccessControlConfig -> Text
name :: Prelude.Text,
    -- | The signing protocol of the origin access control, which determines how
    -- CloudFront signs (authenticates) requests. The only valid value is
    -- @sigv4@.
    OriginAccessControlConfig -> OriginAccessControlSigningProtocols
signingProtocol :: OriginAccessControlSigningProtocols,
    -- | Specifies which requests CloudFront signs (adds authentication
    -- information to). Specify @always@ for the most common use case. For more
    -- information, see
    -- <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings origin access control advanced settings>
    -- in the /Amazon CloudFront Developer Guide/.
    --
    -- This field can have one of the following values:
    --
    -- -   @always@ – CloudFront signs all origin requests, overwriting the
    --     @Authorization@ header from the viewer request if one exists.
    --
    -- -   @never@ – CloudFront doesn\'t sign any origin requests. This value
    --     turns off origin access control for all origins in all distributions
    --     that use this origin access control.
    --
    -- -   @no-override@ – If the viewer request doesn\'t contain the
    --     @Authorization@ header, then CloudFront signs the origin request. If
    --     the viewer request contains the @Authorization@ header, then
    --     CloudFront doesn\'t sign the origin request and instead passes along
    --     the @Authorization@ header from the viewer request. __WARNING: To
    --     pass along the @Authorization@ header from the viewer request, you
    --     /must/ add the @Authorization@ header to a
    --     <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html cache policy>
    --     for all cache behaviors that use origins associated with this origin
    --     access control.__
    OriginAccessControlConfig -> OriginAccessControlSigningBehaviors
signingBehavior :: OriginAccessControlSigningBehaviors,
    -- | The type of origin that this origin access control is for. The only
    -- valid value is @s3@.
    OriginAccessControlConfig -> OriginAccessControlOriginTypes
originAccessControlOriginType :: OriginAccessControlOriginTypes
  }
  deriving (OriginAccessControlConfig -> OriginAccessControlConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: OriginAccessControlConfig -> OriginAccessControlConfig -> Bool
$c/= :: OriginAccessControlConfig -> OriginAccessControlConfig -> Bool
== :: OriginAccessControlConfig -> OriginAccessControlConfig -> Bool
$c== :: OriginAccessControlConfig -> OriginAccessControlConfig -> Bool
Prelude.Eq, ReadPrec [OriginAccessControlConfig]
ReadPrec OriginAccessControlConfig
Int -> ReadS OriginAccessControlConfig
ReadS [OriginAccessControlConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [OriginAccessControlConfig]
$creadListPrec :: ReadPrec [OriginAccessControlConfig]
readPrec :: ReadPrec OriginAccessControlConfig
$creadPrec :: ReadPrec OriginAccessControlConfig
readList :: ReadS [OriginAccessControlConfig]
$creadList :: ReadS [OriginAccessControlConfig]
readsPrec :: Int -> ReadS OriginAccessControlConfig
$creadsPrec :: Int -> ReadS OriginAccessControlConfig
Prelude.Read, Int -> OriginAccessControlConfig -> ShowS
[OriginAccessControlConfig] -> ShowS
OriginAccessControlConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [OriginAccessControlConfig] -> ShowS
$cshowList :: [OriginAccessControlConfig] -> ShowS
show :: OriginAccessControlConfig -> String
$cshow :: OriginAccessControlConfig -> String
showsPrec :: Int -> OriginAccessControlConfig -> ShowS
$cshowsPrec :: Int -> OriginAccessControlConfig -> ShowS
Prelude.Show, forall x.
Rep OriginAccessControlConfig x -> OriginAccessControlConfig
forall x.
OriginAccessControlConfig -> Rep OriginAccessControlConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep OriginAccessControlConfig x -> OriginAccessControlConfig
$cfrom :: forall x.
OriginAccessControlConfig -> Rep OriginAccessControlConfig x
Prelude.Generic)

-- |
-- Create a value of 'OriginAccessControlConfig' 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:
--
-- 'description', 'originAccessControlConfig_description' - A description of the origin access control.
--
-- 'name', 'originAccessControlConfig_name' - A name to identify the origin access control.
--
-- 'signingProtocol', 'originAccessControlConfig_signingProtocol' - The signing protocol of the origin access control, which determines how
-- CloudFront signs (authenticates) requests. The only valid value is
-- @sigv4@.
--
-- 'signingBehavior', 'originAccessControlConfig_signingBehavior' - Specifies which requests CloudFront signs (adds authentication
-- information to). Specify @always@ for the most common use case. For more
-- information, see
-- <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings origin access control advanced settings>
-- in the /Amazon CloudFront Developer Guide/.
--
-- This field can have one of the following values:
--
-- -   @always@ – CloudFront signs all origin requests, overwriting the
--     @Authorization@ header from the viewer request if one exists.
--
-- -   @never@ – CloudFront doesn\'t sign any origin requests. This value
--     turns off origin access control for all origins in all distributions
--     that use this origin access control.
--
-- -   @no-override@ – If the viewer request doesn\'t contain the
--     @Authorization@ header, then CloudFront signs the origin request. If
--     the viewer request contains the @Authorization@ header, then
--     CloudFront doesn\'t sign the origin request and instead passes along
--     the @Authorization@ header from the viewer request. __WARNING: To
--     pass along the @Authorization@ header from the viewer request, you
--     /must/ add the @Authorization@ header to a
--     <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html cache policy>
--     for all cache behaviors that use origins associated with this origin
--     access control.__
--
-- 'originAccessControlOriginType', 'originAccessControlConfig_originAccessControlOriginType' - The type of origin that this origin access control is for. The only
-- valid value is @s3@.
newOriginAccessControlConfig ::
  -- | 'name'
  Prelude.Text ->
  -- | 'signingProtocol'
  OriginAccessControlSigningProtocols ->
  -- | 'signingBehavior'
  OriginAccessControlSigningBehaviors ->
  -- | 'originAccessControlOriginType'
  OriginAccessControlOriginTypes ->
  OriginAccessControlConfig
newOriginAccessControlConfig :: Text
-> OriginAccessControlSigningProtocols
-> OriginAccessControlSigningBehaviors
-> OriginAccessControlOriginTypes
-> OriginAccessControlConfig
newOriginAccessControlConfig
  Text
pName_
  OriginAccessControlSigningProtocols
pSigningProtocol_
  OriginAccessControlSigningBehaviors
pSigningBehavior_
  OriginAccessControlOriginTypes
pOriginAccessControlOriginType_ =
    OriginAccessControlConfig'
      { $sel:description:OriginAccessControlConfig' :: Maybe Text
description =
          forall a. Maybe a
Prelude.Nothing,
        $sel:name:OriginAccessControlConfig' :: Text
name = Text
pName_,
        $sel:signingProtocol:OriginAccessControlConfig' :: OriginAccessControlSigningProtocols
signingProtocol = OriginAccessControlSigningProtocols
pSigningProtocol_,
        $sel:signingBehavior:OriginAccessControlConfig' :: OriginAccessControlSigningBehaviors
signingBehavior = OriginAccessControlSigningBehaviors
pSigningBehavior_,
        $sel:originAccessControlOriginType:OriginAccessControlConfig' :: OriginAccessControlOriginTypes
originAccessControlOriginType =
          OriginAccessControlOriginTypes
pOriginAccessControlOriginType_
      }

-- | A description of the origin access control.
originAccessControlConfig_description :: Lens.Lens' OriginAccessControlConfig (Prelude.Maybe Prelude.Text)
originAccessControlConfig_description :: Lens' OriginAccessControlConfig (Maybe Text)
originAccessControlConfig_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OriginAccessControlConfig' {Maybe Text
description :: Maybe Text
$sel:description:OriginAccessControlConfig' :: OriginAccessControlConfig -> Maybe Text
description} -> Maybe Text
description) (\s :: OriginAccessControlConfig
s@OriginAccessControlConfig' {} Maybe Text
a -> OriginAccessControlConfig
s {$sel:description:OriginAccessControlConfig' :: Maybe Text
description = Maybe Text
a} :: OriginAccessControlConfig)

-- | A name to identify the origin access control.
originAccessControlConfig_name :: Lens.Lens' OriginAccessControlConfig Prelude.Text
originAccessControlConfig_name :: Lens' OriginAccessControlConfig Text
originAccessControlConfig_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OriginAccessControlConfig' {Text
name :: Text
$sel:name:OriginAccessControlConfig' :: OriginAccessControlConfig -> Text
name} -> Text
name) (\s :: OriginAccessControlConfig
s@OriginAccessControlConfig' {} Text
a -> OriginAccessControlConfig
s {$sel:name:OriginAccessControlConfig' :: Text
name = Text
a} :: OriginAccessControlConfig)

-- | The signing protocol of the origin access control, which determines how
-- CloudFront signs (authenticates) requests. The only valid value is
-- @sigv4@.
originAccessControlConfig_signingProtocol :: Lens.Lens' OriginAccessControlConfig OriginAccessControlSigningProtocols
originAccessControlConfig_signingProtocol :: Lens' OriginAccessControlConfig OriginAccessControlSigningProtocols
originAccessControlConfig_signingProtocol = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OriginAccessControlConfig' {OriginAccessControlSigningProtocols
signingProtocol :: OriginAccessControlSigningProtocols
$sel:signingProtocol:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningProtocols
signingProtocol} -> OriginAccessControlSigningProtocols
signingProtocol) (\s :: OriginAccessControlConfig
s@OriginAccessControlConfig' {} OriginAccessControlSigningProtocols
a -> OriginAccessControlConfig
s {$sel:signingProtocol:OriginAccessControlConfig' :: OriginAccessControlSigningProtocols
signingProtocol = OriginAccessControlSigningProtocols
a} :: OriginAccessControlConfig)

-- | Specifies which requests CloudFront signs (adds authentication
-- information to). Specify @always@ for the most common use case. For more
-- information, see
-- <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings origin access control advanced settings>
-- in the /Amazon CloudFront Developer Guide/.
--
-- This field can have one of the following values:
--
-- -   @always@ – CloudFront signs all origin requests, overwriting the
--     @Authorization@ header from the viewer request if one exists.
--
-- -   @never@ – CloudFront doesn\'t sign any origin requests. This value
--     turns off origin access control for all origins in all distributions
--     that use this origin access control.
--
-- -   @no-override@ – If the viewer request doesn\'t contain the
--     @Authorization@ header, then CloudFront signs the origin request. If
--     the viewer request contains the @Authorization@ header, then
--     CloudFront doesn\'t sign the origin request and instead passes along
--     the @Authorization@ header from the viewer request. __WARNING: To
--     pass along the @Authorization@ header from the viewer request, you
--     /must/ add the @Authorization@ header to a
--     <https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html cache policy>
--     for all cache behaviors that use origins associated with this origin
--     access control.__
originAccessControlConfig_signingBehavior :: Lens.Lens' OriginAccessControlConfig OriginAccessControlSigningBehaviors
originAccessControlConfig_signingBehavior :: Lens' OriginAccessControlConfig OriginAccessControlSigningBehaviors
originAccessControlConfig_signingBehavior = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OriginAccessControlConfig' {OriginAccessControlSigningBehaviors
signingBehavior :: OriginAccessControlSigningBehaviors
$sel:signingBehavior:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningBehaviors
signingBehavior} -> OriginAccessControlSigningBehaviors
signingBehavior) (\s :: OriginAccessControlConfig
s@OriginAccessControlConfig' {} OriginAccessControlSigningBehaviors
a -> OriginAccessControlConfig
s {$sel:signingBehavior:OriginAccessControlConfig' :: OriginAccessControlSigningBehaviors
signingBehavior = OriginAccessControlSigningBehaviors
a} :: OriginAccessControlConfig)

-- | The type of origin that this origin access control is for. The only
-- valid value is @s3@.
originAccessControlConfig_originAccessControlOriginType :: Lens.Lens' OriginAccessControlConfig OriginAccessControlOriginTypes
originAccessControlConfig_originAccessControlOriginType :: Lens' OriginAccessControlConfig OriginAccessControlOriginTypes
originAccessControlConfig_originAccessControlOriginType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OriginAccessControlConfig' {OriginAccessControlOriginTypes
originAccessControlOriginType :: OriginAccessControlOriginTypes
$sel:originAccessControlOriginType:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlOriginTypes
originAccessControlOriginType} -> OriginAccessControlOriginTypes
originAccessControlOriginType) (\s :: OriginAccessControlConfig
s@OriginAccessControlConfig' {} OriginAccessControlOriginTypes
a -> OriginAccessControlConfig
s {$sel:originAccessControlOriginType:OriginAccessControlConfig' :: OriginAccessControlOriginTypes
originAccessControlOriginType = OriginAccessControlOriginTypes
a} :: OriginAccessControlConfig)

instance Data.FromXML OriginAccessControlConfig where
  parseXML :: [Node] -> Either String OriginAccessControlConfig
parseXML [Node]
x =
    Maybe Text
-> Text
-> OriginAccessControlSigningProtocols
-> OriginAccessControlSigningBehaviors
-> OriginAccessControlOriginTypes
-> OriginAccessControlConfig
OriginAccessControlConfig'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Description")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"Name")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"SigningProtocol")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"SigningBehavior")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"OriginAccessControlOriginType")

instance Prelude.Hashable OriginAccessControlConfig where
  hashWithSalt :: Int -> OriginAccessControlConfig -> Int
hashWithSalt Int
_salt OriginAccessControlConfig' {Maybe Text
Text
OriginAccessControlOriginTypes
OriginAccessControlSigningBehaviors
OriginAccessControlSigningProtocols
originAccessControlOriginType :: OriginAccessControlOriginTypes
signingBehavior :: OriginAccessControlSigningBehaviors
signingProtocol :: OriginAccessControlSigningProtocols
name :: Text
description :: Maybe Text
$sel:originAccessControlOriginType:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlOriginTypes
$sel:signingBehavior:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningBehaviors
$sel:signingProtocol:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningProtocols
$sel:name:OriginAccessControlConfig' :: OriginAccessControlConfig -> Text
$sel:description:OriginAccessControlConfig' :: OriginAccessControlConfig -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` OriginAccessControlSigningProtocols
signingProtocol
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` OriginAccessControlSigningBehaviors
signingBehavior
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` OriginAccessControlOriginTypes
originAccessControlOriginType

instance Prelude.NFData OriginAccessControlConfig where
  rnf :: OriginAccessControlConfig -> ()
rnf OriginAccessControlConfig' {Maybe Text
Text
OriginAccessControlOriginTypes
OriginAccessControlSigningBehaviors
OriginAccessControlSigningProtocols
originAccessControlOriginType :: OriginAccessControlOriginTypes
signingBehavior :: OriginAccessControlSigningBehaviors
signingProtocol :: OriginAccessControlSigningProtocols
name :: Text
description :: Maybe Text
$sel:originAccessControlOriginType:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlOriginTypes
$sel:signingBehavior:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningBehaviors
$sel:signingProtocol:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningProtocols
$sel:name:OriginAccessControlConfig' :: OriginAccessControlConfig -> Text
$sel:description:OriginAccessControlConfig' :: OriginAccessControlConfig -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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 OriginAccessControlSigningProtocols
signingProtocol
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf OriginAccessControlSigningBehaviors
signingBehavior
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf OriginAccessControlOriginTypes
originAccessControlOriginType

instance Data.ToXML OriginAccessControlConfig where
  toXML :: OriginAccessControlConfig -> XML
toXML OriginAccessControlConfig' {Maybe Text
Text
OriginAccessControlOriginTypes
OriginAccessControlSigningBehaviors
OriginAccessControlSigningProtocols
originAccessControlOriginType :: OriginAccessControlOriginTypes
signingBehavior :: OriginAccessControlSigningBehaviors
signingProtocol :: OriginAccessControlSigningProtocols
name :: Text
description :: Maybe Text
$sel:originAccessControlOriginType:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlOriginTypes
$sel:signingBehavior:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningBehaviors
$sel:signingProtocol:OriginAccessControlConfig' :: OriginAccessControlConfig -> OriginAccessControlSigningProtocols
$sel:name:OriginAccessControlConfig' :: OriginAccessControlConfig -> Text
$sel:description:OriginAccessControlConfig' :: OriginAccessControlConfig -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ Name
"Description" forall a. ToXML a => Name -> a -> XML
Data.@= Maybe Text
description,
        Name
"Name" forall a. ToXML a => Name -> a -> XML
Data.@= Text
name,
        Name
"SigningProtocol" forall a. ToXML a => Name -> a -> XML
Data.@= OriginAccessControlSigningProtocols
signingProtocol,
        Name
"SigningBehavior" forall a. ToXML a => Name -> a -> XML
Data.@= OriginAccessControlSigningBehaviors
signingBehavior,
        Name
"OriginAccessControlOriginType"
          forall a. ToXML a => Name -> a -> XML
Data.@= OriginAccessControlOriginTypes
originAccessControlOriginType
      ]