@@ -70,25 +70,30 @@ public interface S3CrtAsyncClientBuilder extends SdkBuilder<S3CrtAsyncClientBuil
70
70
S3CrtAsyncClientBuilder region (Region region );
71
71
72
72
/**
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.
76
76
*
77
77
* <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.
79
80
*
80
81
* @param uploadPartSize The minimum part size for transfer parts.
81
82
* @return this builder for method chaining.
82
83
*/
83
84
S3CrtAsyncClientBuilder minimumPartSizeInBytes (Long uploadPartSize );
84
85
85
86
/**
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.
89
88
*
90
89
* <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>.
92
97
*
93
98
* @param targetThroughputInGbps the target throughput in Gbps
94
99
* @return this builder for method chaining.
0 commit comments