Interface ClientDefaults

Make all properties in T optional

interface ClientDefaults {
    cacheMiddleware?: boolean;
    defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
    disableHostPrefix?: boolean;
    extensions?: RuntimeExtension[];
    logger?: Logger;
    maxAttempts?: number | Provider<number>;
    profile?: string;
    protocol?: ClientProtocol<any, any> | $ClientProtocol<any, any> | ClientProtocolCtor<any, any> | $ClientProtocolCtor<any, any>;
    region?: string | Provider<string>;
    requestHandler?: HttpHandlerUserInput;
    retryMode?: string | Provider<string>;
    useDualstackEndpoint?: boolean | Provider<boolean>;
    useFipsEndpoint?: boolean | Provider<boolean>;
}

Hierarchy (view full)

Properties

cacheMiddleware? defaultsMode? disableHostPrefix? extensions? logger? maxAttempts? profile? protocol? region? requestHandler? retryMode? useDualstackEndpoint? useFipsEndpoint?

Properties

Optional cacheMiddleware

cacheMiddleware?: boolean

Default false.

When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be recognized.

Calling client.destroy() also clears this cache.

Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.

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 maxAttempts

maxAttempts?: number | Provider<number>

Value for how many times a request will be made at most in case of retry.

Optional profile

profile?: string

Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.

For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

Optional protocol

protocol?: ClientProtocol<any, any> | $ClientProtocol<any, any> | ClientProtocolCtor<any, any> | $ClientProtocolCtor<any, any>

A client request/response protocol or constructor of one. A protocol in this context is not e.g. https. It is the combined implementation of how to (de)serialize and create the messages (e.g. http requests/responses) that are being exchanged.

Optional region

region?: string | Provider<string>

The AWS region to which this client will send requests

Optional requestHandler

requestHandler?: HttpHandlerUserInput

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

Optional retryMode

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/

Optional useDualstackEndpoint

useDualstackEndpoint?: boolean | Provider<boolean>

Enables IPv6/IPv4 dualstack endpoint.

Optional useFipsEndpoint

useFipsEndpoint?: boolean | Provider<boolean>

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme

On This Page