software.amazon.lambda.powertools.idempotency.persistence

Class DynamoDBPersistenceStore

java.lang.Object

software.amazon.lambda.powertools.idempotency.persistence.BasePersistenceStore

software.amazon.lambda.powertools.idempotency.persistence.DynamoDBPersistenceStore

All Implemented Interfaces:

PersistenceStore

public class DynamoDBPersistenceStore
extends BasePersistenceStore
implements PersistenceStore

DynamoDB version of the PersistenceStore. Will store idempotency data in DynamoDB.
Use the DynamoDBPersistenceStore.Builder to create a new instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamoDBPersistenceStore.Builder Use this builder to get an instance of DynamoDBPersistenceStore. With this builder you can configure the characteristics of the DynamoDB Table (name, key, sort key, and other field names). You can also set a custom DynamoDbClient for further tuning.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDEMPOTENCY

Fields inherited from class software.amazon.lambda.powertools.idempotency.persistence.BasePersistenceStore

payloadValidationEnabled

Method Summary

Modifier and Type	Method and Description
static DynamoDBPersistenceStore.Builder	builder()
void	deleteRecord(java.lang.String idempotencyKey) Remove item from persistence store
DataRecord	getRecord(java.lang.String idempotencyKey) Retrieve item from persistence store using idempotency key and return it as a DataRecord instance.
void	putRecord(DataRecord record, java.time.Instant now) Store's the given idempotency record in the DDB store.
void	updateRecord(DataRecord record) Update item in persistence store

Methods inherited from class software.amazon.lambda.powertools.idempotency.persistence.BasePersistenceStore

configure, deleteRecord, getRecord, saveInProgress, saveSuccess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDEMPOTENCY

public static final java.lang.String IDEMPOTENCY

See Also:

Constant Field Values

Method Detail

builder

public static DynamoDBPersistenceStore.Builder builder()

getRecord

public DataRecord getRecord(java.lang.String idempotencyKey)
                     throws IdempotencyItemNotFoundException

Description copied from interface: PersistenceStore

Retrieve item from persistence store using idempotency key and return it as a DataRecord instance.

Specified by:

getRecord in interface PersistenceStore

Parameters:

idempotencyKey - the key of the record

Returns:

DataRecord representation of existing record found in persistence store

Throws:

IdempotencyItemNotFoundException - Exception thrown if no record exists in persistence store with the idempotency key

putRecord

public void putRecord(DataRecord record,
                      java.time.Instant now)
               throws IdempotencyItemAlreadyExistsException

Store's the given idempotency record in the DDB store. If there is an existing record that has expired - either due to the cache expiry or due to the in_progress_expiry - the record will be overwritten and the idempotent operation can continue. Note: This method writes only expiry and status information - not the results of the operation itself.

Specified by:

putRecord in interface PersistenceStore

Parameters:

record - DataRecord instance to store

now -

Throws:

IdempotencyItemAlreadyExistsException

updateRecord

public void updateRecord(DataRecord record)

Description copied from interface: PersistenceStore

Update item in persistence store

Specified by:

updateRecord in interface PersistenceStore

Parameters:

record - DataRecord instance

deleteRecord

public void deleteRecord(java.lang.String idempotencyKey)

Description copied from interface: PersistenceStore

Remove item from persistence store

Specified by:

deleteRecord in interface PersistenceStore

Parameters:

idempotencyKey - the key of the record