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

    Interface AwsSdkSigV4AuthInputConfig

    interface AwsSdkSigV4AuthInputConfig {
        credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
        signer?:
            | RequestSigner
            | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
        signerConstructor?: new (
            options: SignatureV4Init & SignatureV4CryptoInit,
        ) => RequestSigner;
        signingEscapePath?: boolean;
        signingRegion?: string;
        systemClockOffset?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    credentials? signer? signerConstructor? signingEscapePath? signingRegion? systemClockOffset?

    Properties

    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

    The credentials used to sign requests.

    signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

    The signer to use when signing requests.

    signerConstructor?: new (
        options: SignatureV4Init & SignatureV4CryptoInit,
    ) => RequestSigner

    The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.

    signingEscapePath?: boolean

    Whether to escape request path when signing the request.

    signingRegion?: string

    The region where you want to sign your request against. This can be different to the region in the endpoint.

    systemClockOffset?: number

    An offset value in milliseconds to apply to all signing times.

    Settings

    Member Visibility

    On This Page

    Properties