You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/utilities/idempotency.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -569,16 +569,16 @@ When using DynamoDB as a persistence layer, you can alter the attribute names by
569
569
570
570
Idempotent decorator can be further configured with **`IdempotencyConfig`** as seen in the previous examples. These are the available options for further configuration
|**eventKeyJmespath**|`''`| JMESPath expression to extract the idempotency key from the event |
575
-
|**payloadValidationJmespath**|`''`| JMESPath expression to validate whether certain parameters have changed in the event while the event payload |
576
-
|**throwOnNoIdempotencyKey**|`false`| Throw an error if no idempotency key was found in the request |
577
-
|**expiresAfterSeconds**| 3600 | The number of seconds to wait before a record is expired|
578
-
|**useLocalCache**|`false`| Whether to locally cache idempotency results |
579
-
|**localCacheMaxItems**| 256 | Max number of items to store in local cache |
580
-
|**hashFunction**|`md5`| Function to use for calculating hashes, as provided by the [crypto](https://nodejs.org/api/crypto.html#cryptocreatehashalgorithm-options){target="_blank"} module in the standard library. |
581
-
|**responseHook**|`undefined`| Function to use for processing the stored Idempotent response. This function hook is called when an existing idempotent response is found. See [Manipulating The Idempotent Response](idempotency.md#manipulating-the-idempotent-response)|
|**eventKeyJmespath**|`''`| JMESPath expression to extract the idempotency key from the event record using [built-in functions](./jmespath.md#built-in-jmespath-functions){target="_blank"}|
575
+
|**payloadValidationJmespath**|`''`| JMESPath expression to validate that the specified fields haven't changed across requests for the same idempotency key _e.g., payload tampering._|
576
+
|**throwOnNoIdempotencyKey**|`false`| Throw an error if no idempotency key was found in the request|
577
+
|**expiresAfterSeconds**| 3600 | The number of seconds to wait before a record is expired, allowing a new transaction with the same idempotency key|
578
+
|**useLocalCache**|`false`| Whether to cache idempotency results in-memory to save on persistence storage latency and costs|
579
+
|**localCacheMaxItems**| 256 | Max number of items to store in local cache|
580
+
|**hashFunction**|`md5`| Function to use for calculating hashes, as provided by the [crypto](https://nodejs.org/api/crypto.html#cryptocreatehashalgorithm-options){target="_blank"} module in the standard library.|
581
+
|**responseHook**|`undefined`| Function to use for processing the stored Idempotent response. This function hook is called when an existing idempotent response is found. See [Manipulating The Idempotent Response](idempotency.md#manipulating-the-idempotent-response)|
582
582
583
583
### Handling concurrent executions with the same payload
0 commit comments