paws.analytics (version 0.5.0)

kinesis_start_stream_encryption: Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream

Description

Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.

See https://www.paws-r-sdk.com/docs/kinesis_start_stream_encryption/ for full documentation.

Usage

kinesis_start_stream_encryption(
  StreamName = NULL,
  EncryptionType,
  KeyId,
  StreamARN = NULL
)

Arguments

StreamName

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

EncryptionType

[required] The encryption type to use. The only valid value is KMS.

KeyId

[required] 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

StreamARN

The ARN of the stream.