Skip to content

Commit dbd68c5

Browse files
authored
Add s3-transfer-manager to aws-sdk-java module (#3666)
* Add s3-transfer-manager to aws-sdk-java module * Update Javadoc
1 parent f758c1b commit dbd68c5

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS SDK for Java v2",
4+
"contributor": "",
5+
"description": "Add `s3-transfer-manager` in `aws-sdk-java` module so that it's included in `bundle`."
6+
}

aws-sdk-java/pom.xml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -728,6 +728,11 @@ Amazon AutoScaling, etc).</description>
728728
<artifactId>s3control</artifactId>
729729
<version>${awsjavasdk.version}</version>
730730
</dependency>
731+
<dependency>
732+
<groupId>software.amazon.awssdk</groupId>
733+
<artifactId>s3-transfer-manager</artifactId>
734+
<version>${awsjavasdk.version}</version>
735+
</dependency>
731736
<dependency>
732737
<groupId>software.amazon.awssdk</groupId>
733738
<artifactId>sagemaker</artifactId>

services/s3/src/main/java/software/amazon/awssdk/services/s3/S3CrtAsyncClientBuilder.java

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,25 +70,30 @@ public interface S3CrtAsyncClientBuilder extends SdkBuilder<S3CrtAsyncClientBuil
7070
S3CrtAsyncClientBuilder region(Region region);
7171

7272
/**
73-
* Sets the minimum part size for transfer parts. Decreasing the minimum part size causes
74-
* multipart transfer to be split into a larger number of smaller parts. Setting this value too low
75-
* has a negative effect on transfer speeds, causing extra latency and network communication for each part.
73+
* Sets the minimum part size for transfer parts. Decreasing the minimum part size causes multipart transfer to be split into
74+
* a larger number of smaller parts. Setting this value too low has a negative effect on transfer speeds, causing extra
75+
* latency and network communication for each part.
7676
*
7777
* <p>
78-
* By default, it is 8MB
78+
* By default, it is 8MB. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Amazon S3 multipart
79+
* upload limits</a> for guidance.
7980
*
8081
* @param uploadPartSize The minimum part size for transfer parts.
8182
* @return this builder for method chaining.
8283
*/
8384
S3CrtAsyncClientBuilder minimumPartSizeInBytes(Long uploadPartSize);
8485

8586
/**
86-
* The target throughput for transfer requests. Higher value means more S3 connections
87-
* will be opened. Whether the transfer manager can achieve the configured target throughput depends
88-
* on various factors such as the network bandwidth of the environment and the configured {@link #maxConcurrency}.
87+
* The target throughput for transfer requests. Higher value means more connections will be established with S3.
8988
*
9089
* <p>
91-
* By default, it is 10 Gbps
90+
* Whether the transfer manager can achieve the configured target throughput depends on various factors such as the network
91+
* bandwidth of the environment and the configured {@link #maxConcurrency}.
92+
*
93+
* <p>
94+
* By default, it is 10 Gbps. If users want to transfer as fast as possible, it's recommended to set it to the maximum network
95+
* bandwidth on the host that the application is running on. For EC2 instances, you can find network bandwidth for a specific
96+
* instance type in <a href="https://aws.amazon.com/ec2/instance-types/">Amazon EC2 instance type page</a>.
9297
*
9398
* @param targetThroughputInGbps the target throughput in Gbps
9499
* @return this builder for method chaining.

0 commit comments

Comments
 (0)