Type alias IdempotencyConfigOptions

IdempotencyConfigOptions: {
    eventKeyJmesPath?: string;
    expiresAfterSeconds?: number;
    hashFunction?: string;
    lambdaContext?: Context;
    maxLocalCacheSize?: number;
    payloadValidationJmesPath?: string;
    throwOnNoIdempotencyKey?: boolean;
    useLocalCache?: boolean;
}

Idempotency configuration options

Type declaration

  • Optional eventKeyJmesPath?: string

    An optional JMESPath expression to extract the idempotency key from the event record

  • Optional expiresAfterSeconds?: number

    The number of seconds to wait before a record is expired, defaults to 3600 (1 hour)

  • Optional hashFunction?: string

    Function to use for calculating hashes, defaults to md5

  • Optional lambdaContext?: Context

    AWS Lambda Context object containing information about the current invocation, function, and execution environment

  • Optional maxLocalCacheSize?: number

    Number of records to keep in the local cache, defaults to 256

  • Optional payloadValidationJmesPath?: string

    An optional JMESPath expression to extract the payload to be validated from the event record

  • Optional throwOnNoIdempotencyKey?: boolean

    Throw an error if no idempotency key was found in the request, defaults to false

  • Optional useLocalCache?: boolean

    Wheter to locally cache idempotency results, defaults to false

Settings

Member Visibility

Theme