Package software.amazon.awssdk.services.s3

Interface S3CrtAsyncClientBuilder

All Superinterfaces:
Buildable, SdkBuilder<S3CrtAsyncClientBuilder,S3AsyncClient>
All Known Implementing Classes:
DefaultS3CrtAsyncClient.DefaultS3CrtClientBuilder
public interface S3CrtAsyncClientBuilder extends SdkBuilder<S3CrtAsyncClientBuilder,S3AsyncClient>
Builder API to build instance of Common Run Time based S3AsyncClient.

  • Method Details

    • credentialsProvider

      default S3CrtAsyncClientBuilder 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 build() time.

      Parameters:
      credentialsProvider - the credentials to use
      Returns:
      This builder for method chaining.

    • credentialsProvider

      default S3CrtAsyncClientBuilder credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> 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 build() time.

      Parameters:
      credentialsProvider - the credentials to use
      Returns:
      This builder for method chaining.

    • region

      S3CrtAsyncClientBuilder 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

      S3CrtAsyncClientBuilder minimumPartSizeInBytes(Long uploadPartSize)
      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. See Amazon S3 multipart upload limits for guidance.

      Parameters:
      uploadPartSize - The minimum part size for transfer parts.
      Returns:
      this builder for method chaining.

    • maxNativeMemoryLimitInBytes

      S3CrtAsyncClientBuilder maxNativeMemoryLimitInBytes(Long maxNativeMemoryLimitInBytes)
      The amount of native memory that CRT is allowed to use when making requests to S3.

      If not provided, the CRT attempts to limit native memory usage in an optimal way, based on a number of parameters such as target throughput. Therefore, only configure the memory limit explicitly when needed.

      Supported range:

      • Min: 1 GB
      • Max: The lowest value of the supplied value and the SIZE_MAX of the system
      Parameters:
      maxNativeMemoryLimitInBytes - the native memory limit in bytes
      Returns:
      this builder for method chaining.
      See Also:

    • targetThroughputInGbps

      S3CrtAsyncClientBuilder targetThroughputInGbps(Double targetThroughputInGbps)
      The target throughput for transfer requests. Higher value means more connections will be established with S3.

      Whether the transfer manager can achieve the configured target throughput depends on various factors such as the network bandwidth of the environment, whether maxConcurrency(java.lang.Integer) is configured and amount of available memory.

      By default, it is 10 gigabits per second. If users want to transfer as fast as possible, it's recommended to set it to the maximum network bandwidth on the host that the application is running on. For EC2 instances, you can find network bandwidth for a specific instance type in Amazon EC2 instance type page. If you are running into out of file descriptors error, consider using maxConcurrency(Integer) to limit the number of connections.

      Note: This setting affects the native memory usage used by CRT; a higher throughput value will result in a larger memory usage. Typically, a range of throughput values maps to a discrete memory limit value in CRT, with a maximum upper limit.

      Parameters:
      targetThroughputInGbps - the target throughput in Gbps
      Returns:
      this builder for method chaining.
      See Also:

    • maxConcurrency

      S3CrtAsyncClientBuilder 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:

    • endpointOverride

      S3CrtAsyncClientBuilder endpointOverride(URI endpointOverride)
      Configure the endpoint override with which the SDK should communicate.
      Parameters:
      endpointOverride - the endpoint override to be used
      Returns:
      this builder for method chaining.

    • checksumValidationEnabled

      S3CrtAsyncClientBuilder checksumValidationEnabled(Boolean checksumValidationEnabled)
      Option to disable checksum validation for S3AsyncClient.getObject(GetObjectRequest, Path) and S3AsyncClient.putObject(PutObjectRequest, Path).

      Checksum validation using CRC32 is enabled by default.

    • initialReadBufferSizeInBytes

      S3CrtAsyncClientBuilder initialReadBufferSizeInBytes(Long initialReadBufferSizeInBytes)
      Configure the starting buffer size the client will use to buffer the parts downloaded from S3. Maintain a larger window to keep up a high download throughput; parts cannot download in parallel unless the window is large enough to hold multiple parts. Maintain a smaller window to limit the amount of data buffered in memory.

      By default, it is equal to the resolved part size * 10

      Parameters:
      initialReadBufferSizeInBytes - the initial read buffer size
      Returns:
      this builder for method chaining.

    • httpConfiguration

      S3CrtAsyncClientBuilder httpConfiguration(S3CrtHttpConfiguration configuration)
      Sets the HTTP configuration to use for this client.
      Parameters:
      configuration - The http proxy configuration to use
      Returns:
      The builder of the method chaining.

    • retryConfiguration

      S3CrtAsyncClientBuilder retryConfiguration(S3CrtRetryConfiguration retryConfiguration)
      Sets the Retry configuration to use for this client.
      Parameters:
      retryConfiguration - The retry configurations to be used.
      Returns:
      The builder of the method chaining.

    • httpConfiguration

      default S3CrtAsyncClientBuilder httpConfiguration(Consumer<S3CrtHttpConfiguration.Builder> configurationBuilder)
      A convenience method that creates an instance of the S3CrtHttpConfiguration builder, avoiding the need to create one manually via S3CrtHttpConfiguration.builder().
      Parameters:
      configurationBuilder - The health checks config builder to use
      Returns:
      The builder of the method chaining.
      See Also:

    • accelerate

      S3CrtAsyncClientBuilder accelerate(Boolean accelerate)
      Enables this client to use S3 Transfer Acceleration endpoints.

    • forcePathStyle

      S3CrtAsyncClientBuilder forcePathStyle(Boolean forcePathStyle)
      Forces this client to use path-style addressing for buckets.

    • retryConfiguration

      default S3CrtAsyncClientBuilder retryConfiguration(Consumer<S3CrtRetryConfiguration.Builder> retryConfigurationBuilder)
      A convenience method that creates an instance of the S3CrtRetryConfiguration builder, avoiding the need to create one manually via S3CrtRetryConfiguration.builder().
      Parameters:
      retryConfigurationBuilder - The retry config builder to use
      Returns:
      The builder of the method chaining.
      See Also:

    • crossRegionAccessEnabled

      S3CrtAsyncClientBuilder crossRegionAccessEnabled(Boolean crossRegionAccessEnabled)

      Configures whether cross-region bucket access is enabled for clients using the configuration.

      The following behavior is used when this mode is enabled:

      1. This method allows enabling or disabling cross-region bucket access for clients. When cross-region bucket access is enabled, requests that do not act on an existing bucket (e.g., createBucket API) will be routed to the region configured on the client
      2. The first time a request is made that references an existing bucket (e.g., putObject API), a request will be made to the client-configured region. If the bucket does not exist in this region, the service will include the actual region in the error responses. Subsequently, the API will be called using the correct region obtained from the error response.
      3. This location may be cached in the client for subsequent requests to the same bucket.

      Enabling this mode has several drawbacks, as it can increase latency if the bucket's location is physically far from the location of the request.Therefore, it is strongly advised, whenever possible, to know the location of your buckets and create a region-specific client to access them

      Parameters:
      crossRegionAccessEnabled - Whether cross region bucket access should be enabled.
      Returns:
      The builder object for method chaining.

    • thresholdInBytes

      S3CrtAsyncClientBuilder thresholdInBytes(Long thresholdInBytes)
      Configure the size threshold, in bytes, for when to use multipart upload. Uploads/copies over this size will automatically use a multipart upload strategy, while uploads/copies smaller than this threshold will use a single connection to upload/copy the whole object.

      Multipart uploads are easier to recover from and also potentially faster than single part uploads, especially when the upload parts can be uploaded in parallel. Because there are additional network API calls, small objects are still recommended to use a single connection for the upload. See Uploading and copying objects using multipart upload.

      By default, it is the same as minimumPartSizeInBytes(Long).

      Parameters:
      thresholdInBytes - the value of the threshold to set.
      Returns:
      an instance of this builder.

    • futureCompletionExecutor

      S3CrtAsyncClientBuilder futureCompletionExecutor(Executor futureCompletionExecutor)
      Configure the Executor that should be used to complete the CompletableFuture that is returned by the async service client. By default, this is a dedicated, per-client ThreadPoolExecutor that is managed by the SDK.

      The configured Executor will be invoked by the async HTTP client's I/O threads (e.g., EventLoops), which must be reserved for non-blocking behavior. Blocking an I/O thread can cause severe performance degradation, including across multiple clients, as clients are configured, by default, to share a single I/O thread pool (e.g., EventLoopGroup).

      You should typically only want to customize the future-completion Executor for a few possible reasons:

      1. You want more fine-grained control over the ThreadPoolExecutor used, such as configuring the pool size or sharing a single pool between multiple clients.
      2. You want to add instrumentation (i.e., metrics) around how the Executor is used.

      WARNING We strongly discourage using Runnable::run, which executes the future-completion directly from within the I/O thread because it may block the I/O thread and cause deadlock, especially if you are sending another SDK request in the CompletableFuture chain since the SDK may perform blocking calls in some cases.

      Parameters:
      futureCompletionExecutor - the executor
      Returns:
      an instance of this builder.

    • build

      S3AsyncClient build()
      Description copied from interface: SdkBuilder
      An immutable object that is created from the properties that have been set on the builder.
      Specified by:
      build in interface Buildable
      Specified by:
      build in interface SdkBuilder<S3CrtAsyncClientBuilder,S3AsyncClient>
      Returns:
      an instance of T