Update crossRegionEnabled to take Boolean instead of boolean in the C… (#4187)

* Update crossRegionEnabled to take Boolean instead of boolean in the CRT based S3 client and update javadoc for copy operation in the S3TransferManager

* Add japicmp exclusion for the change temporarily

Author: zoewangg

pom.xml

@@ -622,8 +622,7 @@
                             <!-- Service modules that are heavily customized should be included -->
                             <includeModule>s3</includeModule>
                             <includeModule>s3-control</includeModule>
-                            <!-- remove SQS temporarily TODO: re-enable -->
-                            <!-- <includeModule>sqs</includeModule>-->
+                            <includeModule>sqs</includeModule>
                             <includeModule>rds</includeModule>
                             <includeModule>apigateway</includeModule>
                             <includeModule>polly</includeModule>
@@ -632,9 +631,9 @@
                             <exclude>*.internal.*</exclude>
                             <exclude>software.amazon.awssdk.thirdparty.*</exclude>
                             <exclude>software.amazon.awssdk.regions.*</exclude>
-                            <exclude>software.amazon.awssdk.core.signer.NoOpSigner</exclude>
-                            <exclude>software.amazon.awssdk.auth.credentials.ProfileCredentialsProviderFactory</exclude>
                             <exclude>software.amazon.awssdk.utils.async.InputStreamSubscriber</exclude>
+                            <!-- exclude S3CrtAsyncClientBuilder temporarily TODO: re-enable -->
+                            <exclude>software.amazon.awssdk.services.s3.S3CrtAsyncClientBuilder</exclude>
                         </excludes>
 
                         <ignoreMissingOldVersion>true</ignoreMissingOldVersion>

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/S3TransferManager.java

@@ -611,7 +611,7 @@ default DirectoryDownload downloadDirectory(Consumer<DownloadDirectoryRequest.Bu
     }
 
     /**
-     * Creates a copy of an object that is already stored in S3 in the same region.
+     * Creates a copy of an object that is already stored in S3.
      * <p>
      * Depending on the underlying S3Client, {@link S3TransferManager} may intelligently use plain {@link CopyObjectRequest}s
      * for smaller objects, and multiple parallel {@link UploadPartCopyRequest}s for larger objects. If multipart copy is
@@ -625,10 +625,22 @@ default DirectoryDownload downloadDirectory(Consumer<DownloadDirectoryRequest.Bu
      * the way the {@link CopyObjectRequest} API behaves. When copying an object, S3 performs the byte copying on your behalf
      * while keeping the connection alive. The progress of the copy is not known until it fully completes and S3 sends a response
      * describing the outcome.
+     *
+     * <p>
+     * If you are copying an object to a bucket in a different region, you need to enable cross region access
+     * on the {@link S3AsyncClient}.
+     *
      * <p>
      * <b>Usage Example:</b>
      * {@snippet :
-     *         S3TransferManager transferManager = S3TransferManager.create();
+     *         S3AsyncClient s3AsyncClient =
+     *            S3AsyncClient.crtBuilder()
+     *                         // enable cross-region access, only required if you are making cross-region copy
+     *                         .crossRegionAccessEnabled(true)
+     *                         .build();
+     *         S3TransferManager transferManager = S3TransferManager.builder()
+     *                                                              .s3Client(s3AsyncClient)
+     *                                                              .build();
      *         CopyObjectRequest copyObjectRequest = CopyObjectRequest.builder()
      *                                                                .sourceBucket("source_bucket")
      *                                                                .sourceKey("source_key")
@@ -647,6 +659,7 @@ default DirectoryDownload downloadDirectory(Consumer<DownloadDirectoryRequest.Bu
      * @param copyRequest the copy request, containing a {@link CopyObjectRequest}
      * @return A {@link Copy} that can be used to track the ongoing transfer
      * @see #copy(Consumer)
+     * @see S3AsyncClient#copyObject(CopyObjectRequest)
      */
     default Copy copy(CopyRequest copyRequest) {
         throw new UnsupportedOperationException();

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

@@ -232,7 +232,7 @@ default S3CrtAsyncClientBuilder retryConfiguration(Consumer<S3CrtRetryConfigurat
      * @param crossRegionAccessEnabled Whether cross region bucket access should be enabled.
      * @return The builder object for method chaining.
      */
-    S3CrtAsyncClientBuilder crossRegionAccessEnabled(boolean crossRegionAccessEnabled);
+    S3CrtAsyncClientBuilder crossRegionAccessEnabled(Boolean crossRegionAccessEnabled);
 
     @Override
     S3AsyncClient build();

services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/crt/DefaultS3CrtAsyncClient.java

@@ -271,7 +271,7 @@ public S3CrtAsyncClientBuilder retryConfiguration(S3CrtRetryConfiguration retryC
         }
 
         @Override
-        public S3CrtAsyncClientBuilder crossRegionAccessEnabled(boolean crossRegionAccessEnabled) {
+        public S3CrtAsyncClientBuilder crossRegionAccessEnabled(Boolean crossRegionAccessEnabled) {
             this.crossRegionAccessEnabled = crossRegionAccessEnabled;
             return this;
         }