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

Description

Synopsis

Documentation

data DeliveryStreamEncryptionConfigurationInput Source #

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

See: newDeliveryStreamEncryptionConfigurationInput smart constructor.

Constructors

DeliveryStreamEncryptionConfigurationInput'

Fields

keyARN :: Maybe Text
If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.
keyType :: KeyType
Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.
When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.
You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.
To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Instances

Instances details

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

newDeliveryStreamEncryptionConfigurationInput Source #

Arguments

:: KeyType	`$sel:keyType:DeliveryStreamEncryptionConfigurationInput'`
-> DeliveryStreamEncryptionConfigurationInput

Create a value of DeliveryStreamEncryptionConfigurationInput 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:keyARN:DeliveryStreamEncryptionConfigurationInput', deliveryStreamEncryptionConfigurationInput_keyARN - If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

$sel:keyType:DeliveryStreamEncryptionConfigurationInput', deliveryStreamEncryptionConfigurationInput_keyType - Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

deliveryStreamEncryptionConfigurationInput_keyARN :: Lens' DeliveryStreamEncryptionConfigurationInput (Maybe Text) Source #

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

deliveryStreamEncryptionConfigurationInput_keyType :: Lens' DeliveryStreamEncryptionConfigurationInput KeyType Source #

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.