Skip to content

Commit 4377416

Browse files
authored
docs: add delivered features in UPGRADING.md (#3685)
1 parent ca7fe74 commit 4377416

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

UPGRADING.md

+24-8
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ The goal is to help you easily find the v3 equivalents of the v2 APIs you are al
1515

1616
## Client Constructors
1717

18-
This list is indexed by [v2 config parameters](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html). For
19-
options shown as `Planned` in v3, they will be supported but no timeline can be shared at the moment. They
20-
might not have the same name either.
18+
This list is indexed by [v2 config parameters](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html).
2119

2220
- [`computeChecksums`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#computeChecksums-property)
2321
- **v2**: Whether to compute MD5 checksums for payload bodies when the service accepts it (currently supported in S3
2422
only).
25-
- **v3**: Not available. Planned.
23+
- **v3**: applicable commands of S3 (PutObject, PutBucketCors, etc.) will automatically compute the MD5 checksums for
24+
of the request payload. You can also specify a different checksum algorithm in the commands' `ChecksumAlgorithm`
25+
parameter to use a different checksum algorithm. You can find more infomation in the [S3 feature announcement](https://aws.amazon.com/blogs/aws/new-additional-checksum-algorithms-for-amazon-s3/)
2626
- [`convertResponseTypes`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#convertResponseTypes-property)
2727
- **v2**: Whether types are converted when parsing response data.
2828
- **v3**: **Deprecated**. This option is considered not type-safe because it doesn't convert the types like time stamp
@@ -40,12 +40,10 @@ might not have the same name either.
4040
See [v3 reference for AwsAuthInputConfig credentials](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_middleware_signing.awsauthinputconfig-1.html#credentials).
4141
- [`endpointCacheSize`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#endpointCacheSize-property)
4242
- **v2**: The size of the global cache storing endpoints from endpoint discovery operations.
43-
- **v3**: Not available. Planned. This option configures endpoint discovery behavior, which is not yet available in v3.
43+
- **v3**: No change.
4444
- [`endpointDiscoveryEnabled`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#endpointDiscoveryEnabled-property)
4545
- **v2**: Whether to call operations with endpoints given by service dynamically.
46-
- **v3**: Not available. Planned. This option configures endpoint discovery behavior, which is not yet available in v3.
47-
Currently `TimeStreamQuery` and `TimeStreamWrite` client cannot fetch endpoints dynamically because they rely on
48-
this behavior. [#2211](https://github.com/aws/aws-sdk-js-v3/issues/2211) is tracking this issue.
46+
- **v3**: No change.
4947
- [`hostPrefixEnabled`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#hostPrefixEnabled-property)
5048
- **v2**: Whether to marshal request parameters to the prefix of hostname.
5149
- **v3**: **Deprecated**. SDK _always_ injects the hostname prefix when necessary.
@@ -512,3 +510,21 @@ await waitUntilBucketExists({ client, maxWaitTime: 60 }, { Bucket });
512510
```
513511

514512
You can find everything of how to configure the waiters in the [blog post of waiters in v3 SDK](https://aws.amazon.com/blogs/developer/waiters-in-modular-aws-sdk-for-javascript/).
513+
514+
## CloudFront Signer
515+
516+
In v2, you can sign the request to access restricted CloudFront distributions with [`AWS.CloudFront.Signer`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFront/Signer.html).
517+
518+
In v3, you have the same utilities provided in the [`@aws-sdk/cloudfront-signer`](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_cloudfront_signer.html) package.
519+
520+
## RDS Signer
521+
522+
In v2, you can generate the auth token to an RDS database using [`AWS.RDS.Signer`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDS/Signer.html).
523+
524+
In v3, the similar utility class is available in [`@aws-sdk/rds-signer` package](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_rds_signer.html).
525+
526+
## Polly Signer
527+
528+
In v2, you can generate a signed URL to the speech synthesized by AWS Polly service with [`AWS.Polly.Presigner` class](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Polly/Presigner.html).
529+
530+
In v3, the similar utility function is available in [`@aws-sdk/polly-request-presigner` package](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_polly_request_presigner.html)

0 commit comments

Comments
 (0)