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

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::StopStreamEncryptionInput

Includes:

Structure

Defined in:

lib/aws-sdk-kinesis/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #encryption_type ⇒ String

  The encryption type.

• #key_id ⇒ String

  The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.

• #stream_arn ⇒ String

  The ARN of the stream.

• #stream_id ⇒ String

  Not Implemented.

• #stream_name ⇒ String

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

Instance Attribute Details

#encryption_type ⇒ String

The encryption type. The only valid value is KMS.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 2356

class StopStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id,
  :stream_arn,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ String

The GUID for the customer-managed Amazon Web Services 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)

# File 'lib/aws-sdk-kinesis/types.rb', line 2356

class StopStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id,
  :stream_arn,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The ARN of the stream.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 2356

class StopStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id,
  :stream_arn,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

Not Implemented. Reserved for future use.

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 2356

class StopStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id,
  :stream_arn,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kinesis/types.rb', line 2356

class StopStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id,
  :stream_arn,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end