Struct aws_sdk_qldb::operation::stream_journal_to_kinesis::builders::StreamJournalToKinesisFluentBuilder
source · pub struct StreamJournalToKinesisFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StreamJournalToKinesis
.
Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
Implementations§
source§impl StreamJournalToKinesisFluentBuilder
impl StreamJournalToKinesisFluentBuilder
sourcepub fn as_input(&self) -> &StreamJournalToKinesisInputBuilder
pub fn as_input(&self) -> &StreamJournalToKinesisInputBuilder
Access the StreamJournalToKinesis as a reference.
sourcepub async fn send(
self
) -> Result<StreamJournalToKinesisOutput, SdkError<StreamJournalToKinesisError, HttpResponse>>
pub async fn send( self ) -> Result<StreamJournalToKinesisOutput, SdkError<StreamJournalToKinesisError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<StreamJournalToKinesisOutput, StreamJournalToKinesisError, Self>
pub fn customize( self ) -> CustomizableOperation<StreamJournalToKinesisOutput, StreamJournalToKinesisError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn ledger_name(self, input: impl Into<String>) -> Self
pub fn ledger_name(self, input: impl Into<String>) -> Self
The name of the ledger.
sourcepub fn set_ledger_name(self, input: Option<String>) -> Self
pub fn set_ledger_name(self, input: Option<String>) -> Self
The name of the ledger.
sourcepub fn get_ledger_name(&self) -> &Option<String>
pub fn get_ledger_name(&self) -> &Option<String>
The name of the ledger.
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &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.
Adds a key-value pair to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
sourcepub fn inclusive_start_time(self, input: DateTime) -> Self
pub fn inclusive_start_time(self, input: DateTime) -> Self
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
.
sourcepub fn set_inclusive_start_time(self, input: Option<DateTime>) -> Self
pub fn set_inclusive_start_time(self, input: Option<DateTime>) -> Self
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
.
sourcepub fn get_inclusive_start_time(&self) -> &Option<DateTime>
pub fn get_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
.
sourcepub fn exclusive_end_time(self, input: DateTime) -> Self
pub fn exclusive_end_time(self, input: DateTime) -> Self
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
.
sourcepub fn set_exclusive_end_time(self, input: Option<DateTime>) -> Self
pub fn set_exclusive_end_time(self, input: Option<DateTime>) -> Self
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
.
sourcepub fn get_exclusive_end_time(&self) -> &Option<DateTime>
pub fn get_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
.
sourcepub fn kinesis_configuration(self, input: KinesisConfiguration) -> Self
pub fn kinesis_configuration(self, input: KinesisConfiguration) -> Self
The configuration settings of the Kinesis Data Streams destination for your stream request.
sourcepub fn set_kinesis_configuration(
self,
input: Option<KinesisConfiguration>
) -> Self
pub fn set_kinesis_configuration( self, input: Option<KinesisConfiguration> ) -> Self
The configuration settings of the Kinesis Data Streams destination for your stream request.
sourcepub fn get_kinesis_configuration(&self) -> &Option<KinesisConfiguration>
pub fn get_kinesis_configuration(&self) -> &Option<KinesisConfiguration>
The configuration settings of the Kinesis Data Streams destination for your stream request.
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_stream_name(&self) -> &Option<String>
pub fn get_stream_name(&self) -> &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.
Trait Implementations§
source§impl Clone for StreamJournalToKinesisFluentBuilder
impl Clone for StreamJournalToKinesisFluentBuilder
source§fn clone(&self) -> StreamJournalToKinesisFluentBuilder
fn clone(&self) -> StreamJournalToKinesisFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StreamJournalToKinesisFluentBuilder
impl !RefUnwindSafe for StreamJournalToKinesisFluentBuilder
impl Send for StreamJournalToKinesisFluentBuilder
impl Sync for StreamJournalToKinesisFluentBuilder
impl Unpin for StreamJournalToKinesisFluentBuilder
impl !UnwindSafe for StreamJournalToKinesisFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more