software.amazon.awssdk.transfer.s3

Interface S3ClientConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<S3ClientConfiguration.Builder,S3ClientConfiguration>, SdkBuilder<S3ClientConfiguration.Builder,S3ClientConfiguration>

Enclosing class:

S3ClientConfiguration

public static interface S3ClientConfiguration.Builder
extends CopyableBuilder<S3ClientConfiguration.Builder,S3ClientConfiguration>

The builder definition for a S3ClientConfiguration.

Method Summary

Modifier and Type	Method and Description
S3ClientConfiguration.Builder	asyncConfiguration(ClientAsyncConfiguration asyncConfiguration) Specify overrides to the default SDK async configuration that should be used for clients created by this builder.
default S3ClientConfiguration.Builder	asyncConfiguration(Consumer<ClientAsyncConfiguration.Builder> configuration) Similar to asyncConfiguration(ClientAsyncConfiguration), but takes a lambda to configure a new ClientAsyncConfiguration.Builder.
S3ClientConfiguration.Builder	credentialsProvider(AwsCredentialsProvider credentialsProvider) Configure the credentials that should be used to authenticate with S3.
S3ClientConfiguration.Builder	maxConcurrency(Integer maxConcurrency) Specifies the maximum number of S3 connections that should be established during a transfer.
S3ClientConfiguration.Builder	minimumPartSizeInBytes(Long partSizeBytes) Sets the minimum part size for transfer parts.
S3ClientConfiguration.Builder	region(Region region) Configure the region with which the SDK should communicate.
S3ClientConfiguration.Builder	targetThroughputInGbps(Double targetThroughputInGbps) The target throughput for transfer requests.

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

copy

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

applyMutation, build

Method Detail

credentialsProvider

S3ClientConfiguration.Builder credentialsProvider(AwsCredentialsProvider credentialsProvider)

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

The default provider will attempt to identify the credentials automatically using the following checks:

1. Java System Properties - aws.accessKeyId and aws.secretKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
4. Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.
5. Instance profile credentials delivered through the Amazon EC2 metadata service

If the credentials are not found in any of the locations above, an exception will be thrown at SdkBuilder.build() time.

Parameters:

credentialsProvider - the credentials to use

Returns:

This builder for method chaining.

region

S3ClientConfiguration.Builder region(Region region)

Configure the region with which the SDK should communicate.

If this is not specified, the SDK will attempt to identify the endpoint automatically using the following logic:

1. Check the 'aws.region' system property for the region.
2. Check the 'AWS_REGION' environment variable for the region.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the region.
4. If running in EC2, check the EC2 metadata service for the region.

Parameters:

region - the region to be used

Returns:

this builder for method chaining.

minimumPartSizeInBytes

S3ClientConfiguration.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.

By default, it is 8MB

Parameters:

partSizeBytes - The minimum part size for transfer parts.

Returns:

this builder for method chaining.

targetThroughputInGbps

S3ClientConfiguration.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(java.lang.Integer).

By default, it is 5Gbps

Parameters:

targetThroughputInGbps - the target throughput in Gbps

Returns:

this builder for method chaining.

See Also:

maxConcurrency(Integer)

maxConcurrency

S3ClientConfiguration.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(java.lang.Double). 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)

asyncConfiguration

S3ClientConfiguration.Builder asyncConfiguration(ClientAsyncConfiguration asyncConfiguration)

Specify overrides to the default SDK async configuration that should be used for clients created by this builder.

Parameters:

asyncConfiguration - the async configuration

Returns:

this builder for method chaining.

See Also:

asyncConfiguration(Consumer)

asyncConfiguration

default S3ClientConfiguration.Builder asyncConfiguration(Consumer<ClientAsyncConfiguration.Builder> configuration)

Similar to asyncConfiguration(ClientAsyncConfiguration), but takes a lambda to configure a new ClientAsyncConfiguration.Builder. This removes the need to call ClientAsyncConfiguration.builder() and ClientAsyncConfiguration.Builder#build().

Parameters:

configuration - the async configuration

Returns:

this builder for method chaining.

See Also:

asyncConfiguration(ClientAsyncConfiguration)