Skip to content

docs(middleware-bucket-endpoint): clarification for bucketEndpoint config #3273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 2, 2022
Merged

docs(middleware-bucket-endpoint): clarification for bucketEndpoint config #3273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b3e8c5
docs(middleware-bucket-endpoint): update doc for bucketEndpoint config
AllanZhengYP Feb 1, 2022
8d5be57
docs(middleware-bucket-endpoint): clarification for bucketEndpoint co…
AllanZhengYP Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
11 changes: 10 additions & 1 deletion packages/middleware-bucket-endpoint/src/configurations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down