Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Description

Documentation

data DeliveryStreamEncryptionConfiguration Source #

Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.

See: newDeliveryStreamEncryptionConfiguration smart constructor.

Constructors

DeliveryStreamEncryptionConfiguration'

Fields

status :: Maybe DeliveryStreamEncryptionStatus
This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.
keyType :: Maybe KeyType
Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).
keyARN :: Maybe Text
If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.
failureDescription :: Maybe FailureDescription
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Instances

Instances details

Eq DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Methods (==) :: DeliveryStreamEncryptionConfiguration -> DeliveryStreamEncryptionConfiguration -> Bool # (/=) :: DeliveryStreamEncryptionConfiguration -> DeliveryStreamEncryptionConfiguration -> Bool #
Read DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Methods readsPrec :: Int -> ReadS DeliveryStreamEncryptionConfiguration # readList :: ReadS [DeliveryStreamEncryptionConfiguration] # readPrec :: ReadPrec DeliveryStreamEncryptionConfiguration # readListPrec :: ReadPrec [DeliveryStreamEncryptionConfiguration] #
Show DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Methods showsPrec :: Int -> DeliveryStreamEncryptionConfiguration -> ShowS # show :: DeliveryStreamEncryptionConfiguration -> String # showList :: [DeliveryStreamEncryptionConfiguration] -> ShowS #
Generic DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Associated Types type Rep DeliveryStreamEncryptionConfiguration :: Type -> Type # Methods from :: DeliveryStreamEncryptionConfiguration -> Rep DeliveryStreamEncryptionConfiguration x # to :: Rep DeliveryStreamEncryptionConfiguration x -> DeliveryStreamEncryptionConfiguration #
NFData DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Methods rnf :: DeliveryStreamEncryptionConfiguration -> () #
Hashable DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Methods hashWithSalt :: Int -> DeliveryStreamEncryptionConfiguration -> Int # hash :: DeliveryStreamEncryptionConfiguration -> Int #
FromJSON DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration Methods parseJSON :: Value -> Parser DeliveryStreamEncryptionConfiguration # parseJSONList :: Value -> Parser [DeliveryStreamEncryptionConfiguration] #
type Rep DeliveryStreamEncryptionConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration type Rep DeliveryStreamEncryptionConfiguration = D1 ('MetaData "DeliveryStreamEncryptionConfiguration" "Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "DeliveryStreamEncryptionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamEncryptionStatus)) :: S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyType))) :: (S1 ('MetaSel ('Just "keyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDescription)))))

newDeliveryStreamEncryptionConfiguration :: DeliveryStreamEncryptionConfiguration Source #

Create a value of DeliveryStreamEncryptionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_status - This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

$sel:keyType:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_keyType - Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

$sel:keyARN:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_keyARN - If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

$sel:failureDescription:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_failureDescription - Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (Maybe DeliveryStreamEncryptionStatus) Source #

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType) Source #

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text) Source #

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription) Source #

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.