❗Notice: (apigateway): API Gateway released new resource DomainNameV2 causing conflicts in L1 generation

[GavinZZ]

Describe the bug

As a summary, CDK aws-apigateway module had a legacy file called apigatewayv2.ts which includes CDK L1 Constructs from API Gateway V2 resource like CfnDomainNameV2. 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 as deprecated 5 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.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

The new resource should be generated correctly

Current Behavior

It won't generate because of the name conflicts. We can either

Reproduction Steps

N/A

Possible Solution

1. have a manual patch to the L1 generation script and we will name the new resource for API Gateway to be something more restricted as CfnApiGatewayDomainNameV2. This is weird and confusing name. More importantly, if API Gateway team decides to introduce more resource under API Gateway but named it V2, we will need to add more manual patches.
2. delete the legacy apigatewayv2.ts file. We've now introduced aws-apigatewayv2 module and this is where users should use the constructs from. However, this would mean that this is a breaking change to users who're still on legacy code. Good news is that the existing APIGatewayV2::DomainName resource can't deploy with at least one DomainNameConfigurations property (even though this property says not required on CFN documentation, CFN deploy will throw an error). And ApiGateway::DomainNameV2 resource doesn't have the same property so users won't be able to update to the latest CDK version and deploy unknowingly successfully. I also verified that if they update to use the same Construct from aws-apigatewayv2 module, it will generate the exact same output CFN template so it won't cause any resource replacement or downtime.

Additional Information/Context

No response

CDK CLI Version

N/A

Framework Version

No response

Node.js Version

N/A

OS

N/A

Language

TypeScript

Language Version

No response

Other information

No response

[GavinZZ]

The final solution we decided is to delete apigatewayv2.ts file.

For users who use HTTP API L1 Construct in apigatewayv2.ts (i.e. CfnApiV2), if you upgrade to the latest CDK version and start seeing compilation error like Property 'CfnDomainNameV2' does not exist..., please consider the following steps:

1. Update the import statements from import * as apigateway from 'aws-cdk-lib/aws-apigateway'; to import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';.
2. Update the deprecated construct names e.g. from CfnApiV2 to CfnApi, from CfnDomainNameV2 to CfnDomainName, etc.
3. As a verification step, please run cdk diff prior to cdk deploy to make sure that no change or only expected change would occur making sure the resource availability during and after deployment.

This solution will guarantee no resource replacement or update as the generated CloudFormation template should be exactly the same as before.

[github-actions]

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.

[github-actions]

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.