Interface HttpAuthSchemeInputConfig

interface HttpAuthSchemeInputConfig {
    authSchemePreference?: string[] | Provider<string[]>;
    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
    signer?: RequestSigner | ((authScheme?) => Promise<RequestSigner>);
    signingEscapePath?: boolean;
    signingRegion?: string;
    systemClockOffset?: number;
}

Hierarchy (view full)

Properties

authSchemePreference? credentials? signer? signingEscapePath? signingRegion? systemClockOffset?

Properties

Optional authSchemePreference

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.

Optional credentials

credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

The credentials used to sign requests.

Optional signer

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

The signer to use when signing requests.

Type declaration

Optional signingEscapePath

signingEscapePath?: boolean

Whether to escape request path when signing the request.

Optional signingRegion

signingRegion?: string

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

Optional systemClockOffset

systemClockOffset?: number

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

Settings

Member Visibility

Theme

On This Page