Type Alias IdempotencyConfigOptions

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

Idempotency configuration options

Type declaration

  • OptionaleventKeyJmesPath?: string

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

  • OptionalexpiresAfterSeconds?: number

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

  • OptionalhashFunction?: string

    Function to use for calculating hashes, defaults to md5

  • OptionaljmesPathOptions?: Functions

    Custom JMESPath functions to use when parsing the JMESPath expressions

  • OptionallambdaContext?: Context

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

  • OptionalmaxLocalCacheSize?: number

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

  • OptionalpayloadValidationJmesPath?: string

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

  • OptionalresponseHook?: ResponseHook

    A hook that runs when an idempotent request is made

  • OptionalthrowOnNoIdempotencyKey?: boolean

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

  • OptionaluseLocalCache?: boolean

    Wheter to locally cache idempotency results, defaults to false

Settings

Member Visibility