docs(middleware-bucket-endpoint): clarification for bucketEndpoint co…

…nfig (#3273) Co-authored-by: Trivikram Kamat <[email protected]>
aws · Feb 2, 2022 · 1bb7700 · 1bb7700
1 parent 6a23634
commit 1bb7700
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -146,7 +146,9 @@ might not have the same name either.
     more [in v3 reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_types.retrystrategy-1.html)
 - [`s3BucketEndpoint`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#s3BucketEndpoint-property)
   - **v2**: Whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint).
-  - **v3**: Renamed to `bucketEndpoint`
+  - **v3**: Changed to `bucketEndpoint`. See more in [v3 reference for bucketEndpoint](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html#bucketendpoint).
+    Note that when set to `true`, you specify the request endpoint in the `Bucket` request parameter, the original endpoint
+    will be overwritten. Whereas in v2, the request endpoint in client constructor overwrites the `Bucket` request parameter.
 - [`s3DisableBodySigning`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#s3DisableBodySigning-property)
   - **v2**: Whether to disable S3 body signing when using signature version v4.
   - **v3**: Renamed to `applyChecksum`

diff --git a/packages/middleware-bucket-endpoint/src/configurations.ts b/packages/middleware-bucket-endpoint/src/configurations.ts
@@ -2,7 +2,16 @@ import { Provider, RegionInfoProvider } from "@aws-sdk/types";
 
 export interface BucketEndpointInputConfig {
   /**
-   * Whether the provided endpoint addresses an individual bucket.
+   * Whether to use the bucket name as the endpoint for this request. The bucket
+   * name must be a domain name with a CNAME record alias to an appropriate virtual
+   * hosted-style S3 hostname, e.g. a bucket of `images.johnsmith.net` and a DNS
+   * record of:
+   *
+   * ```
+   * images.johnsmith.net CNAME 			images.johnsmith.net.s3.amazonaws.com.
+   * ```
+   *
+   * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#VirtualHostingCustomURLs
    */
   bucketEndpoint?: boolean;
   /**