Paws::Kinesis::StreamDescription
This class represents one of two things:
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::Kinesis::StreamDescription object:
$service_obj->Method(Att1 => { EncryptionType => $value, ..., StreamStatus => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::StreamDescription object:
$result = $service_obj->Method(...); $result->Att1->EncryptionType
Represents the output for DescribeStream.
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE: Do not encrypt the records in the stream.
NONE
KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
KMS
Represents the current enhanced monitoring settings of the stream.
If set to true, more shards in the stream are available to describe.
true
The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified 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.
aws/kinesis
Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
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
arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
alias/aws/kinesis
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
The shards that comprise the stream.
The Amazon Resource Name (ARN) for the stream being described.
The approximate time that the stream was created.
The name of the stream being described.
The current status of the stream being described. The stream status is one of the following states:
CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.
CREATING
StreamStatus
DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
DELETING
ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
ACTIVE
UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
UPDATING
This class forms part of Paws, describing an object used in Paws::Kinesis
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
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.