Class: Aws::Firehose::Types::DeliveryStreamEncryptionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

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.

Instance Attribute Summary collapse

Instance Attribute Details

#failure_descriptionTypes::FailureDescription

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



869
870
871
872
873
874
875
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 869

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  include Aws::Structure
end

#key_arnString

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.

Returns:

  • (String)


869
870
871
872
873
874
875
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 869

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  include Aws::Structure
end

#key_typeString

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

Returns:

  • (String)


869
870
871
872
873
874
875
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 869

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


869
870
871
872
873
874
875
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 869

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  include Aws::Structure
end