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.

Constant Summary collapse

SENSITIVE =
[]

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.


1374
1375
1376
1377
1378
1379
1380
1381
# File 'lib/aws-sdk-firehose/types.rb', line 1374

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  SENSITIVE = []
  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)

1374
1375
1376
1377
1378
1379
1380
1381
# File 'lib/aws-sdk-firehose/types.rb', line 1374

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  SENSITIVE = []
  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)].

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

Returns:

  • (String)

1374
1375
1376
1377
1378
1379
1380
1381
# File 'lib/aws-sdk-firehose/types.rb', line 1374

class DeliveryStreamEncryptionConfiguration < Struct.new(
  :key_arn,
  :key_type,
  :status,
  :failure_description)
  SENSITIVE = []
  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)

1374
1375
1376
1377
1378
1379
1380
1381
# File 'lib/aws-sdk-firehose/types.rb', line 1374

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