Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface NimbleClientConfig

The configuration interface of NimbleClient class constructor that set the region, credentials and other options.

Hierarchy

Properties

credentials? customUserAgent? defaultsMode? disableHostPrefix? extensions? logger? retryMode? signer? signingEscapePath? signingRegion? systemClockOffset?

Properties

Optional credentials

credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>

The credentials used to sign requests.

Optional customUserAgent

customUserAgent?: string | UserAgent

The custom user agent header that would be appended to default one

Optional defaultsMode

defaultsMode?: DefaultsMode | Provider<DefaultsMode>

The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

Optional disableHostPrefix

disableHostPrefix?: boolean

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

Optional extensions

extensions?: RuntimeExtension[]

Optional extensions

Optional logger

logger?: Logger

Optional logger for logging debug/info/warn/error.

Optional retryMode

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

Optional signer

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

The signer to use when signing requests.

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