Interface PollyClientResolvedConfig

The resolved configuration interface of PollyClient class. This is resolved and normalized from the constructor configuration interface.

interface PollyClientResolvedConfig {
    cacheMiddleware: boolean;
    credentials: AwsCredentialIdentityProvider;
    customUserAgent?: UserAgent;
    defaultSigningName: string;
    defaultsMode: DefaultsMode | Provider<DefaultsMode>;
    disableHostPrefix: boolean;
    endpoint?: Provider<Endpoint> & (string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<...>);
    endpointProvider: ((params, context?) => EndpointV2);
    extensions: RuntimeExtension[];
    logger: Logger;
    maxAttempts: Provider<number> | number & Provider<number>;
    region: (string | Provider<string>) & (Provider<string> | Provider<string> & string);
    requestHandler: RequestHandler<any, any, HttpHandlerOptions> & (HttpHandlerUserInput & RequestHandler<any, any, {}>);
    retryMode: string | Provider<string>;
    retryStrategy: Provider<RetryStrategy | RetryStrategyV2>;
    signer: ((authScheme?) => Promise<RequestSigner>);
    signingEscapePath: boolean;
    systemClockOffset: number;
    tls: boolean;
    useDualstackEndpoint: (boolean | Provider<boolean>) & (Provider<boolean> | Provider<boolean> & false | Provider<boolean> & true);
    useFipsEndpoint: (boolean | Provider<boolean>) & (Provider<boolean> | Provider<boolean> & false | Provider<boolean> & true);
}

Hierarchy (view full)

Properties

cacheMiddleware credentials customUserAgent? defaultSigningName defaultsMode disableHostPrefix endpoint? endpointProvider extensions logger maxAttempts region requestHandler retryMode retryStrategy signer signingEscapePath systemClockOffset tls useDualstackEndpoint useFipsEndpoint

Properties

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.

credentials

credentials: AwsCredentialIdentityProvider

Resolved value for input config AwsSdkSigV4AuthInputConfig.credentials This provider MAY memoize the loaded credentials for certain period. See MemoizedProvider for more information.

Optional customUserAgent

customUserAgent?: UserAgent

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

defaultSigningName

defaultSigningName: string

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.

disableHostPrefix

disableHostPrefix: boolean

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

Optional endpoint

endpoint?: Provider<Endpoint> & (string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<...>)

Custom endpoint provided by the user. This is normalized to a single interface from the various acceptable types. This field will be undefined if a custom endpoint is not provided.

endpointProvider

endpointProvider: ((params, context?) => EndpointV2)

Type declaration

extensions

extensions: RuntimeExtension[]

Optional extensions

logger

logger: Logger

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

maxAttempts

maxAttempts: Provider<number> | number & Provider<number>

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

region

region: (string | Provider<string>) & (Provider<string> | Provider<string> & string)

The AWS region to which this client will send requests

requestHandler

requestHandler: RequestHandler<any, any, HttpHandlerOptions> & (HttpHandlerUserInput & RequestHandler<any, any, {}>)

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

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/

retryStrategy

retryStrategy: Provider<RetryStrategy | RetryStrategyV2>

Resolved value for input config RetryInputConfig.retryStrategy

signer

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

Resolved value for input config AwsSdkSigV4AuthInputConfig.signer

Type declaration

signingEscapePath

signingEscapePath: boolean

Resolved value for input config AwsSdkSigV4AuthInputConfig.signingEscapePath

systemClockOffset

systemClockOffset: number

Resolved value for input config AwsSdkSigV4AuthInputConfig.systemClockOffset

tls

tls: boolean

Whether TLS is enabled for requests.

Deprecated

useDualstackEndpoint

useDualstackEndpoint: (boolean | Provider<boolean>) & (Provider<boolean> | Provider<boolean> & false | Provider<boolean> & true)

Enables IPv6/IPv4 dualstack endpoint.

useFipsEndpoint

useFipsEndpoint: (boolean | Provider<boolean>) & (Provider<boolean> | Provider<boolean> & false | Provider<boolean> & true)

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme

On This Page