Skip to content
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

Jump to bottom

SDKv3-09: Update naming and documentation for @aws-cdk/sdk-v2-to-v3-adapter #29843

Closed
Tracked by #29694
TheRealAmazonKendra opened this issue Apr 15, 2024 · 2 comments · Fixed by #29847
Closed
Tracked by #29694

SDKv3-09: Update naming and documentation for @aws-cdk/sdk-v2-to-v3-adapter #29843

TheRealAmazonKendra opened this issue Apr 15, 2024 · 2 comments · Fixed by #29847
Assignees
@colifran

Comments

@TheRealAmazonKendra
Copy link
Contributor

Context

The AWS SDK V2 is being deprecated. We need to remove all uses of it from the CDK.

Task Description

We need to update the name so that it doesn't imply that v2 is still usable. Documentation updates are also needed. No code changes at this time.

Acceptance Criteria

  • The name has been changed
  • The documentation makes it more clear what the tooling does and how it works
@TheRealAmazonKendra TheRealAmazonKendra changed the title SDKv3-09: Remove/Update/Deprecate @aws-cdk/sdk-v2-to-v3-adapter SDKv3-09: Update naming and documentation for @aws-cdk/sdk-v2-to-v3-adapter Apr 15, 2024
@khushail khushail mentioned this issue Apr 15, 2024
Open
@colifran colifran mentioned this issue Apr 15, 2024
Merged
1 task
@mergify mergify bot closed this as completed in #29847 Apr 17, 2024
mergify bot pushed a commit that referenced this issue Apr 17, 2024
@colifran
chore: update name of sdk-v2-to-v3-adapter and improve documentation (
39755fd 
#29847)

### Issue # (if applicable)

Closes #29843

### Reason for this change

The AWS SDK V2 is being deprecated. The `sdk-v2-to-v3-adapter` was created as a way to migrate `AwsCustomResource` to 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-adapter` was changed to `aws-custom-resource-sdk-adapter`. Any usage of `sdk-v2-to-v3-adapter` was updated to now use `aws-custom-resource-sdk-adapter`. The `README` for `aws-custom-resource-sdk-adapter` was 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
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions GitHub Actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@colifran colifran mentioned this issue Apr 18, 2024
Open
10 tasks
This was referenced Apr 22, 2024
Closed
Closed
@github-actions github-actions bot mentioned this issue May 1, 2024
Closed
@aws-cdk-automation
Copy link
Collaborator

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.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@colifran colifran

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: update name of sdk-v2-to-v3-adapter and improve documentation aws/aws-cdk
3 participants
@aws-cdk-automation @TheRealAmazonKendra @colifran