Class: AWSCDK::Kinesis::CfnStream::StreamEncryptionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kinesis::CfnStream::StreamEncryptionProperty

Defined in:

kinesis/cfn_stream.rb

Overview

Enables or updates server-side encryption using an AWS KMS key for a specified stream.

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING . After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE . Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING . Once the status of the stream is ACTIVE , encryption begins for records written to the stream.

API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html

Instance Attribute Summary

• #encryption_type ⇒ String readonly

  The encryption type to use.

• #key_id ⇒ String readonly

  The GUID for the customer-managed AWS KMS key to use for encryption.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(encryption_type:, key_id:) ⇒ StreamEncryptionProperty constructor

  A new instance of StreamEncryptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(encryption_type:, key_id:) ⇒ StreamEncryptionProperty

Returns a new instance of StreamEncryptionProperty.

Parameters:

• encryption_type (String) —

  The encryption type to use.

• key_id (String) —

  The GUID for the customer-managed AWS KMS key to use for encryption.

# File 'kinesis/cfn_stream.rb', line 670

def initialize(encryption_type:, key_id:)
  @encryption_type = encryption_type
  Jsii::Type.check_type(@encryption_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionType")
  @key_id = key_id
  Jsii::Type.check_type(@key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyId")
end

Instance Attribute Details

#encryption_type ⇒ String (readonly)

The encryption type to use.

The only valid value is KMS .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-encryptiontype

# File 'kinesis/cfn_stream.rb', line 683

def encryption_type
  @encryption_type
end

#key_id ⇒ String (readonly)

The GUID for the customer-managed AWS KMS key to use for encryption.

This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis .

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• Globally unique key ID example: 12345678-1234-1234-1234-123456789012
• Alias name example: alias/MyAliasName
• Master key owned by Kinesis Data Streams: alias/aws/kinesis

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-keyid

# File 'kinesis/cfn_stream.rb', line 696

def key_id
  @key_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kinesis/cfn_stream.rb', line 698

def self.jsii_properties
  {
    :encryption_type => "encryptionType",
    :key_id => "keyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kinesis/cfn_stream.rb', line 705

def to_jsii
  result = {}
  result.merge!({
    "encryptionType" => @encryption_type,
    "keyId" => @key_id,
  })
  result.compact
end