ts-lambda-api - v2.5.5
    Preparing search index...

    Interface SmithyConfiguration<HandlerOptions>

    interface SmithyConfiguration<HandlerOptions> {
        apiVersion: string;
        cacheMiddleware?: boolean;
        protocol?:
            | $ClientProtocol<any, any>
            | ClientProtocol<any, any>
            | ClientProtocolCtor<any, any>
            | $ClientProtocolCtor<any, any>;
        protocolSettings?: {
            defaultNamespace?: string;
            [setting: string]: unknown;
        };
        requestHandler: | Record<string, unknown>
        | NodeHttpHandlerOptions
        | FetchHttpHandlerOptions
        | RequestHandler<any, any, HandlerOptions>;
    }

    Type Parameters

    • HandlerOptions
    Index

    Properties

    apiVersion cacheMiddleware? protocol? protocolSettings? requestHandler

    Properties

    apiVersion: string

    The API version set internally by the SDK, and is not planned to be used by customer code.

    cacheMiddleware?: boolean

    Default false.

    When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be recognized.

    Calling client.destroy() also clears this cache.

    Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.

    protocol?:
        | $ClientProtocol<any, any>
        | ClientProtocol<any, any>
        | ClientProtocolCtor<any, any>
        | $ClientProtocolCtor<any, any>

    A client request/response protocol or constructor of one. A protocol in this context is not e.g. https. It is the combined implementation of how to (de)serialize and create the messages (e.g. http requests/responses) that are being exchanged.

    protocolSettings?: { defaultNamespace?: string; [setting: string]: unknown }

    These are automatically generated and will be passed to the config.protocol if given as a constructor.

    requestHandler:
        | Record<string, unknown>
        | NodeHttpHandlerOptions
        | FetchHttpHandlerOptions
        | RequestHandler<any, any, HandlerOptions>

    Settings

    Member Visibility

    On This Page

    Properties