Struct aws_sdk_qldb::input::StreamJournalToKinesisInput

#[non_exhaustive]
pub struct StreamJournalToKinesisInput {
    pub ledger_name: Option<String>,
    pub role_arn: Option<String>,
    pub tags: Option<HashMap<String, Option<String>>>,
    pub inclusive_start_time: Option<DateTime>,
    pub exclusive_end_time: Option<DateTime>,
    pub kinesis_configuration: Option<KinesisConfiguration>,
    pub stream_name: Option<String>,
}

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: Option<String>

The name of the ledger.

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

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

tags: Option<HashMap<String, Option<String>>>

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

inclusive_start_time: Option<DateTime>

The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

exclusive_end_time: Option<DateTime>

The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

kinesis_configuration: Option<KinesisConfiguration>

The configuration settings of the Kinesis Data Streams destination for your stream request.

stream_name: Option<String>

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Implementations

impl StreamJournalToKinesisInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<StreamJournalToKinesis, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StreamJournalToKinesis>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StreamJournalToKinesisInput

impl StreamJournalToKinesisInput

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

The name of the ledger.

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

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

pub fn tags(&self) -> Option<&HashMap<String, Option<String>>>

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

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

The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

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

The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

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

The configuration settings of the Kinesis Data Streams destination for your stream request.

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

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Trait Implementations

impl Clone for StreamJournalToKinesisInput

fn clone(&self) -> StreamJournalToKinesisInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamJournalToKinesisInput

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

Formats the value using the given formatter.

impl PartialEq<StreamJournalToKinesisInput> for StreamJournalToKinesisInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StreamJournalToKinesisInput