@aws-lambda-powertools/idempotency/lib/cjs/types/DynamoDBPersistence.d.ts

The idempotency package for the Powertools for AWS Lambda (TypeScript) library. It provides options to make your Lambda functions idempotent and safe to retry.

import type { DynamoDBClient, DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
/**
 * Base interface for DynamoPersistenceOptions.
 *
 * @interface
 * @property {string} tableName - The DynamoDB table name.
 * @property {string} [keyAttr] - The DynamoDB table key attribute name. Defaults to 'id'.
 * @property {string} [expiryAttr] - The DynamoDB table expiry attribute name. Defaults to 'expiration'.
 * @property {string} [inProgressExpiryAttr] - The DynamoDB table in progress expiry attribute name. Defaults to 'in_progress_expiry_attr'.
 * @property {string} [statusAttr] - The DynamoDB table status attribute name. Defaults to 'status'.
 * @property {string} [dataAttr] - The DynamoDB table data attribute name. Defaults to 'data'.
 * @property {string} [validationKeyAttr] - The DynamoDB table validation key attribute name. Defaults to 'validation'.
 * @property {string} [sortKeyAttr] - The DynamoDB table sort key attribute name, use only when table has one. Defaults to undefined.
 * @property {string} [staticPkValue] - The DynamoDB table static partition key value, use only with sortKeyAttr. Defaults to `idempotency#{LAMBDA_FUNCTION_NAME}`.
 */
interface DynamoDBPersistenceOptionsBase {
    tableName: string;
    keyAttr?: string;
    expiryAttr?: string;
    inProgressExpiryAttr?: string;
    statusAttr?: string;
    dataAttr?: string;
    validationKeyAttr?: string;
    sortKeyAttr?: string;
    staticPkValue?: string;
}
/**
 * Interface for DynamoDBPersistenceOptions with clientConfig property.
 *
 * @interface
 * @property {DynamoDBClientConfig} [clientConfig] - Optional configuration to pass during client initialization, e.g. AWS region.
 * @property {never} [awsSdkV3Client] - This property should never be passed.
 */
interface DynamoDBPersistenceOptionsWithClientConfig extends DynamoDBPersistenceOptionsBase {
    awsSdkV3Client?: never;
    /**
     * Optional configuration to pass during client initialization, e.g. AWS region. It accepts the same configuration object as the AWS SDK v3 client (`DynamoDBClient`).
     */
    clientConfig?: DynamoDBClientConfig;
}
/**
 * Interface for DynamoDBPersistenceOptions with awsSdkV3Client property.
 *
 * @interface
 * @property {DynamoDBClient} [awsSdkV3Client] - Optional AWS SDK v3 client to pass during DynamoDB client instantiation
 * @property {never} [clientConfig] - This property should never be passed.
 */
interface DynamoDBPersistenceOptionsWithClientInstance extends DynamoDBPersistenceOptionsBase {
    /**
     * Optional AWS SDK v3 client instance (`DynamoDBClient`) to use for DynamoDB operations. If not provided, we will create a new instance of `DynamoDBClient`.
     */
    awsSdkV3Client?: DynamoDBClient;
    clientConfig?: never;
}
/**
 * Options for the {@link persistence/DynamoDBPersistenceLayer.DynamoDBPersistenceLayer | DynamoDBPersistenceLayer} class constructor.
 *
 * @see {@link DynamoDBPersistenceOptionsBase}, {@link DynamoDBPersistenceOptionsWithClientConfig}, and {@link DynamoDBPersistenceOptionsWithClientInstance} for full list of properties.
 *
 * @type DynamoDBPersistenceOptions
 * @property {string} tableName - The DynamoDB table name.
 * @property {string} [keyAttr] - The DynamoDB table key attribute name. Defaults to 'id'.
 * @property {string} [expiryAttr] - The DynamoDB table expiry attribute name. Defaults to 'expiration'.
 * @property {string} [inProgressExpiryAttr] - The DynamoDB table in progress expiry attribute name. Defaults to 'in_progress_expiry_attr'.
 * @property {string} [statusAttr] - The DynamoDB table status attribute name. Defaults to 'status'.
 * @property {string} [dataAttr] - The DynamoDB table data attribute name. Defaults to 'data'.
 * @property {string} [validationKeyAttr] - The DynamoDB table validation key attribute name. Defaults to 'validation'.
 * @property {string} [sortKeyAttr] - The DynamoDB table sort key attribute name, use only when table has one. Defaults to undefined.
 * @property {string} [staticPkValue] - The DynamoDB table static partition key value, use only with sortKeyAttr. Defaults to `idempotency#{LAMBDA_FUNCTION_NAME}`.
 * @property {DynamoDBClientConfig} [clientConfig] - Optional configuration to pass during client initialization, e.g. AWS region. Mutually exclusive with awsSdkV3Client.
 * @property {DynamoDBClient} [awsSdkV3Client] - Optional AWS SDK v3 client to pass during DynamoDBProvider class instantiation. Mutually exclusive with clientConfig.
 */
type DynamoDBPersistenceOptions = DynamoDBPersistenceOptionsWithClientConfig | DynamoDBPersistenceOptionsWithClientInstance;
export type { DynamoDBPersistenceOptionsBase, DynamoDBPersistenceOptionsWithClientConfig, DynamoDBPersistenceOptionsWithClientInstance, DynamoDBPersistenceOptions, };
//# sourceMappingURL=DynamoDBPersistence.d.ts.map