Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface STSClientResolvedConfig<HandlerOptions, T>

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

Type parameters

Hierarchy

Index

Properties

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

Optional endpoint

endpoint: Provider<Endpoint>

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: T, context?: undefined | { logger?: Logger }) => EndpointV2

Type declaration

maxAttempts

maxAttempts: Provider<number>

Resolved value for input config RetryInputConfig.maxAttempts

region

region: Provider<string>

Resolved value for input config RegionInputConfig.region

requestHandler

requestHandler: RequestHandler<any, any, HandlerOptions>

retryStrategy

retryStrategy: Provider<RetryStrategyV2 | RetryStrategy>

Resolved value for input config RetryInputConfig.retryStrategy

runtime

runtime: string

The runtime environment

signer

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

Resolved value for input config AwsAuthInputConfig.signer

Type declaration

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: Provider<boolean>

Resolved value for input EndpointsInputConfig.useDualstackEndpoint

useFipsEndpoint

useFipsEndpoint: Provider<boolean>

Resolved value for input RegionInputConfig.useFipsEndpoint

Optional useGlobalEndpoint

useGlobalEndpoint: boolean | Provider<boolean>