luciano/amazon-kinesis-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation: addressed comments for leases.

Browse source
This commit is contained in:
stair 2023-10-31 18:07:47 -04:00
parent af5501b714
commit c5e3d5e22c
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/leases-and-lease-lifecycle.md
View file

@ -9,12 +9,12 @@ This document should help provide insights into the lease lifecycle.
In KCL, a lease provides a temporal assignment between one Kinesis shard and an assigned worker.
Leases are persistent for the duration of shard processing (detailed later).
However, lease assignment is transient -- leases may be "stolen" by other workers in the same KCL application.
However, the worker that is processing a lease may change since leases may be "stolen" by other workers in the same KCL application.
## Lease Table
To persist metadata about lease state (e.g., last read checkpoint, current assigned worker), KCL creates a lease table in [DynamoDB][dynamodb].
Each KCL application will have its own distinct lease table that transcludes the application name.
Each KCL application will have its own distinct lease table that includes the application name.
More information, including schema, is provided at [KCL LeaseTable][kcl-leasetable].
## Lease Assignment