Struct aws_sdk_glue::model::KinesisStreamingSourceOptions
source · #[non_exhaustive]pub struct KinesisStreamingSourceOptions { /* private fields */ }Expand description
Additional options for the Amazon Kinesis streaming data source.
Implementations§
source§impl KinesisStreamingSourceOptions
impl KinesisStreamingSourceOptions
sourcepub fn endpoint_url(&self) -> Option<&str>
pub fn endpoint_url(&self) -> Option<&str>
The URL of the Kinesis endpoint.
sourcepub fn stream_name(&self) -> Option<&str>
pub fn stream_name(&self) -> Option<&str>
The name of the Kinesis data stream.
sourcepub fn classification(&self) -> Option<&str>
pub fn classification(&self) -> Option<&str>
An optional classification.
sourcepub fn starting_position(&self) -> Option<&StartingPosition>
pub fn starting_position(&self) -> Option<&StartingPosition>
The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", or "earliest". The default value is "latest".
sourcepub fn max_fetch_time_in_ms(&self) -> Option<i64>
pub fn max_fetch_time_in_ms(&self) -> Option<i64>
The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
sourcepub fn max_fetch_records_per_shard(&self) -> Option<i64>
pub fn max_fetch_records_per_shard(&self) -> Option<i64>
The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
sourcepub fn max_record_per_read(&self) -> Option<i64>
pub fn max_record_per_read(&self) -> Option<i64>
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
sourcepub fn add_idle_time_between_reads(&self) -> Option<bool>
pub fn add_idle_time_between_reads(&self) -> Option<bool>
Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
sourcepub fn idle_time_between_reads_in_ms(&self) -> Option<i64>
pub fn idle_time_between_reads_in_ms(&self) -> Option<i64>
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
sourcepub fn describe_shard_interval(&self) -> Option<i64>
pub fn describe_shard_interval(&self) -> Option<i64>
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
sourcepub fn num_retries(&self) -> Option<i32>
pub fn num_retries(&self) -> Option<i32>
The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
sourcepub fn retry_interval_ms(&self) -> Option<i64>
pub fn retry_interval_ms(&self) -> Option<i64>
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
sourcepub fn max_retry_interval_ms(&self) -> Option<i64>
pub fn max_retry_interval_ms(&self) -> Option<i64>
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
sourcepub fn avoid_empty_batches(&self) -> Option<bool>
pub fn avoid_empty_batches(&self) -> Option<bool>
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
sourcepub fn stream_arn(&self) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Kinesis data stream.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
sourcepub fn role_session_name(&self) -> Option<&str>
pub fn role_session_name(&self) -> Option<&str>
An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
source§impl KinesisStreamingSourceOptions
impl KinesisStreamingSourceOptions
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture KinesisStreamingSourceOptions.
Trait Implementations§
source§impl Clone for KinesisStreamingSourceOptions
impl Clone for KinesisStreamingSourceOptions
source§fn clone(&self) -> KinesisStreamingSourceOptions
fn clone(&self) -> KinesisStreamingSourceOptions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl PartialEq<KinesisStreamingSourceOptions> for KinesisStreamingSourceOptions
impl PartialEq<KinesisStreamingSourceOptions> for KinesisStreamingSourceOptions
source§fn eq(&self, other: &KinesisStreamingSourceOptions) -> bool
fn eq(&self, other: &KinesisStreamingSourceOptions) -> bool
self and other values to be equal, and is used
by ==.