Builder

class Builder

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

An optional application specific identifier. When set it will be appended to the User-Agent header of every request in the form of: app/{applicationId}. When not explicitly set, the value will be loaded from the following locations:

Link copied to clipboard
open var attemptTimeout: <Error class: unknown class>?

The maximum amount of time to wait for any single attempt of a request within the retry loop. By default, the value is null indicating no timeout is enforced. Attempt timeouts may be retried if allowed by the current retry policy and retry capacity.

Link copied to clipboard
open var authSchemePreference: List<<Error class: unknown class>>?

The ordered preference of AuthScheme that this client will use.

Link copied to clipboard

Configure the provider used to resolve the authentication scheme to use for a particular operation.

Link copied to clipboard
open var authSchemes: List<<Error class: unknown class>>

Register new or override default AuthSchemes configured for this client. By default, the set of auth schemes configured comes from the service model. An auth scheme configured explicitly takes precedence over the defaults and can be used to customize identity resolution and signing for specific authentication schemes.

Link copied to clipboard
open var callTimeout: <Error class: unknown class>?

The maximum amount of time to wait for completion of a call, including any retries after the first attempt. By default, the value is null indicating no timeout is enforced. Call timeouts are not retried.

Link copied to clipboard
open var clientName: String

A reader-friendly name for the client.

Link copied to clipboard
open var credentialsProvider: <Error class: unknown class>?

The AWS credentials provider to use for authenticating requests. If not provided a aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider instance will be used. NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK client will not close it when the client is closed.

Link copied to clipboard

The endpoint provider used to determine where to make service requests. This is an advanced config option.

Link copied to clipboard
var endpointUrl: <Error class: unknown class>?

A custom endpoint to route requests to. The endpoint set here is passed to the configured endpointProvider, which may inspect and modify it as needed.

Link copied to clipboard
open var idempotencyTokenProvider: <Error class: unknown class>?

Override the default idempotency token generator. SDK clients will generate tokens for members that represent idempotent tokens when not explicitly set by the caller using this generator.

Link copied to clipboard
open var interceptors: MutableList<<Error class: unknown class>>

Add an aws.smithy.kotlin.runtime.client.Interceptor that will have access to read and modify the request and response objects as they are processed by the SDK. Interceptors added using this method are executed in the order they are configured and are always later than any added automatically by the SDK.

Link copied to clipboard
open var logMode: <Error class: unknown class>?

Configure events that will be logged. By default clients will not output raw requests or responses. Use this setting to opt-in to additional debug logging.

Link copied to clipboard
open var region: String?

The AWS region (e.g. us-west-2) to make requests to. See about AWS global infrastructure for more information. When specified, this static region configuration takes precedence over other region resolution methods.

Link copied to clipboard
open var regionProvider: <Error class: unknown class>?

An optional region provider that determines the AWS region for client operations. When specified, this provider takes precedence over the default region provider chain, unless a static region is explicitly configured.

Link copied to clipboard
open var retryPolicy: <Error class: unknown class><Any?>?

The policy to use for evaluating operation results and determining whether/how to retry.

Link copied to clipboard
open var telemetryProvider: <Error class: unknown class>?

The telemetry provider used to instrument the SDK operations with. By default, the global telemetry provider will be used.

Link copied to clipboard

` Disabled by default.

Link copied to clipboard
open var useFips: Boolean?

` Disabled by default.

Functions

Link copied to clipboard