Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::DeliveryStreamEncryptionConfigurationInputProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::KinesisFirehose::CfnDeliveryStream::DeliveryStreamEncryptionConfigurationInputProperty

Defined in:

kinesis_firehose/cfn_delivery_stream.rb

Overview

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html

Instance Attribute Summary

• #key_arn ⇒ String^? readonly

  If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon Resource Name (ARN) of the CMK.

• #key_type ⇒ String readonly

  Indicates the type of customer master key (CMK) to use for encryption.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(key_type:, key_arn: nil) ⇒ DeliveryStreamEncryptionConfigurationInputProperty constructor

  A new instance of DeliveryStreamEncryptionConfigurationInputProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(key_type:, key_arn: nil) ⇒ DeliveryStreamEncryptionConfigurationInputProperty

Returns a new instance of DeliveryStreamEncryptionConfigurationInputProperty.

Parameters:

• key_type (String) —

  Indicates the type of customer master key (CMK) to use for encryption.

• key_arn (String, nil) (defaults to: nil) —

  If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon Resource Name (ARN) of the CMK.

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1932

def initialize(key_type:, key_arn: nil)
  @key_type = key_type
  Jsii::Type.check_type(@key_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyType")
  @key_arn = key_arn
  Jsii::Type.check_type(@key_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyArn") unless @key_arn.nil?
end

Instance Attribute Details

#key_arn ⇒ String^? (readonly)

If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon Resource Name (ARN) of the CMK.

If you set KeyType to AWS _OWNED_CMK , Firehose uses a service-account CMK.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1956

def key_arn
  @key_arn
end

#key_type ⇒ String (readonly)

Indicates the type of customer master key (CMK) to use for encryption.

The default setting is AWS_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) .

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keytype

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1949

def key_type
  @key_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1958

def self.jsii_properties
  {
    :key_type => "keyType",
    :key_arn => "keyArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1965

def to_jsii
  result = {}
  result.merge!({
    "keyType" => @key_type,
    "keyArn" => @key_arn,
  })
  result.compact
end