Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Documentation

data DeliveryStreamEncryptionConfiguration

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

• failureDescription :: Maybe FailureDescription

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

• keyARN :: Maybe Text

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

• keyType :: Maybe KeyType

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

• 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.

Instances

FromJSON DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Methods

parseJSON :: Value -> Parser DeliveryStreamEncryptionConfiguration

parseJSONList :: Value -> Parser [DeliveryStreamEncryptionConfiguration]

Generic DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Associated Types

type Rep DeliveryStreamEncryptionConfiguration :: Type -> Type

Methods

from :: DeliveryStreamEncryptionConfiguration -> Rep DeliveryStreamEncryptionConfiguration x

to :: Rep DeliveryStreamEncryptionConfiguration x -> DeliveryStreamEncryptionConfiguration

Read DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Methods

readsPrec :: Int -> ReadS DeliveryStreamEncryptionConfiguration

readList :: ReadS [DeliveryStreamEncryptionConfiguration]

readPrec :: ReadPrec DeliveryStreamEncryptionConfiguration

readListPrec :: ReadPrec [DeliveryStreamEncryptionConfiguration]

Show DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Methods

showsPrec :: Int -> DeliveryStreamEncryptionConfiguration -> ShowS

show :: DeliveryStreamEncryptionConfiguration -> String

showList :: [DeliveryStreamEncryptionConfiguration] -> ShowS

NFData DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Methods

rnf :: DeliveryStreamEncryptionConfiguration -> ()

Eq DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Methods

(==) :: DeliveryStreamEncryptionConfiguration -> DeliveryStreamEncryptionConfiguration -> Bool

(/=) :: DeliveryStreamEncryptionConfiguration -> DeliveryStreamEncryptionConfiguration -> Bool

Hashable DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Methods

hashWithSalt :: Int -> DeliveryStreamEncryptionConfiguration -> Int

hash :: DeliveryStreamEncryptionConfiguration -> Int

type Rep DeliveryStreamEncryptionConfiguration

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

type Rep DeliveryStreamEncryptionConfiguration = D1 ('MetaData "DeliveryStreamEncryptionConfiguration" "Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DeliveryStreamEncryptionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDescription)) :*: S1 ('MetaSel ('Just "keyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyType)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamEncryptionStatus)))))

newDeliveryStreamEncryptionConfiguration :: DeliveryStreamEncryptionConfiguration

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: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.

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

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

$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.

deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription)

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

deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text)

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

deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType)

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

deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (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.