Struct DynamoDbSourceConfig 

pub struct DynamoDbSourceConfig {

    pub table_name: String,
    pub region: Option<String>,
    pub endpoint_url: Option<String>,
    pub credentials: DynamoDbCredentials,
    pub mode: ReadMode,
    pub segments: u32,
    pub max_concurrency: usize,
    pub index_name: Option<String>,
    pub projection: Option<String>,
    pub filter_expression: Option<String>,
    pub key_condition_expression: Option<String>,
    pub expression_attribute_names: BTreeMap<String, String>,
    pub expression_attribute_values: BTreeMap<String, Value>,
    pub consistent_read: bool,
    pub scan_index_forward: bool,
    pub page_limit: Option<u32>,
    pub stream_arn: Option<String>,
    pub start_position: StreamStart,
    pub on_gap: OnGap,
    pub resnapshot_deletes: bool,
    pub resnapshot_max_keys: usize,
    pub poll_interval_ms: u64,
    pub records_per_request: u32,
    pub shard_concurrency: usize,
    pub idle_termination_secs: Option<u64>,
    pub max_messages: Option<usize>,
    pub retry: RetryPolicy,
    pub batch_size: usize,
    pub value_format: ValueFormat,
}

Configuration for DynamoDbSource.

Fields

table_name: String

Table name.

region: Option<String>

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

endpoint_url: Option<String>

Custom endpoint URL (DynamoDB Local, LocalStack, VPC endpoints).

credentials: DynamoDbCredentials

AWS credentials. Defaults to the SDK default provider chain.

mode: ReadMode

scan (default), query, or streams.

segments: u32

Parallel scan segments (TotalSegments), 1–1000000. Scan only.

max_concurrency: usize

Segments read concurrently. Default 8.

index_name: Option<String>

Secondary index to scan or query.

projection: Option<String>

ProjectionExpression — the attributes to return.

filter_expression: Option<String>

FilterExpression applied server-side after the read.

key_condition_expression: Option<String>

KeyConditionExpression. Required for query, rejected otherwise.

expression_attribute_names: BTreeMap<String, String>

ExpressionAttributeNames (#name → attribute).

expression_attribute_values: BTreeMap<String, Value>

ExpressionAttributeValues (:value → plain JSON value).

consistent_read: bool

Strongly consistent reads (table and local secondary indexes only).

scan_index_forward: bool

Query order: ascending sort key when true (default).

page_limit: Option<u32>

Limit per Scan/Query request (items evaluated per call).

stream_arn: Option<String>

Stream ARN. Defaults to the table’s LatestStreamArn. Streams only.

start_position: StreamStart

Start for shards with no bookmark and no parent that was read.

on_gap: OnGap

Reaction to a bookmark older than the trim horizon.

resnapshot_deletes: bool

on_gap: resnapshot: after the re-read, delete the destination rows of items it did not see (default true; the sink must support cleanup). false keeps the resnapshot for any sink but leaves the destination rows of items deleted while their stream records were trimmed.

resnapshot_max_keys: usize

on_gap: resnapshot: the most distinct keys the re-read tracks for its delete (default 1,000,000; memory grows with it). A table with more items fails that run once with nothing deleted; its position is saved, so the next run resumes streaming.

poll_interval_ms: u64

Base wait between GetRecords calls per shard, in ms (floored at 200).

records_per_request: u32

GetRecords Limit per request (1–1000). Default 1000.

shard_concurrency: usize

Shards read concurrently. Default 4.

idle_termination_secs: Option<u64>

Streams: stop after this many seconds without a new record. At least one of idle_termination_secs / max_messages is required in streams mode.

max_messages: Option<usize>

Streams: stop after this many change records.

retry: RetryPolicy

Throttle / transient-failure retry policy.

batch_size: usize

Records per emitted page. 0 is the “no batching” sentinel. Default 1000.

value_format: ValueFormat

How attribute values appear in records: plain JSON (default; sets become arrays, binaries base64 strings, imprecise numbers decimal strings) or typed DynamoDB attribute JSON ({"S": "a"}, {"SS": ["x"]}, {"B": "<base64>"}) that a value_format: typed DynamoDB sink writes back losslessly. Applies to scan/query items and to Streams key / before / after images.

Implementations

impl DynamoDbSourceConfig

pub fn new(table_name: impl Into<String>) -> Self

Scan config with defaults for everything but the table name.

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

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

pub fn poll_interval(&self) -> Duration

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

Trait Implementations

impl Clone for DynamoDbSourceConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamoDbSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynamoDbSourceConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DynamoDbSourceConfig

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 DynamoDbSourceConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.