NAME

Paws::Kinesis::StartStreamEncryption - Arguments for method StartStreamEncryption on Paws::Kinesis

DESCRIPTION

This class represents the parameters used for calling the method StartStreamEncryption on the Amazon Kinesis service. Use the attributes of this class as arguments to method StartStreamEncryption.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartStreamEncryption.

SYNOPSIS

    my $kinesis = Paws->service('Kinesis');
    $kinesis->StartStreamEncryption(
      EncryptionType => 'NONE',
      KeyId          => 'MyKeyId',
      StreamName     => 'MyStreamName',

    );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kinesis/StartStreamEncryption

ATTRIBUTES

REQUIRED EncryptionType => Str

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

Valid values are: "NONE", "KMS"

REQUIRED KeyId => Str

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

REQUIRED StreamName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method StartStreamEncryption in Paws::Kinesis

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues