fix(apigateway): remove deprecated apigatewayv2 from aws-apigateway module#32297
fix(apigateway): remove deprecated apigatewayv2 from aws-apigateway module#32297mergify[bot] merged 5 commits intomainfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #32297 +/- ##
=======================================
Coverage 77.46% 77.46%
=======================================
Files 105 105
Lines 7168 7168
Branches 1314 1314
=======================================
Hits 5553 5553
Misses 1433 1433
Partials 182 182
Flags with carried forward coverage won't be shown. Click here to find out more.
|
aws-cdk-automation
left a comment
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
|
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 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. |
Issue # (if applicable)
Closes #32296
Reason for this change
As a summary, CDK
aws-apigatewaymodule had a legacy file calledapigatewayv2.tswhich includes CDK L1 Constructs from API Gateway V2 resource likeCfnDomainNameV2. We've already moved everything here to aws-apigatewayv2 module. However, we had to keep the legacy file for backward compatibility issue and every Constructs in the file were marked asdeprecated5 years ago.Now API Gateway team has released a new AWS resource called DomainNameV2 in API Gateway. The default CDK generated name would be CfnDomainNameV2 in aws-apigateway module but this name collides with the legacy CfnDomainNameV2 Construct from apigatewayv2.ts file (supposedly for APIGatewayV2).
This is causing the L1 generation tool to fail because the new resource by API Gateway is also caused
CfnDomainNameV2.Description of changes
Delete the deprecated
apigatewayv2.tsfile entirely.Description of how you validated changes
Existing users on upgrade won't be able to deploy their template without knowing the change because the property for the
APIGateway::DomainNameV2resource is different fromAPIGatewayV2::DomainNameresource, so the template would be non-deployable.Verified that if existing users who use
CfnDomainNameV2fromaws-apigatewaymodule and update to use the same Construct fromaws-apigatewayv2module, it will generate the exact same output CFN template so it won't cause any resource replacement or downtime.There's only 76 users who used
CfnApiV2fromaws-apigatewaymodule based on Analytics. All these users were on CDK V1 so if they choose to upgrade to latest version, they need to fix a bunch of breaking changes anyway.Checklist
BREAKING CHANGE: We will be removing deprecated
APIGatewayV2constructs fromaws-apigatewaymodule.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license