{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Firehose.StartDeliveryStreamEncryption
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Enables server-side encryption (SSE) for the delivery stream.
--
-- This operation is asynchronous. It returns immediately. When you invoke
-- it, Kinesis Data Firehose first sets the encryption status of the stream
-- to @ENABLING@, and then to @ENABLED@. The encryption status of a
-- delivery stream is the @Status@ property in
-- DeliveryStreamEncryptionConfiguration. If the operation fails, the
-- encryption status changes to @ENABLING_FAILED@. You can continue to read
-- and write data to your delivery stream while the encryption status is
-- @ENABLING@, but the data is not encrypted. It can take up to 5 seconds
-- after the encryption status changes to @ENABLED@ before all records
-- written to the delivery stream are encrypted. To find out whether a
-- record or a batch of records was encrypted, check the response elements
-- PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted,
-- respectively.
--
-- To check the encryption status of a delivery stream, use
-- DescribeDeliveryStream.
--
-- Even if encryption is currently enabled for a delivery stream, you can
-- still invoke this operation on it to change the ARN of the CMK or both
-- its type and ARN. If you invoke this method to change the CMK, and the
-- old CMK is of type @CUSTOMER_MANAGED_CMK@, Kinesis Data Firehose
-- schedules the grant it had on the old CMK for retirement. If the new CMK
-- is of type @CUSTOMER_MANAGED_CMK@, Kinesis Data Firehose creates a grant
-- that enables it to use the new CMK to encrypt and decrypt data and to
-- manage the grant.
--
-- If a delivery stream already has encryption enabled and then you invoke
-- this operation to change the ARN of the CMK or both its type and ARN and
-- you get @ENABLING_FAILED@, this only means that the attempt to change
-- the CMK failed. In this case, encryption remains enabled with the old
-- CMK.
--
-- If the encryption status of your delivery stream is @ENABLING_FAILED@,
-- you can invoke this operation again with a valid CMK. The CMK must be
-- enabled and the key policy mustn\'t explicitly deny the permission for
-- Kinesis Data Firehose to invoke KMS encrypt and decrypt operations.
--
-- You can enable SSE for a delivery stream only if it\'s a delivery stream
-- that uses @DirectPut@ as its source.
--
-- The @StartDeliveryStreamEncryption@ and @StopDeliveryStreamEncryption@
-- operations have a combined limit of 25 calls per delivery stream per 24
-- hours. For example, you reach the limit if you call
-- @StartDeliveryStreamEncryption@ 13 times and
-- @StopDeliveryStreamEncryption@ 12 times for the same delivery stream in
-- a 24-hour period.
module Amazonka.Firehose.StartDeliveryStreamEncryption
  ( -- * Creating a Request
    StartDeliveryStreamEncryption (..),
    newStartDeliveryStreamEncryption,

    -- * Request Lenses
    startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput,
    startDeliveryStreamEncryption_deliveryStreamName,

    -- * Destructuring the Response
    StartDeliveryStreamEncryptionResponse (..),
    newStartDeliveryStreamEncryptionResponse,

    -- * Response Lenses
    startDeliveryStreamEncryptionResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Firehose.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newStartDeliveryStreamEncryption' smart constructor.
data StartDeliveryStreamEncryption = StartDeliveryStreamEncryption'
  { -- | Used to specify the type and Amazon Resource Name (ARN) of the KMS key
    -- needed for Server-Side Encryption (SSE).
    StartDeliveryStreamEncryption
-> Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput :: Prelude.Maybe DeliveryStreamEncryptionConfigurationInput,
    -- | The name of the delivery stream for which you want to enable server-side
    -- encryption (SSE).
    StartDeliveryStreamEncryption -> Text
deliveryStreamName :: Prelude.Text
  }
  deriving (StartDeliveryStreamEncryption
-> StartDeliveryStreamEncryption -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartDeliveryStreamEncryption
-> StartDeliveryStreamEncryption -> Bool
$c/= :: StartDeliveryStreamEncryption
-> StartDeliveryStreamEncryption -> Bool
== :: StartDeliveryStreamEncryption
-> StartDeliveryStreamEncryption -> Bool
$c== :: StartDeliveryStreamEncryption
-> StartDeliveryStreamEncryption -> Bool
Prelude.Eq, ReadPrec [StartDeliveryStreamEncryption]
ReadPrec StartDeliveryStreamEncryption
Int -> ReadS StartDeliveryStreamEncryption
ReadS [StartDeliveryStreamEncryption]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartDeliveryStreamEncryption]
$creadListPrec :: ReadPrec [StartDeliveryStreamEncryption]
readPrec :: ReadPrec StartDeliveryStreamEncryption
$creadPrec :: ReadPrec StartDeliveryStreamEncryption
readList :: ReadS [StartDeliveryStreamEncryption]
$creadList :: ReadS [StartDeliveryStreamEncryption]
readsPrec :: Int -> ReadS StartDeliveryStreamEncryption
$creadsPrec :: Int -> ReadS StartDeliveryStreamEncryption
Prelude.Read, Int -> StartDeliveryStreamEncryption -> ShowS
[StartDeliveryStreamEncryption] -> ShowS
StartDeliveryStreamEncryption -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartDeliveryStreamEncryption] -> ShowS
$cshowList :: [StartDeliveryStreamEncryption] -> ShowS
show :: StartDeliveryStreamEncryption -> String
$cshow :: StartDeliveryStreamEncryption -> String
showsPrec :: Int -> StartDeliveryStreamEncryption -> ShowS
$cshowsPrec :: Int -> StartDeliveryStreamEncryption -> ShowS
Prelude.Show, forall x.
Rep StartDeliveryStreamEncryption x
-> StartDeliveryStreamEncryption
forall x.
StartDeliveryStreamEncryption
-> Rep StartDeliveryStreamEncryption x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep StartDeliveryStreamEncryption x
-> StartDeliveryStreamEncryption
$cfrom :: forall x.
StartDeliveryStreamEncryption
-> Rep StartDeliveryStreamEncryption x
Prelude.Generic)

-- |
-- Create a value of 'StartDeliveryStreamEncryption' 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:
--
-- 'deliveryStreamEncryptionConfigurationInput', 'startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput' - Used to specify the type and Amazon Resource Name (ARN) of the KMS key
-- needed for Server-Side Encryption (SSE).
--
-- 'deliveryStreamName', 'startDeliveryStreamEncryption_deliveryStreamName' - The name of the delivery stream for which you want to enable server-side
-- encryption (SSE).
newStartDeliveryStreamEncryption ::
  -- | 'deliveryStreamName'
  Prelude.Text ->
  StartDeliveryStreamEncryption
newStartDeliveryStreamEncryption :: Text -> StartDeliveryStreamEncryption
newStartDeliveryStreamEncryption Text
pDeliveryStreamName_ =
  StartDeliveryStreamEncryption'
    { $sel:deliveryStreamEncryptionConfigurationInput:StartDeliveryStreamEncryption' :: Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput =
        forall a. Maybe a
Prelude.Nothing,
      $sel:deliveryStreamName:StartDeliveryStreamEncryption' :: Text
deliveryStreamName = Text
pDeliveryStreamName_
    }

-- | Used to specify the type and Amazon Resource Name (ARN) of the KMS key
-- needed for Server-Side Encryption (SSE).
startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput :: Lens.Lens' StartDeliveryStreamEncryption (Prelude.Maybe DeliveryStreamEncryptionConfigurationInput)
startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput :: Lens'
  StartDeliveryStreamEncryption
  (Maybe DeliveryStreamEncryptionConfigurationInput)
startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartDeliveryStreamEncryption' {Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput :: Maybe DeliveryStreamEncryptionConfigurationInput
$sel:deliveryStreamEncryptionConfigurationInput:StartDeliveryStreamEncryption' :: StartDeliveryStreamEncryption
-> Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput} -> Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput) (\s :: StartDeliveryStreamEncryption
s@StartDeliveryStreamEncryption' {} Maybe DeliveryStreamEncryptionConfigurationInput
a -> StartDeliveryStreamEncryption
s {$sel:deliveryStreamEncryptionConfigurationInput:StartDeliveryStreamEncryption' :: Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput = Maybe DeliveryStreamEncryptionConfigurationInput
a} :: StartDeliveryStreamEncryption)

-- | The name of the delivery stream for which you want to enable server-side
-- encryption (SSE).
startDeliveryStreamEncryption_deliveryStreamName :: Lens.Lens' StartDeliveryStreamEncryption Prelude.Text
startDeliveryStreamEncryption_deliveryStreamName :: Lens' StartDeliveryStreamEncryption Text
startDeliveryStreamEncryption_deliveryStreamName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartDeliveryStreamEncryption' {Text
deliveryStreamName :: Text
$sel:deliveryStreamName:StartDeliveryStreamEncryption' :: StartDeliveryStreamEncryption -> Text
deliveryStreamName} -> Text
deliveryStreamName) (\s :: StartDeliveryStreamEncryption
s@StartDeliveryStreamEncryption' {} Text
a -> StartDeliveryStreamEncryption
s {$sel:deliveryStreamName:StartDeliveryStreamEncryption' :: Text
deliveryStreamName = Text
a} :: StartDeliveryStreamEncryption)

instance
  Core.AWSRequest
    StartDeliveryStreamEncryption
  where
  type
    AWSResponse StartDeliveryStreamEncryption =
      StartDeliveryStreamEncryptionResponse
  request :: (Service -> Service)
-> StartDeliveryStreamEncryption
-> Request StartDeliveryStreamEncryption
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy StartDeliveryStreamEncryption
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartDeliveryStreamEncryption)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> () -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveEmpty
      ( \Int
s ResponseHeaders
h ()
x ->
          Int -> StartDeliveryStreamEncryptionResponse
StartDeliveryStreamEncryptionResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance
  Prelude.Hashable
    StartDeliveryStreamEncryption
  where
  hashWithSalt :: Int -> StartDeliveryStreamEncryption -> Int
hashWithSalt Int
_salt StartDeliveryStreamEncryption' {Maybe DeliveryStreamEncryptionConfigurationInput
Text
deliveryStreamName :: Text
deliveryStreamEncryptionConfigurationInput :: Maybe DeliveryStreamEncryptionConfigurationInput
$sel:deliveryStreamName:StartDeliveryStreamEncryption' :: StartDeliveryStreamEncryption -> Text
$sel:deliveryStreamEncryptionConfigurationInput:StartDeliveryStreamEncryption' :: StartDeliveryStreamEncryption
-> Maybe DeliveryStreamEncryptionConfigurationInput
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
deliveryStreamName

instance Prelude.NFData StartDeliveryStreamEncryption where
  rnf :: StartDeliveryStreamEncryption -> ()
rnf StartDeliveryStreamEncryption' {Maybe DeliveryStreamEncryptionConfigurationInput
Text
deliveryStreamName :: Text
deliveryStreamEncryptionConfigurationInput :: Maybe DeliveryStreamEncryptionConfigurationInput
$sel:deliveryStreamName:StartDeliveryStreamEncryption' :: StartDeliveryStreamEncryption -> Text
$sel:deliveryStreamEncryptionConfigurationInput:StartDeliveryStreamEncryption' :: StartDeliveryStreamEncryption
-> Maybe DeliveryStreamEncryptionConfigurationInput
..} =
    forall a. NFData a => a -> ()
Prelude.rnf
      Maybe DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
deliveryStreamName

instance Data.ToHeaders StartDeliveryStreamEncryption where
  toHeaders :: StartDeliveryStreamEncryption -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"Firehose_20150804.StartDeliveryStreamEncryption" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

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

instance Data.ToPath StartDeliveryStreamEncryption where
  toPath :: StartDeliveryStreamEncryption -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery StartDeliveryStreamEncryption where
  toQuery :: StartDeliveryStreamEncryption -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newStartDeliveryStreamEncryptionResponse' smart constructor.
data StartDeliveryStreamEncryptionResponse = StartDeliveryStreamEncryptionResponse'
  { -- | The response's http status code.
    StartDeliveryStreamEncryptionResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (StartDeliveryStreamEncryptionResponse
-> StartDeliveryStreamEncryptionResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartDeliveryStreamEncryptionResponse
-> StartDeliveryStreamEncryptionResponse -> Bool
$c/= :: StartDeliveryStreamEncryptionResponse
-> StartDeliveryStreamEncryptionResponse -> Bool
== :: StartDeliveryStreamEncryptionResponse
-> StartDeliveryStreamEncryptionResponse -> Bool
$c== :: StartDeliveryStreamEncryptionResponse
-> StartDeliveryStreamEncryptionResponse -> Bool
Prelude.Eq, ReadPrec [StartDeliveryStreamEncryptionResponse]
ReadPrec StartDeliveryStreamEncryptionResponse
Int -> ReadS StartDeliveryStreamEncryptionResponse
ReadS [StartDeliveryStreamEncryptionResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartDeliveryStreamEncryptionResponse]
$creadListPrec :: ReadPrec [StartDeliveryStreamEncryptionResponse]
readPrec :: ReadPrec StartDeliveryStreamEncryptionResponse
$creadPrec :: ReadPrec StartDeliveryStreamEncryptionResponse
readList :: ReadS [StartDeliveryStreamEncryptionResponse]
$creadList :: ReadS [StartDeliveryStreamEncryptionResponse]
readsPrec :: Int -> ReadS StartDeliveryStreamEncryptionResponse
$creadsPrec :: Int -> ReadS StartDeliveryStreamEncryptionResponse
Prelude.Read, Int -> StartDeliveryStreamEncryptionResponse -> ShowS
[StartDeliveryStreamEncryptionResponse] -> ShowS
StartDeliveryStreamEncryptionResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartDeliveryStreamEncryptionResponse] -> ShowS
$cshowList :: [StartDeliveryStreamEncryptionResponse] -> ShowS
show :: StartDeliveryStreamEncryptionResponse -> String
$cshow :: StartDeliveryStreamEncryptionResponse -> String
showsPrec :: Int -> StartDeliveryStreamEncryptionResponse -> ShowS
$cshowsPrec :: Int -> StartDeliveryStreamEncryptionResponse -> ShowS
Prelude.Show, forall x.
Rep StartDeliveryStreamEncryptionResponse x
-> StartDeliveryStreamEncryptionResponse
forall x.
StartDeliveryStreamEncryptionResponse
-> Rep StartDeliveryStreamEncryptionResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep StartDeliveryStreamEncryptionResponse x
-> StartDeliveryStreamEncryptionResponse
$cfrom :: forall x.
StartDeliveryStreamEncryptionResponse
-> Rep StartDeliveryStreamEncryptionResponse x
Prelude.Generic)

-- |
-- Create a value of 'StartDeliveryStreamEncryptionResponse' 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:
--
-- 'httpStatus', 'startDeliveryStreamEncryptionResponse_httpStatus' - The response's http status code.
newStartDeliveryStreamEncryptionResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  StartDeliveryStreamEncryptionResponse
newStartDeliveryStreamEncryptionResponse :: Int -> StartDeliveryStreamEncryptionResponse
newStartDeliveryStreamEncryptionResponse Int
pHttpStatus_ =
  StartDeliveryStreamEncryptionResponse'
    { $sel:httpStatus:StartDeliveryStreamEncryptionResponse' :: Int
httpStatus =
        Int
pHttpStatus_
    }

-- | The response's http status code.
startDeliveryStreamEncryptionResponse_httpStatus :: Lens.Lens' StartDeliveryStreamEncryptionResponse Prelude.Int
startDeliveryStreamEncryptionResponse_httpStatus :: Lens' StartDeliveryStreamEncryptionResponse Int
startDeliveryStreamEncryptionResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartDeliveryStreamEncryptionResponse' {Int
httpStatus :: Int
$sel:httpStatus:StartDeliveryStreamEncryptionResponse' :: StartDeliveryStreamEncryptionResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: StartDeliveryStreamEncryptionResponse
s@StartDeliveryStreamEncryptionResponse' {} Int
a -> StartDeliveryStreamEncryptionResponse
s {$sel:httpStatus:StartDeliveryStreamEncryptionResponse' :: Int
httpStatus = Int
a} :: StartDeliveryStreamEncryptionResponse)

instance
  Prelude.NFData
    StartDeliveryStreamEncryptionResponse
  where
  rnf :: StartDeliveryStreamEncryptionResponse -> ()
rnf StartDeliveryStreamEncryptionResponse' {Int
httpStatus :: Int
$sel:httpStatus:StartDeliveryStreamEncryptionResponse' :: StartDeliveryStreamEncryptionResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus