software.amazon.awssdk.transfer.s3.internal

Class S3CrtAsyncHttpClient.Builder

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.S3CrtAsyncHttpClient.Builder

All Implemented Interfaces:

SdkAsyncHttpClient.Builder<S3CrtAsyncHttpClient.Builder>, Buildable, SdkBuilder<S3CrtAsyncHttpClient.Builder,SdkAsyncHttpClient>

Enclosing class:

S3CrtAsyncHttpClient

public static final class S3CrtAsyncHttpClient.Builder
extends Object
implements SdkAsyncHttpClient.Builder<S3CrtAsyncHttpClient.Builder>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SdkAsyncHttpClient	build()
SdkAsyncHttpClient	buildWithDefaults(AttributeMap serviceDefaults)
S3CrtAsyncHttpClient.Builder	credentialsProvider(AwsCredentialsProvider credentialsProvider) Configure the credentials that should be used to authenticate with S3.
S3CrtAsyncHttpClient.Builder	maxConcurrency(Integer maxConcurrency) Specifies the maximum number of S3 connections that should be established during a transfer.
S3CrtAsyncHttpClient.Builder	minimumPartSizeInBytes(Long partSizeBytes) Sets the minimum part size for transfer parts.
S3CrtAsyncHttpClient.Builder	region(Region region) Configure the region with which the SDK should communicate.
S3CrtAsyncHttpClient.Builder	targetThroughputInGbps(Double targetThroughputInGbps) The target throughput for transfer requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Constructor Detail

Builder

public Builder()

Method Detail

credentialsProvider

public S3CrtAsyncHttpClient.Builder credentialsProvider(AwsCredentialsProvider credentialsProvider)

Configure the credentials that should be used to authenticate with S3.

region

public S3CrtAsyncHttpClient.Builder region(Region region)

Configure the region with which the SDK should communicate.

minimumPartSizeInBytes

public S3CrtAsyncHttpClient.Builder minimumPartSizeInBytes(Long partSizeBytes)

Sets the minimum part size for transfer parts. Decreasing the minimum part size causes multipart transfer to be split into a larger number of smaller parts. Setting this value too low has a negative effect on transfer speeds, causing extra latency and network communication for each part.

targetThroughputInGbps

public S3CrtAsyncHttpClient.Builder targetThroughputInGbps(Double targetThroughputInGbps)

The target throughput for transfer requests. Higher value means more S3 connections will be opened. Whether the transfer manager can achieve the configured target throughput depends on various factors such as the network bandwidth of the environment and the configured maxConcurrency.

maxConcurrency

public S3CrtAsyncHttpClient.Builder maxConcurrency(Integer maxConcurrency)

Specifies the maximum number of S3 connections that should be established during a transfer.

If not provided, the TransferManager will calculate the optional number of connections based on targetThroughputInGbps. If the value is too low, the S3TransferManager might not achieve the specified target throughput.

Parameters:

maxConcurrency - the max number of concurrent requests

Returns:

this builder for method chaining.

See Also:

targetThroughputInGbps(Double)

build

public SdkAsyncHttpClient build()

Specified by:

build in interface SdkAsyncHttpClient.Builder<S3CrtAsyncHttpClient.Builder>

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<S3CrtAsyncHttpClient.Builder,SdkAsyncHttpClient>

buildWithDefaults

public SdkAsyncHttpClient buildWithDefaults(AttributeMap serviceDefaults)

Specified by:

buildWithDefaults in interface SdkAsyncHttpClient.Builder<S3CrtAsyncHttpClient.Builder>