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

    Interface HttpAuthSchemeInputConfigInternal

    interface HttpAuthSchemeInputConfig {
        authSchemePreference?: string[] | Provider<string[]>;
        credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
        httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
        httpAuthSchemes?: HttpAuthScheme[];
        signer?:
            | RequestSigner
            | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
        signerConstructor?: new (
            options: SignatureV4Init & SignatureV4CryptoInit,
        ) => RequestSigner;
        signingEscapePath?: boolean;
        signingRegion?: string;
        sigv4aSigningRegionSet?: string[] | Provider<string[]>;
        systemClockOffset?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authSchemePreference? credentials? httpAuthSchemeProvider? httpAuthSchemes? signer? signerConstructor? signingEscapePath? signingRegion? sigv4aSigningRegionSet? systemClockOffset?

    Properties

    authSchemePreference?: string[] | Provider<string[]>

    A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

    The credentials used to sign requests.

    httpAuthSchemeProvider?: S3HttpAuthSchemeProvider

    Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

    httpAuthSchemes?: HttpAuthScheme[]

    Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

    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.

    sigv4aSigningRegionSet?: string[] | Provider<string[]>

    This option will override the AWS sigv4a signing regionSet from any other source.

    The lookup order is:

    1. this value
    2. configuration file value of sigv4a_signing_region_set.
    3. environment value of AWS_SIGV4A_SIGNING_REGION_SET.
    4. signingRegionSet given by endpoint resolution.
    5. the singular region of the SDK client.
    systemClockOffset?: number

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

    Settings

    Member Visibility

    On This Page

    Properties