Class DynamoDBPersistenceLayer

DynamoDB persistence layer for idempotency records.

This class uses the AWS SDK for JavaScript v3 to write and read idempotency records from DynamoDB.

There are various options to configure the persistence layer, such as the table name, the key attribute, the status attribute, etc.

With default configuration you don't need to create the client beforehand, the persistence layer will create it for you. You can also bring your own AWS SDK V3 client, or configure the client with the clientConfig option.

See the Idempotency documentation for more details on the IAM permissions and DynamoDB table configuration.

Example

import { DynamoDBPersistenceLayer } from '@aws-lambda-powertools/idempotency/dynamodb';

const persistence = new DynamoDBPersistenceLayer({
  tableName: 'my-idempotency-table',
});

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/index.html

Implements

Hierarchy (view full)

BasePersistenceLayer
- DynamoDBPersistenceLayer

Index

Constructors

constructor

new DynamoDBPersistenceLayer(config): DynamoDBPersistenceLayer
Parameters
- config: DynamoDBPersistenceOptions
Returns DynamoDBPersistenceLayer
Overrides BasePersistenceLayer.constructor
- Defined in packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts:64

Properties

idempotencyKeyPrefix

idempotencyKeyPrefix: string

Methods

`Protected` _deleteRecord

_deleteRecord(record): Promise<void>
Parameters
- record: IdempotencyRecord
Returns Promise<void>
Overrides BasePersistenceLayer._deleteRecord
- Defined in packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts:99

`Protected` _getRecord

_getRecord(idempotencyKey): Promise<IdempotencyRecord>
Parameters
- idempotencyKey: string
Returns Promise<IdempotencyRecord>
Overrides BasePersistenceLayer._getRecord
- Defined in packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts:108

`Protected` _putRecord

_putRecord(record): Promise<void>
Parameters
- record: IdempotencyRecord
Returns Promise<void>
Overrides BasePersistenceLayer._putRecord
- Defined in packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts:134

`Protected` _updateRecord

_updateRecord(record): Promise<void>
Parameters
- record: IdempotencyRecord
Returns Promise<void>
Overrides BasePersistenceLayer._updateRecord
- Defined in packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts:227

configure

configure(config): void
Initialize the base persistence layer from the configuration settings
Parameters
- config: BasePersistenceLayerOptions
  configuration object for the persistence layer
Returns void
Inherited from BasePersistenceLayer.configure
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:50

deleteRecord

deleteRecord(data): Promise<void>
Deletes a record from the persistence store for the persistence key generated from the data passed in.
Parameters
- data: JSONValue
  the data payload that will be hashed to create the hash portion of the idempotency key
Returns Promise<void>
Inherited from BasePersistenceLayer.deleteRecord
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:86

getExpiresAfterSeconds

getExpiresAfterSeconds(): number
Retrieve the number of seconds that records will be kept in the persistence store

Returns number
Inherited from BasePersistenceLayer.getExpiresAfterSeconds
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:100

getRecord

getRecord(data): Promise<IdempotencyRecord>
Retrieves idempotency key for the provided data and fetches data for that key from the persistence store
Parameters
- data: JSONValue
  the data payload that will be hashed to create the hash portion of the idempotency key
Returns Promise<IdempotencyRecord>
Inherited from BasePersistenceLayer.getRecord
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:109

isPayloadValidationEnabled

isPayloadValidationEnabled(): boolean
Check whether payload validation is enabled or not

Returns boolean
Inherited from BasePersistenceLayer.isPayloadValidationEnabled
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:128

processExistingRecord

processExistingRecord(storedDataRecord, processedData): IdempotencyRecord
Validates an existing record against the data payload being processed. If the payload does not match the stored record, an IdempotencyValidationError error is thrown.

Whenever a record is retrieved from the persistence layer, it should be validated against the data payload being processed. This is to ensure that the data payload being processed is the same as the one that was used to create the record in the first place.

The record is also saved to the local cache if local caching is enabled.
Parameters
- storedDataRecord: IdempotencyRecord
- processedData: JSONValue | IdempotencyRecord
Returns IdempotencyRecord
Inherited from BasePersistenceLayer.processExistingRecord
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:145

saveInProgress

saveInProgress(data, remainingTimeInMillis?): Promise<void>
Saves a record indicating that the function's execution is currently in progress
Parameters
- data: JSONValue
  the data payload that will be hashed to create the hash portion of the idempotency key
- Optional remainingTimeInMillis: number
  the remaining time left in the lambda execution context
Returns Promise<void>
Inherited from BasePersistenceLayer.saveInProgress
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:161

saveSuccess

saveSuccess(data, result): Promise<void>
Saves a record of the function completing successfully. This will create a record with a COMPLETED status and will save the result of the completed function in the idempotency record.
Parameters
- data: JSONValue
  the data payload that will be hashed to create the hash portion of the idempotency key
- result: JSONValue
  the result of the successfully completed function
Returns Promise<void>
Inherited from BasePersistenceLayer.saveSuccess
- Defined in packages/idempotency/src/persistence/BasePersistenceLayer.ts:198

Class DynamoDBPersistenceLayer

Example

See

Implements

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DynamoDBPersistenceLayer

Properties

idempotencyKeyPrefix

Methods

Protected _deleteRecord

Parameters

Returns Promise<void>

Protected _getRecord

Parameters

Returns Promise<IdempotencyRecord>

Protected _putRecord

Parameters

Returns Promise<void>

Protected _updateRecord

Parameters

Returns Promise<void>

configure

Parameters

Returns void

deleteRecord

Parameters

Returns Promise<void>

getExpiresAfterSeconds

Returns number

getRecord

Parameters

Returns Promise<IdempotencyRecord>

isPayloadValidationEnabled

Returns boolean

processExistingRecord

Parameters

Returns IdempotencyRecord

saveInProgress

Parameters

Returns Promise<void>

saveSuccess

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Protected` _deleteRecord

`Protected` _getRecord

`Protected` _putRecord

`Protected` _updateRecord