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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_type ⇒ String

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

Returns:

  • (String) 


1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/aws-sdk-kinesis/types.rb', line 1999

class StartStreamEncryptionInput < Struct.new(
  :stream_name,
  :encryption_type,
  :key_id,
  :stream_arn)
  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) 


1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/aws-sdk-kinesis/types.rb', line 1999

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

#stream_arn ⇒ String

The ARN of the stream.

Returns:

  • (String) 


1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/aws-sdk-kinesis/types.rb', line 1999

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

#stream_name ⇒ String

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

Returns:

  • (String) 


1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/aws-sdk-kinesis/types.rb', line 1999

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