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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/aws-sdk-firehose/types.rb', line 1379

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

#key_arn ⇒ String

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

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/aws-sdk-firehose/types.rb', line 1379

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

#key_type ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/aws-sdk-firehose/types.rb', line 1379

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

#status ⇒ String

This is the server-side encryption (SSE) status for the Firehose 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) 


1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/aws-sdk-firehose/types.rb', line 1379

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