Interface AwsSdkSigV4AuthInputConfig

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

Hierarchy (view full)

AwsSdkSigV4AuthInputConfig

Index

Properties

credentials? signer? signingEscapePath? signingRegion? systemClockOffset?

Properties

`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

- (authScheme?): Promise<RequestSigner>
- Parameters
  - Optional authScheme: AuthScheme
  Returns Promise<RequestSigner>

`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.