StreamDescription

import type { StreamDescription } from "https://aws-api.deno.dev/v0.3/services/kinesis.ts?docs=full";

Represents the output for "DescribeStream".

interface StreamDescription {

EncryptionType?: EncryptionType | null;

EnhancedMonitoring: EnhancedMetrics[];

HasMoreShards: boolean;

KeyId?: string | null;

RetentionPeriodHours: number;

Shards: Shard[];

StreamARN: string;

StreamCreationTimestamp: Date | number;

StreamModeDetails?: StreamModeDetails | null;

StreamName: string;

StreamStatus: StreamStatus;

}

§Properties

EncryptionType?: EncryptionType | null

[src]

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.

EnhancedMonitoring: EnhancedMetrics[]

[src]

Represents the current enhanced monitoring settings of the stream.

HasMoreShards: boolean

[src]

If set to true, more shards in the stream are available to describe.

KeyId?: string | null

[src]

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

RetentionPeriodHours: number

[src]

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Shards: Shard[]

[src]

The shards that comprise the stream.

StreamARN: string

[src]

The Amazon Resource Name (ARN) for the stream being described.

StreamCreationTimestamp: Date | number

[src]

The approximate time that the stream was created.

StreamModeDetails?: StreamModeDetails | null

[src]

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.

StreamName: string

[src]

The name of the stream being described.

StreamStatus: StreamStatus

[src]

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.
DELETING - The stream is being deleted. The specified stream is in the DELETING 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 an ACTIVE stream.
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.