Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open override var applicationId: String?

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

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 override var authSchemes: List<AuthScheme>

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 override var clientName: String

A reader-friendly name for the client.

Link copied to clipboard

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

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

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 override var logMode: LogMode?

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 override var region: String?

The AWS region (e.g. us-west-2) to make requests to. See about AWS global infrastructure for more information

Link copied to clipboard
open override var retryPolicy: RetryPolicy<Any?>?

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

Link copied to clipboard

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

Link copied to clipboard
open override var useDualStack: Boolean?

` Disabled by default.

Link copied to clipboard
open override var useFips: Boolean?

` Disabled by default.

Inherited properties

Link copied to clipboard
open override var httpClient: HttpClientEngine?
Link copied to clipboard
open override var retryStrategy: RetryStrategy?

Functions

Link copied to clipboard
open override fun build(): KafkaClient.Config

Inherited functions

Link copied to clipboard
open override fun httpClient(block: HttpClientEngineConfig.Builder.() -> Unit)
open override fun <B : HttpClientEngineConfig.Builder, E : HttpClientEngine> httpClient(engineFactory: EngineFactory<B, E>, block: B.() -> Unit)
Link copied to clipboard
open override fun <B : RetryStrategy.Config.Builder, R : RetryStrategy> retryStrategy(factory: DslFactory<B, R>, block: B.() -> Unit)