Struct PipeSourceKinesisStreamParameters

#[non_exhaustive]
pub struct PipeSourceKinesisStreamParameters {
    pub batch_size: Option<i32>,
    pub dead_letter_config: Option<DeadLetterConfig>,
    pub on_partial_batch_item_failure: Option<OnPartialBatchItemFailureStreams>,
    pub maximum_batching_window_in_seconds: Option<i32>,
    pub maximum_record_age_in_seconds: Option<i32>,
    pub maximum_retry_attempts: Option<i32>,
    pub parallelization_factor: Option<i32>,
    pub starting_position: KinesisStreamStartPosition,
    pub starting_position_timestamp: Option<DateTime>,
}

The parameters for using a Kinesis stream as a source.

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.

batch_size: Option<i32>

The maximum number of records to include in each batch.

dead_letter_config: Option<DeadLetterConfig>

Define the target queue to send dead-letter queue events to.

on_partial_batch_item_failure: Option<OnPartialBatchItemFailureStreams>

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

maximum_batching_window_in_seconds: Option<i32>

The maximum length of a time to wait for events.

maximum_record_age_in_seconds: Option<i32>

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

maximum_retry_attempts: Option<i32>

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

parallelization_factor: Option<i32>

The number of batches to process concurrently from each shard. The default value is 1.

starting_position: KinesisStreamStartPosition

The position in a stream from which to start reading.

starting_position_timestamp: Option<DateTime>

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

Implementations

impl PipeSourceKinesisStreamParameters

pub fn batch_size(&self) -> Option<i32>

The maximum number of records to include in each batch.

pub fn dead_letter_config(&self) -> Option<&DeadLetterConfig>

Define the target queue to send dead-letter queue events to.

pub fn on_partial_batch_item_failure( &self, ) -> Option<&OnPartialBatchItemFailureStreams>

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

pub fn maximum_batching_window_in_seconds(&self) -> Option<i32>

The maximum length of a time to wait for events.

pub fn maximum_record_age_in_seconds(&self) -> Option<i32>

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

pub fn maximum_retry_attempts(&self) -> Option<i32>

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

pub fn parallelization_factor(&self) -> Option<i32>

The number of batches to process concurrently from each shard. The default value is 1.

pub fn starting_position(&self) -> &KinesisStreamStartPosition

The position in a stream from which to start reading.

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

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

impl PipeSourceKinesisStreamParameters

pub fn builder() -> PipeSourceKinesisStreamParametersBuilder

Creates a new builder-style object to manufacture PipeSourceKinesisStreamParameters.

Trait Implementations

impl Clone for PipeSourceKinesisStreamParameters

fn clone(&self) -> PipeSourceKinesisStreamParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipeSourceKinesisStreamParameters

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

Formats the value using the given formatter.

impl PartialEq for PipeSourceKinesisStreamParameters

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PipeSourceKinesisStreamParameters