DeliveryStreamEncryptionConfigurationInput
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
Contents
- KeyType
-
Indicates the type of customer master key (CMK) to use for encryption. The default setting is
Amazon_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption withKeyTypeset to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Firehose service to use the customer managed CMK to perform encryption and decryption. Firehose manages that grant.When you invoke StartDeliveryStreamEncryption to change the CMK for a Firehose stream that is encrypted with a customer managed CMK, 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 Firehose streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Firehose throws a
LimitExceededException.Important
To encrypt your Firehose stream, use symmetric CMKs. Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Key Management Service developer guide.
Type: String
Valid Values:
AWS_OWNED_CMK | CUSTOMER_MANAGED_CMKRequired: Yes
- KeyARN
-
If you set
KeyTypetoCUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you setKeyTypetoAmazon_OWNED_CMK, Firehose uses a service-account CMK.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
arn:.*:kms:[a-zA-Z0-9\-]+:\d{12}:(key|alias)/[a-zA-Z_0-9+=,.@\-_/]+Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: