Aws.Kinesis.Client.Consumer.Internal.Kit

Documentation

data ConsumerKit

The ConsumerKit contains what is needed to initialize a KinesisConsumer.

Constructors

ConsumerKit

Fields

_ckKinesisKit :: !KinesisKit

The credentials and configuration for making requests to AWS Kinesis.

_ckStreamName :: !StreamName

The name of the stream to consume from.

_ckBatchSize :: !Natural

The number of records to fetch at once from the stream.

_ckIteratorType :: !ShardIteratorType

The type of iterator to consume.

_ckSavedStreamState :: !(Maybe SavedStreamState)

Optionally, an initial stream state. The iterator type in _ckIteratorType will be used for any shards not present in the saved stream state; otherwise, AfterSequenceNumber will be used.

makeConsumerKit :: KinesisKit -> StreamName -> ConsumerKit

Create a ConsumerKit with default settings (using iterator type Latest and a batch size of 200).

ckKinesisKit :: Lens' ConsumerKit KinesisKit

A lens for _ckKinesisKit.

ckStreamName :: Lens' ConsumerKit StreamName

A lens for _ckStreamName.

ckBatchSize :: Lens' ConsumerKit Natural

A lens for _ckBatchSize.

ckIteratorType :: Lens' ConsumerKit ShardIteratorType

A lens for _ckIteratorType.

ckSavedStreamState :: Lens' ConsumerKit (Maybe SavedStreamState)

A lens for _ckSavedStreamState.