Interface: AcquireLockInput

dynamo.AcquireLockInput

Properties

CreateIfNotFound

• Optional CreateIfNotFound: boolean

Allow acquireLock to create the item if it doesn’t exist.

---

Key

• Key: Record<string, any>

Key of the item to lock.

---

LeaseDuration

• Optional LeaseDuration: number

Time in milliseconds to reserve the lock for. To avoid any issues with clock-skew the lock lease expires only after another call to acquireLock has been waiting for it for the whole lease duration.

Defaults to 2000 milliseconds, ie. 2 seconds.

---

RetryDelay

• Optional RetryDelay: number

How many milliseconds to wait between acquire attempts. Defaults to 250 milliseconds.

---

RetryDuration

• Optional RetryDuration: number

How long to retry before giving up. Defaults to 3000 milliseconds, ie. 3 seconds.

---

TableName

• TableName: string

Table to lock the item from.