Struct KinesisSourceConfig 

pub struct KinesisSourceConfig {

    pub stream_name: String,
    pub region: Option<String>,
    pub endpoint_url: Option<String>,
    pub credentials: KinesisCredentials,
    pub start_position: StartPosition,
    pub shard_ids: Vec<String>,
    pub include_closed: bool,
    pub poll_interval_ms: u64,
    pub records_per_request: usize,
    pub shard_concurrency: usize,
    pub idle_termination_secs: Option<u64>,
    pub max_messages: Option<usize>,
    pub value_format: ValueFormat,
    pub batch_size: usize,
}

Available on crate features source-kinesis and source-rest only.

Configuration for KinesisSource.

Fields

stream_name: String

Kinesis Data Stream name.

region: Option<String>

AWS region. None uses the SDK default chain (env, profile, IMDS).

endpoint_url: Option<String>

Custom endpoint URL for LocalStack / VPC endpoints.

credentials: KinesisCredentials

AWS credentials. Defaults to the SDK default provider chain.

start_position: StartPosition

Start position for shards with no persisted bookmark.

shard_ids: Vec<String>

Explicit shard-id allowlist; empty = every shard.

include_closed: bool

Also consume closed (post-resharding) shards still inside the retention window. Default false (open shards only).

poll_interval_ms: u64

Base wait between GetRecords calls per shard, in milliseconds. Floored at 200 ms (the per-shard 5 reads/sec API limit). Default 1000.

records_per_request: usize

GetRecords Limit per request (1–10000). Default 500.

shard_concurrency: usize

Max shards read concurrently. Default 4.

idle_termination_secs: Option<u64>

Stop after this many seconds without a new record across all shards. At least one of idle_termination_secs and max_messages must be set (mirrors the Kafka source) — a batch run must terminate.

max_messages: Option<usize>

Stop after this many records in total.

value_format: ValueFormat

Payload decoding for the record data field.

batch_size: usize

Records per emitted StreamPage. 0 is the “no batching” sentinel: one page per drain cycle. Default 1000.

Implementations

impl KinesisSourceConfig

pub fn new(stream_name: impl Into<String>) -> KinesisSourceConfig

Minimal config with defaults for everything but the stream name.

pub fn validate(&self) -> Result<(), FaucetError>

Fail-fast validation, called from KinesisSource::new.

pub fn poll_interval(&self) -> Duration

Effective per-shard poll interval (floored at 200 ms).

Trait Implementations

impl Clone for KinesisSourceConfig

fn clone(&self) -> KinesisSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KinesisSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KinesisSourceConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<KinesisSourceConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for KinesisSourceConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for KinesisSourceConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.