pub struct Builder { /* private fields */ }
Expand description
A builder for GetShardIteratorInput
.
Implementations
sourceimpl Builder
impl Builder
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
sourcepub fn shard_id(self, input: impl Into<String>) -> Self
pub fn shard_id(self, input: impl Into<String>) -> Self
The identifier of the shard. The iterator will be returned for this shard ID.
sourcepub fn set_shard_id(self, input: Option<String>) -> Self
pub fn set_shard_id(self, input: Option<String>) -> Self
The identifier of the shard. The iterator will be returned for this shard ID.
sourcepub fn shard_iterator_type(self, input: ShardIteratorType) -> Self
pub fn shard_iterator_type(self, input: ShardIteratorType) -> Self
Determines how the shard iterator is used to start reading stream records from the shard:
-
AT_SEQUENCE_NUMBER
- Start reading exactly from the position denoted by a specific sequence number. -
AFTER_SEQUENCE_NUMBER
- Start reading right after the position denoted by a specific sequence number. -
TRIM_HORIZON
- Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. -
LATEST
- Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.
sourcepub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self
pub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self
Determines how the shard iterator is used to start reading stream records from the shard:
-
AT_SEQUENCE_NUMBER
- Start reading exactly from the position denoted by a specific sequence number. -
AFTER_SEQUENCE_NUMBER
- Start reading right after the position denoted by a specific sequence number. -
TRIM_HORIZON
- Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. -
LATEST
- Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.
sourcepub fn sequence_number(self, input: impl Into<String>) -> Self
pub fn sequence_number(self, input: impl Into<String>) -> Self
The sequence number of a stream record in the shard from which to start reading.
sourcepub fn set_sequence_number(self, input: Option<String>) -> Self
pub fn set_sequence_number(self, input: Option<String>) -> Self
The sequence number of a stream record in the shard from which to start reading.
sourcepub fn build(self) -> Result<GetShardIteratorInput, BuildError>
pub fn build(self) -> Result<GetShardIteratorInput, BuildError>
Consumes the builder and constructs a GetShardIteratorInput
.