chore: update name of sdk-v2-to-v3-adapter and improve documentation
#29847
Conversation
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
aws-cdk-automation
added
the
pr/needs-maintainer-review
| "name": "@aws-cdk/sdk-v2-to-v3-adapter", | ||
| "description": "Adapter to convert AWS SDK v2 to AWS CDK v3 calls", | ||
| "name": "@aws-cdk/aws-custom-resource-sdk-adapter", | ||
| "description": "Adapter to convert AWS SDK v2 to AWS CDK v3 calls for AwsCustomResource", |
There was a problem hiding this comment.
nit: can we update this description to no longer refer to this as converting v2 to v3 calls, but maybe something like Adapter to convert AWS CDK to AWS SDK compatible calls (or something more generic)?
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
aws-cdk-automation
removed
the
pr/needs-maintainer-review
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one. |
Issue # (if applicable)
Closes #29843
Reason for this change
The AWS SDK V2 is being deprecated. The
sdk-v2-to-v3-adapterwas created as a way to migrateAwsCustomResourceto use AWS SDK V3 without introducing breaking changes. The documentation for the adapter does not provide enough detail about what it is used for and what functionality it provides. Additionally, the naming of the adapter should convey that it is used to provide an abstraction over all SDK versions, not just SDK V2 to SDK V3.Description of changes
The
sdk-v2-to-v3-adapterwas changed toaws-custom-resource-sdk-adapter. Any usage ofsdk-v2-to-v3-adapterwas updated to now useaws-custom-resource-sdk-adapter. TheREADMEforaws-custom-resource-sdk-adapterwas improved to provide an overview of the tooling that exists as part of the adapter.Description of how you validated changes
No new unit tests or integ tests were needed as part of this PR. The current build is succeeding which means that the naming update has not introduced a breaking change.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license