Struct aws_sdk_qldb::types::JournalKinesisStreamDescription

#[non_exhaustive]
pub struct JournalKinesisStreamDescription {
    pub ledger_name: String,
    pub creation_time: Option<DateTime>,
    pub inclusive_start_time: Option<DateTime>,
    pub exclusive_end_time: Option<DateTime>,
    pub role_arn: String,
    pub stream_id: String,
    pub arn: Option<String>,
    pub status: StreamStatus,
    pub kinesis_configuration: Option<KinesisConfiguration>,
    pub error_cause: Option<ErrorCause>,
    pub stream_name: String,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ledger_name: String

The name of the ledger.

creation_time: Option<DateTime>

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

inclusive_start_time: Option<DateTime>

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

exclusive_end_time: Option<DateTime>

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

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.

stream_id: String

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

arn: Option<String>

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

status: StreamStatus

The current state of the QLDB journal stream.

kinesis_configuration: Option<KinesisConfiguration>

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

error_cause: Option<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.

stream_name: String

The user-defined name of the QLDB journal stream.

Implementations

impl JournalKinesisStreamDescription

pub fn ledger_name(&self) -> &str

The name of the ledger.

pub fn creation_time(&self) -> Option<&DateTime>

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

pub fn inclusive_start_time(&self) -> Option<&DateTime>

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

pub fn exclusive_end_time(&self) -> Option<&DateTime>

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

pub fn role_arn(&self) -> &str

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.

pub fn stream_id(&self) -> &str

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

pub fn arn(&self) -> Option<&str>

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

pub fn status(&self) -> &StreamStatus

The current state of the QLDB journal stream.

pub fn kinesis_configuration(&self) -> Option<&KinesisConfiguration>

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

pub fn error_cause(&self) -> Option<&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.

pub fn stream_name(&self) -> &str

The user-defined name of the QLDB journal stream.

impl JournalKinesisStreamDescription

pub fn builder() -> JournalKinesisStreamDescriptionBuilder

Creates a new builder-style object to manufacture JournalKinesisStreamDescription.

Trait Implementations

impl Clone for JournalKinesisStreamDescription

fn clone(&self) -> JournalKinesisStreamDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JournalKinesisStreamDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for JournalKinesisStreamDescription

fn eq(&self, other: &JournalKinesisStreamDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JournalKinesisStreamDescription