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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass StartStreamEncryptionInput data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_typeString

The encryption type to use. This parameter can be one of the following values:

  • NONE: Not valid for this operation. An InvalidOperationException will be thrown.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.

Returns:

  • (String)


1129
1130
1131
1132
1133
1134
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1129

class StartStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id)
  include Aws::Structure
end

#key_idString

The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.

Returns:

  • (String)


1129
1130
1131
1132
1133
1134
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1129

class StartStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id)
  include Aws::Structure
end

#stream_nameString

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

Returns:

  • (String)


1129
1130
1131
1132
1133
1134
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1129

class StartStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id)
  include Aws::Structure
end