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. The only valid value is KMS.

Returns:

  • (String)


1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1212

class StopStreamEncryptionInput < 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. This value can be a globally unique identifier, a fully specified 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 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 Streams: alias/aws/kinesis

Returns:

  • (String)


1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1212

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)


1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1212

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