{-# 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.Athena.Types.EncryptionConfiguration
-- 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.Athena.Types.EncryptionConfiguration where

import Amazonka.Athena.Types.EncryptionOption
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

-- | If query results are encrypted in Amazon S3, indicates the encryption
-- option used (for example, @SSE_KMS@ or @CSE_KMS@) and key information.
--
-- /See:/ 'newEncryptionConfiguration' smart constructor.
data EncryptionConfiguration = EncryptionConfiguration'
  { -- | For @SSE_KMS@ and @CSE_KMS@, this is the KMS key ARN or ID.
    EncryptionConfiguration -> Maybe Text
kmsKey :: Prelude.Maybe Prelude.Text,
    -- | Indicates whether Amazon S3 server-side encryption with Amazon
    -- S3-managed keys (@SSE_S3@), server-side encryption with KMS-managed keys
    -- (@SSE_KMS@), or client-side encryption with KMS-managed keys (@CSE_KMS@)
    -- is used.
    --
    -- If a query runs in a workgroup and the workgroup overrides client-side
    -- settings, then the workgroup\'s setting for encryption is used. It
    -- specifies whether query results must be encrypted, for all queries that
    -- run in this workgroup.
    EncryptionConfiguration -> EncryptionOption
encryptionOption :: EncryptionOption
  }
  deriving (EncryptionConfiguration -> EncryptionConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EncryptionConfiguration -> EncryptionConfiguration -> Bool
$c/= :: EncryptionConfiguration -> EncryptionConfiguration -> Bool
== :: EncryptionConfiguration -> EncryptionConfiguration -> Bool
$c== :: EncryptionConfiguration -> EncryptionConfiguration -> Bool
Prelude.Eq, ReadPrec [EncryptionConfiguration]
ReadPrec EncryptionConfiguration
Int -> ReadS EncryptionConfiguration
ReadS [EncryptionConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EncryptionConfiguration]
$creadListPrec :: ReadPrec [EncryptionConfiguration]
readPrec :: ReadPrec EncryptionConfiguration
$creadPrec :: ReadPrec EncryptionConfiguration
readList :: ReadS [EncryptionConfiguration]
$creadList :: ReadS [EncryptionConfiguration]
readsPrec :: Int -> ReadS EncryptionConfiguration
$creadsPrec :: Int -> ReadS EncryptionConfiguration
Prelude.Read, Int -> EncryptionConfiguration -> ShowS
[EncryptionConfiguration] -> ShowS
EncryptionConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EncryptionConfiguration] -> ShowS
$cshowList :: [EncryptionConfiguration] -> ShowS
show :: EncryptionConfiguration -> String
$cshow :: EncryptionConfiguration -> String
showsPrec :: Int -> EncryptionConfiguration -> ShowS
$cshowsPrec :: Int -> EncryptionConfiguration -> ShowS
Prelude.Show, forall x. Rep EncryptionConfiguration x -> EncryptionConfiguration
forall x. EncryptionConfiguration -> Rep EncryptionConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EncryptionConfiguration x -> EncryptionConfiguration
$cfrom :: forall x. EncryptionConfiguration -> Rep EncryptionConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'EncryptionConfiguration' 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:
--
-- 'kmsKey', 'encryptionConfiguration_kmsKey' - For @SSE_KMS@ and @CSE_KMS@, this is the KMS key ARN or ID.
--
-- 'encryptionOption', 'encryptionConfiguration_encryptionOption' - Indicates whether Amazon S3 server-side encryption with Amazon
-- S3-managed keys (@SSE_S3@), server-side encryption with KMS-managed keys
-- (@SSE_KMS@), or client-side encryption with KMS-managed keys (@CSE_KMS@)
-- is used.
--
-- If a query runs in a workgroup and the workgroup overrides client-side
-- settings, then the workgroup\'s setting for encryption is used. It
-- specifies whether query results must be encrypted, for all queries that
-- run in this workgroup.
newEncryptionConfiguration ::
  -- | 'encryptionOption'
  EncryptionOption ->
  EncryptionConfiguration
newEncryptionConfiguration :: EncryptionOption -> EncryptionConfiguration
newEncryptionConfiguration EncryptionOption
pEncryptionOption_ =
  EncryptionConfiguration'
    { $sel:kmsKey:EncryptionConfiguration' :: Maybe Text
kmsKey = forall a. Maybe a
Prelude.Nothing,
      $sel:encryptionOption:EncryptionConfiguration' :: EncryptionOption
encryptionOption = EncryptionOption
pEncryptionOption_
    }

-- | For @SSE_KMS@ and @CSE_KMS@, this is the KMS key ARN or ID.
encryptionConfiguration_kmsKey :: Lens.Lens' EncryptionConfiguration (Prelude.Maybe Prelude.Text)
encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text)
encryptionConfiguration_kmsKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EncryptionConfiguration' {Maybe Text
kmsKey :: Maybe Text
$sel:kmsKey:EncryptionConfiguration' :: EncryptionConfiguration -> Maybe Text
kmsKey} -> Maybe Text
kmsKey) (\s :: EncryptionConfiguration
s@EncryptionConfiguration' {} Maybe Text
a -> EncryptionConfiguration
s {$sel:kmsKey:EncryptionConfiguration' :: Maybe Text
kmsKey = Maybe Text
a} :: EncryptionConfiguration)

-- | Indicates whether Amazon S3 server-side encryption with Amazon
-- S3-managed keys (@SSE_S3@), server-side encryption with KMS-managed keys
-- (@SSE_KMS@), or client-side encryption with KMS-managed keys (@CSE_KMS@)
-- is used.
--
-- If a query runs in a workgroup and the workgroup overrides client-side
-- settings, then the workgroup\'s setting for encryption is used. It
-- specifies whether query results must be encrypted, for all queries that
-- run in this workgroup.
encryptionConfiguration_encryptionOption :: Lens.Lens' EncryptionConfiguration EncryptionOption
encryptionConfiguration_encryptionOption :: Lens' EncryptionConfiguration EncryptionOption
encryptionConfiguration_encryptionOption = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EncryptionConfiguration' {EncryptionOption
encryptionOption :: EncryptionOption
$sel:encryptionOption:EncryptionConfiguration' :: EncryptionConfiguration -> EncryptionOption
encryptionOption} -> EncryptionOption
encryptionOption) (\s :: EncryptionConfiguration
s@EncryptionConfiguration' {} EncryptionOption
a -> EncryptionConfiguration
s {$sel:encryptionOption:EncryptionConfiguration' :: EncryptionOption
encryptionOption = EncryptionOption
a} :: EncryptionConfiguration)

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

instance Prelude.Hashable EncryptionConfiguration where
  hashWithSalt :: Int -> EncryptionConfiguration -> Int
hashWithSalt Int
_salt EncryptionConfiguration' {Maybe Text
EncryptionOption
encryptionOption :: EncryptionOption
kmsKey :: Maybe Text
$sel:encryptionOption:EncryptionConfiguration' :: EncryptionConfiguration -> EncryptionOption
$sel:kmsKey:EncryptionConfiguration' :: EncryptionConfiguration -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
kmsKey
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` EncryptionOption
encryptionOption

instance Prelude.NFData EncryptionConfiguration where
  rnf :: EncryptionConfiguration -> ()
rnf EncryptionConfiguration' {Maybe Text
EncryptionOption
encryptionOption :: EncryptionOption
kmsKey :: Maybe Text
$sel:encryptionOption:EncryptionConfiguration' :: EncryptionConfiguration -> EncryptionOption
$sel:kmsKey:EncryptionConfiguration' :: EncryptionConfiguration -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
kmsKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf EncryptionOption
encryptionOption

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