Interface DynamoDBPersistenceOptionsWithClientInstance

Interface for DynamoDBPersistenceOptions with awsSdkV3Client property.

interface DynamoDBPersistenceOptionsWithClientInstance {
    awsSdkV3Client?: DynamoDBClient;
    clientConfig?: undefined;
    dataAttr?: string;
    expiryAttr?: string;
    inProgressExpiryAttr?: string;
    keyAttr?: string;
    sortKeyAttr?: string;
    staticPkValue?: string;
    statusAttr?: string;
    tableName: string;
    validationKeyAttr?: string;
}

Hierarchy (View Summary)

Properties

awsSdkV3Client? clientConfig? dataAttr? expiryAttr? inProgressExpiryAttr? keyAttr? sortKeyAttr? staticPkValue? statusAttr? tableName validationKeyAttr?

Properties

OptionalawsSdkV3Client

awsSdkV3Client?: DynamoDBClient

Optional AWS SDK v3 client to pass during DynamoDB client instantiation

OptionalclientConfig

clientConfig?: undefined

This property should never be passed.

OptionaldataAttr

dataAttr?: string

The DynamoDB table data attribute name. Defaults to 'data'.

OptionalexpiryAttr

expiryAttr?: string

The DynamoDB table expiry attribute name. Defaults to 'expiration'.

OptionalinProgressExpiryAttr

inProgressExpiryAttr?: string

The DynamoDB table in progress expiry attribute name. Defaults to 'in_progress_expiry_attr'.

OptionalkeyAttr

keyAttr?: string

The DynamoDB table key attribute name. Defaults to 'id'.

OptionalsortKeyAttr

sortKeyAttr?: string

The DynamoDB table sort key attribute name, use only when table has one. Defaults to undefined.

OptionalstaticPkValue

staticPkValue?: string

The DynamoDB table static partition key value, use only with sortKeyAttr. Defaults to idempotency#{LAMBDA_FUNCTION_NAME}.

OptionalstatusAttr

statusAttr?: string

The DynamoDB table status attribute name. Defaults to 'status'.

tableName

tableName: string

The DynamoDB table name.

OptionalvalidationKeyAttr

validationKeyAttr?: string

The DynamoDB table validation key attribute name. Defaults to 'validation'.

Settings

Member Visibility

On This Page

Properties