kinesis/aws.sdk.kotlin.services.kinesis.model/StreamDescriptionSummary/Builder

Builder

class Builder

Properties

channelCount

var channelCount: Int?

The number of channels associated with the stream.

consumerCount

var consumerCount: Int?

The number of enhanced fan-out consumers registered with the stream.

encryptionType

var encryptionType: EncryptionType?

The encryption type used. This value is one of the following:

enhancedMonitoring

var enhancedMonitoring: List<EnhancedMetrics>?

Represents the current enhanced monitoring settings of the stream.

keyId

var keyId: String?

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.

maxRecordSizeInKib

var maxRecordSizeInKib: Int?

The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

openShardCount

var openShardCount: Int?

The number of open shards in the stream.

recordDistributionStrategy

var recordDistributionStrategy: RecordDistributionStrategy?

The record distribution strategy that the stream currently uses. A value of AUTO indicates that Amazon Kinesis Data Streams distributes records across shards using service-managed algorithms. A value of USER_PARTITION_KEY indicates that shard placement is determined by the partition key that producers supply. This field is only present for streams that use the on-demand capacity mode.

retentionPeriodHours

var retentionPeriodHours: Int?

The current retention period, in hours.

streamArn

var streamArn: String?

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

streamCreationTimestamp

var streamCreationTimestamp: ERROR CLASS: Symbol not found for aws.smithy.kotlin.runtime.time.Instant??

The approximate time that the stream was created.

streamId

var streamId: String?

Not Implemented. Reserved for future use.

streamModeDetails

var streamModeDetails: StreamModeDetails?

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 ycapacity mode and a provisioned capacity mode for your data streams.

streamName

var streamName: String?

The name of the stream being described.

streamStatus

var streamStatus: StreamStatus?

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

warmThroughput

var warmThroughput: WarmThroughputObject?

The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.

Functions

streamModeDetails

fun streamModeDetails(block: StreamModeDetails.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kinesis.model.StreamModeDetails inside the given block

warmThroughput

fun warmThroughput(block: WarmThroughputObject.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kinesis.model.WarmThroughputObject inside the given block