Jump to Content

Interface DynamoDBClientResolvedConfig

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

Hierarchy

  • DynamoDBClientResolvedConfigType
    • DynamoDBClientResolvedConfig

Properties

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

Properties

credentials

credentials: MemoizedProvider<AwsCredentialIdentity>

Resolved value for input config AwsAuthInputConfig.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 @aws-sdk/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

disableHostPrefix: boolean

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

Optional endpoint

endpoint?: Object

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.

endpointCache

endpointCache: EndpointCache

LRU Cache which stores endpoints from endpoint discovery operations. The size is either provided by EndpointDiscoveryInputConfig.endpointCacheSize.

endpointDiscoveryEnabled

endpointDiscoveryEnabled: Provider<undefined | boolean>

Resolved value for input config EndpointDiscoveryInputConfig.endpointDiscoveryEnabled.

endpointProvider

endpointProvider: ((params: EndpointParameters, context?: {
    logger?: Logger;
}) => EndpointV2)

Type declaration

    • (params: EndpointParameters, context?: {
          logger?: Logger;
      }): EndpointV2

    • Parameters

      • params: EndpointParameters
      • Optional context: {
            logger?: Logger;
        }
        • Optional logger?: Logger

      Returns EndpointV2

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: Object

The AWS region to which this client will send requests

requestHandler

requestHandler: RequestHandler<any, any, HttpHandlerOptions> & HttpHandler & RequestHandler<any, any, {}>

The HTTP handler to use. Fetch in browser and Https in Nodejs.

retryMode

retryMode: string | Provider<string>

Specifies which retry algorithm to use.

retryStrategy

retryStrategy: Provider<RetryStrategy | RetryStrategyV2>

Resolved value for input config RetryInputConfig.retryStrategy

signer

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

Type declaration

    • (authScheme?: AuthScheme): Promise<RequestSigner>

    • Resolved value for input config AwsAuthInputConfig.signer

      Parameters

      • Optional authScheme: AuthScheme

      Returns Promise<RequestSigner>

signingEscapePath

signingEscapePath: boolean

Resolved value for input config AwsAuthInputConfig.signingEscapePath

systemClockOffset

systemClockOffset: number

Resolved value for input config AwsAuthInputConfig.systemClockOffset

tls

tls: boolean

Whether TLS is enabled for requests.

Deprecated

useDualstackEndpoint

useDualstackEndpoint: Object

Enables IPv6/IPv4 dualstack endpoint.

useFipsEndpoint

useFipsEndpoint: Object

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme