Skip to content

Commit 1bb7700

Browse files
docs(middleware-bucket-endpoint): clarification for bucketEndpoint config (#3273)
Co-authored-by: Trivikram Kamat <[email protected]>
1 parent 6a23634 commit 1bb7700

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

UPGRADING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,9 @@ might not have the same name either.
146146
more [in v3 reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_types.retrystrategy-1.html)
147147
- [`s3BucketEndpoint`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#s3BucketEndpoint-property)
148148
- **v2**: Whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint).
149-
- **v3**: Renamed to `bucketEndpoint`
149+
- **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).
150+
Note that when set to `true`, you specify the request endpoint in the `Bucket` request parameter, the original endpoint
151+
will be overwritten. Whereas in v2, the request endpoint in client constructor overwrites the `Bucket` request parameter.
150152
- [`s3DisableBodySigning`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#s3DisableBodySigning-property)
151153
- **v2**: Whether to disable S3 body signing when using signature version v4.
152154
- **v3**: Renamed to `applyChecksum`

packages/middleware-bucket-endpoint/src/configurations.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,16 @@ import { Provider, RegionInfoProvider } from "@aws-sdk/types";
22

33
export interface BucketEndpointInputConfig {
44
/**
5-
* Whether the provided endpoint addresses an individual bucket.
5+
* Whether to use the bucket name as the endpoint for this request. The bucket
6+
* name must be a domain name with a CNAME record alias to an appropriate virtual
7+
* hosted-style S3 hostname, e.g. a bucket of `images.johnsmith.net` and a DNS
8+
* record of:
9+
*
10+
* ```
11+
* images.johnsmith.net CNAME images.johnsmith.net.s3.amazonaws.com.
12+
* ```
13+
*
14+
* @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#VirtualHostingCustomURLs
615
*/
716
bucketEndpoint?: boolean;
817
/**

0 commit comments

Comments
 (0)