fs2.aws.kinesis
Type members
Classlikes
A message type from Kinesis which has not yet been commited or checkpointed.
A message type from Kinesis which has not yet been commited or checkpointed.
- Value parameters:
- checkpointer
reference to the checkpointer used to commit this record
- millisBehindLatest
ms behind the latest record, used to detect if the consumer is lagging the producer
- record
the original record document from Kinesis
- recordProcessor
reference to the record processor that is responsible for processing this message
- shardId
the unique identifier for the shard from which this record originated
- Constructor:
create a new commitable record with a name and age.
- Companion:
- object
Settings for configuring the Kinesis checkpointer pipe
Settings for configuring the Kinesis checkpointer pipe
- Value parameters:
- maxBatchSize
the maximum number of records to aggregate before checkpointing the cluster of records. Passing 1 means checkpoint on every record
- maxBatchWait
the maximum amount of time to wait before checkpointing the cluster of records
- Companion:
- object
Settings for configuring the Kinesis consumer
Settings for configuring the Kinesis consumer
- Value parameters:
- appName
name of the application which the KCL daemon should assume
- bufferSize
size of the internal buffer used when reading messages from Kinesis
- region
AWS region in which the Kinesis stream resides. Defaults to US-EAST-1
- retrievalMode
FanOut (push) or Polling (pull). Defaults to FanOut (the new default in KCL 2.x).
- streamName
name of the Kinesis stream to read from
- Companion:
- object
Used when constructing a [KinesisConsumerSettings] instance that will by used by a client for cross-account access.
Used when constructing a [KinesisConsumerSettings] instance that will by used by a client for cross-account access.
This currently implements only the minimum required fields defined in: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
- Value parameters:
- durationSeconds
The duration, in seconds, of the role session.
- externalId
A unique identifier that might be required when you assume a role in another account.
- roleArn
The Amazon Resource Name (ARN) of the role to assume.
- roleSessionName
An identifier for the assumed role session.
- Companion:
- object
fs2 Streams for publishing data to AWS Kinesis streams
fs2 Streams for publishing data to AWS Kinesis streams