You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Firehose::Types::DeliveryStreamEncryptionConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Firehose::Types::DeliveryStreamEncryptionConfiguration
- Defined in:
- (unknown)
Overview
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.
Returned by:
Instance Attribute Summary collapse
-
#failure_description ⇒ Types::FailureDescription
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
-
#key_arn ⇒ String
If
KeyType
isCUSTOMER_MANAGED_CMK
, this field contains the ARN of the customer managed CMK. -
#key_type ⇒ String
Indicates the type of customer master key (CMK) that is used for encryption.
-
#status ⇒ String
This is the server-side encryption (SSE) status for the delivery stream.
Instance Attribute Details
#failure_description ⇒ Types::FailureDescription
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
#key_arn ⇒ String
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
.
#key_type ⇒ String
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).
#status ⇒ String
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.
Possible values:
- ENABLED
- ENABLING
- ENABLING_FAILED
- DISABLED
- DISABLING
- DISABLING_FAILED