qldb/aws.sdk.kotlin.services.qldb.model/JournalKinesisStreamDescription

JournalKinesisStreamDescription

Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

Types

Builder

class Builder

Companion

object Companion

Properties

arn

val arn: String?

The Amazon Resource Name (ARN) of the QLDB journal stream.

creationTime

val creationTime: Instant?

The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

errorCause

val errorCause: ErrorCause?

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

exclusiveEndTime

val exclusiveEndTime: Instant?

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

inclusiveStartTime

val inclusiveStartTime: Instant?

The inclusive start date and time from which to start streaming journal data.

kinesisConfiguration

val kinesisConfiguration: KinesisConfiguration?

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

ledgerName

val ledgerName: String

The name of the ledger.

roleArn

val roleArn: String

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

status

val status: StreamStatus

The current state of the QLDB journal stream.

streamId

val streamId: String

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

streamName

val streamName: String

The user-defined name of the QLDB journal stream.