| streams | []string | no | no | One or more Kinesis data streams to consume from. Streams can either be specified by their name or full ARN. Shards of a stream are automatically balanced across consumers by coordinating through the provided DynamoDB table. Multiple comma separated streams can be listed in a single element. Shards are automatically distributed across consumers of a stream by coordinating through the provided DynamoDB table. Alternatively, it's possible to specify an explicit shard to consume from with a colon after the stream name, e.g. foo:0 would consume the shard 0 of the stream foo. |
| dynamodb | dynamodb | yes | no | Determines the table used for storing and accessing the latest consumed sequence for shards, and for coordinating balanced consumers of streams. |
| checkpoint_limit | int | yes | no | The maximum gap between the in flight sequence versus the latest acknowledged sequence at a given time. Increasing this limit enables parallel processing and batching at the output level to work on individual shards. Any given sequence will not be committed unless all messages under that offset are delivered in order to preserve at least once delivery guarantees. The value defaults to 1024. |
| auto_replay_nacks | bool | yes | no | Whether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to false these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation. The value defaults to true. |
| commit_period | string | yes | no | The period of time between each update to the checkpoint table. The value defaults to 5s. |
| rebalance_period | string | yes | no | The period of time between each attempt to rebalance shards across clients. The value defaults to 30s. |
| lease_period | string | yes | no | The period of time after which a client that has failed to update a shard checkpoint is assumed to be inactive. The value defaults to 30s. |
| start_from_oldest | bool | yes | no | Whether to consume from the oldest message when a sequence does not yet exist for the stream. The value defaults to true. |
| region | string | no | no | The AWS region to target. |
| endpoint | string | yes | no | Allows you to specify a custom endpoint for the AWS API. The value defaults to ``. |
| credentials | credentials | no | no | Optional manual configuration of AWS credentials to use. More information can be found in xref:guides:cloud/aws.adoc[]. |
