(apigateway): RestApi not redeploying correctly

When I change a resource path in a RestApi the old path is not removed from the api stage. The deploy option of RestApi should update the stage when a change occur in the api.

Reproduction Steps

The initial stack:

    const api: RestApi = new RestApi(this, 'rest-api', {
        deploy: true,
        deployOptions: {
            stageName: 'test-stage'
        }
    })

    const myResource:IResource = api.root.addResource("myResource", {})

    myResource.addMethod("GET", 
        new Integration({
            type:IntegrationType.MOCK,
            integrationHttpMethod:'ANY'
        })
    )

The deployed resources: The stage:

If I change the path of the resource: const myResource:IResource = api.root.addResource("myResourceChanged", {}) and redeploy the stack

What did you expect to happen?

The expect deployed resources: The expect stage:

What actually happened?

The new deployed resources: The new stage:

If I manually redeploy the stage from the console, the /myResource is removed from the stage.

Environment

• **CDK CLI Version :1.103.0 (build bc13a66)
• Framework Version:
• **Node.js Version:v14.13.1
• **OS :Windows 10
• **Language (Version):TypeScript(3.9.7)

Other

---

This is 🐛 Bug Report

[adarsh-chauhan]

any update on this?

[nija-at]

Actually, the problem is a little more tricky than I originally thought.

In order to cause little or no disruption to running applications during stack updates, CloudFormation ensures that resources are first created and/or updated before any resources are deleted.

CDK automatically creates a default Stage and Deployment whenever a RestApi is created. To ensure that the Deployment is kept in sync with the Rest API definition, the CDK needs to trigger a re-deployment of the Deployment resource. The CDK achieves this by changing the logical id of the Deployment resource which triggers a replacement.

In effect, when a Resource is removed from a RestApi and another added, CloudFormation first creates the new Resource, then creates the new Deployment for the RestApi (that now contains both Resources), then deletes the old Deployment and finally deletes the old Resource. So finally, we end up with a Deployment resource that contains both Resources.

I can’t think of an easy way to solve this problem with just the CDK.