Builder
Properties
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:
The ordered preference of AuthScheme that this client will use.
Configure the provider used to resolve the authentication scheme to use for a particular operation.
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.
A reader-friendly name for the client.
The minimum content length threshold (in bytes) for which to send Expect: 100-continue
HTTP headers. PUT requests with bodies at or above this length will include this header, as will PUT requests with a null content length. Defaults to 2 megabytes.
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.
Flag to disable S3 multi-region access points.
Flag to disable S3 Express One Zone's bucket-level session authentication method.
Flag to support S3 transfer acceleration with this client.
Flag to enable aws-chunked content encoding.
The endpoint provider used to determine where to make service requests. This is an advanced config option.
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.
Credentials provider to be used for making requests to S3 Express.
Flag to use legacy path-style addressing when making requests.
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.
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.
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.
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.
Configures request checksum calculation
Configures response checksum validation
The policy to use for evaluating operation results and determining whether/how to retry.
The set of regions to use when signing a request with SigV4a. If not provided this will automatically be set by the SDK.
The telemetry provider used to instrument the SDK operations with. By default, the global telemetry provider will be used.
Flag to enforce using a bucket arn with a region matching the client config when making requests with S3 access points.
` Disabled by default.