You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::QLDB::Types::JournalKinesisStreamDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) —

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

#creation_time ⇒ Time

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.)

Returns:

  • (Time) —

    The date and time, in epoch time format, when the QLDB journal stream was created.

#error_cause ⇒ String

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.

Possible values:

  • KINESIS_STREAM_NOT_FOUND
  • IAM_PERMISSION_REVOKED

Returns:

  • (String) —

    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED.

#exclusive_end_time ⇒ Time

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

Returns:

  • (Time) —

    The exclusive date and time that specifies when the stream ends.

#inclusive_start_time ⇒ Time

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

Returns:

  • (Time) —

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

#kinesis_configuration ⇒ Types::KinesisConfiguration

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

Returns:

  • (Types::KinesisConfiguration) —

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

#ledger_name ⇒ String

The name of the ledger.

Returns:

  • (String) —

    The name of the ledger.

#role_arn ⇒ 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.

Returns:

  • (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 ⇒ String

The current state of the QLDB journal stream.

Possible values:

  • ACTIVE
  • COMPLETED
  • CANCELED
  • FAILED
  • IMPAIRED

Returns:

  • (String) —

    The current state of the QLDB journal stream.

#stream_id ⇒ String

The unique ID that QLDB assigns to each QLDB journal stream.

Returns:

  • (String) —

    The unique ID that QLDB assigns to each QLDB journal stream.

#stream_name ⇒ String

The user-defined name of the QLDB journal stream.

Returns:

  • (String) —

    The user-defined name of the QLDB journal stream.