kinesis_client v1.0.0-rc.0 KinesisClient.Stream View Source

This is the entry point for processing the shards of a Kinesis Data Stream.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Callback implementation for Supervisor.init/1.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Callback implementation for Supervisor.init/1.

Starts a KinesisClient.Stream process.

Options

  • :stream_name - Required. The Kinesis Data Stream to process.
  • :app_name - Required.This should be a unique name across all your applications and the DynamodDB tablespace in your AWS region
  • :name - The process name. Defaults to KinesisClient.Stream.
  • :max_demand - The maximum number of records to retrieve from Kinesis. Defaults to 100.
  • :aws_region - AWS region. Will rely on ExAws defaults if not set.
  • :shard_supervisor - The child_spec for the Supervisor that monitors the ProcessingPipelines. Must implement the DynamicSupervisor behaviour.
  • :lease_renew_interval(optional) - How long (in milliseconds) a lease will be held before a renewal is attempted.
  • :lease_expiry(optional) - The lenght of time in milliseconds that least lasts for. If a lease is not renewed within this time frame, then that lease is considered expired and can be taken by another process.