StreamDescription

Represents the output for DescribeStream.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The server-side encryption type used on the stream. This parameter can be one of the following values:

Link copied to clipboard

Represents the current enhanced monitoring settings of the stream.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The shards that comprise the stream.

Link copied to clipboard

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

Link copied to clipboard

The approximate time that the stream was created.

Link copied to clipboard

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.

Link copied to clipboard

The name of the stream being described.

Link copied to clipboard

The current status of the stream being described. The stream status is one of the following states:

Functions

Link copied to clipboard
inline fun copy(block: StreamDescription.Builder.() -> Unit = {}): StreamDescription
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String