StreamDescription
import type { StreamDescription } from "https://aws-api.deno.dev/v0.4/services/kinesis.ts?docs=full";
Represents the output for "DescribeStream".
§Properties
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.KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
Represents the current enhanced monitoring settings of the stream.
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 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
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
state until Kinesis Data Streams completes the deletion.ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.