Skip to content

Commit 72a8e57

Browse files
committed
docs(idempotency): add default configuration for those not using CFN
1 parent 882e07f commit 72a8e57

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/utilities/idempotency.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,26 @@ times with the same parameters**. This makes idempotent operations safe to retry
3030

3131
### Required resources
3232

33-
Before getting started, you need to create a persistent storage layer where the idempotency utility can store its
34-
state - your lambda functions will need read and write access to it.
33+
Before getting started, you need to create a persistent storage layer where the idempotency utility can store its state - your lambda functions will need read and write access to it.
3534

3635
As of now, Amazon DynamoDB is the only supported persistent storage layer, so you'll need to create a table first.
3736

38-
> Example using AWS Serverless Application Model (SAM)
37+
**Default table configuration**
38+
39+
If you're not [changing the default configuration for the DynamoDB persistence layer](#dynamodbpersistencelayer), this is the expected default configuration:
40+
41+
Configuration | Value | Notes
42+
------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------
43+
Partition key | `id` |
44+
TTL attribute name | `expiration` | This can only be configured after your table is created if you're using AWS Console
3945

40-
=== "template.yml"
4146

42-
!!! tip "You can share a single state table for all functions"
43-
> New in 1.12.0
47+
!!! tip "You can share a single state table for all functions"
48+
You can reuse the same DynamoDB table to store idempotency state. We add your `function_name` in addition to the idempotency key as a hash key.
4449

45-
You can reuse the same DynamoDB table to store idempotency state. We add your function_name in addition to the idempotency key as a hash key.
50+
> Example using AWS Serverless Application Model (SAM)
51+
52+
=== "template.yml"
4653

4754
```yaml hl_lines="5-13 21-23"
4855
Resources:

0 commit comments

Comments
 (0)