You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kinesis::Types::StartStreamEncryptionInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartStreamEncryptionInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  stream_name: "StreamName", # required
  encryption_type: "NONE", # required, accepts NONE, KMS
  key_id: "KeyId", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_type ⇒ String

The encryption type to use. The only valid value is KMS.

Possible values:

  • NONE
  • KMS

Returns:

  • (String) —

    The encryption type to use.

#key_id ⇒ String

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

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

#stream_name ⇒ String

The name of the stream for which to start encrypting records.

Returns:

  • (String) —

    The name of the stream for which to start encrypting records.