Class: Aws::Kinesis::Types::StartStreamEncryptionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::StartStreamEncryptionInput
- Defined in:
- gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb
Overview
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
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#encryption_type ⇒ String
The encryption type to use.
-
#key_id ⇒ String
The GUID for the customer-managed AWS KMS key to use for encryption.
-
#stream_name ⇒ String
The name of the stream for which to start encrypting records.
Instance Attribute Details
#encryption_type ⇒ String
The encryption type to use. The only valid value is KMS
.
1955 1956 1957 1958 1959 1960 1961 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1955 class StartStreamEncryptionInput < Struct.new( :stream_name, :encryption_type, :key_id) SENSITIVE = [] include Aws::Structure end |
#key_id ⇒ String
The GUID for the customer-managed AWS 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
1955 1956 1957 1958 1959 1960 1961 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1955 class StartStreamEncryptionInput < Struct.new( :stream_name, :encryption_type, :key_id) SENSITIVE = [] include Aws::Structure end |
#stream_name ⇒ String
The name of the stream for which to start encrypting records.
1955 1956 1957 1958 1959 1960 1961 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1955 class StartStreamEncryptionInput < Struct.new( :stream_name, :encryption_type, :key_id) SENSITIVE = [] include Aws::Structure end |