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

Class: Aws::Kinesis::Types::StopStreamEncryptionInput

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 StopStreamEncryptionInput 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. 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)


1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1166

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

#key_idString

The GUID for the customer-managed key that was used for encryption.

Returns:

  • (String)


1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1166

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

#stream_nameString

The name of the stream on which to stop encrypting records.

Returns:

  • (String)


1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1166

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