(aws-api-gateway): Re-generate API Deployment Logical ID when stack parameter is populated using Custom Resources

[Zichpie]

Describe the feature

We are using a custom resource to fetch an API Gateway integration parameter dynamically at deployment time and noticed that the API Gateway deployment logical ID does not change due to the logical ID being calculated as the hash of the cfn template. Since we are using customer resources, cdk does not detect a change during build time and hence does create a new Deployment resource with a new logical ID.

We noticed later on that we can using the addLogicalId method to force CDK to generate a new Deployment resource each time, however would it be possible to always update the Deployment logical ID if custom resource is used to to fetch any properties.

Use Case

Automatically update the API Gateway Deployment resource logical ID when there is a custom resource to fetch an API Gateway integration parameter, or other properties.

Proposed Solution

If any custom resource is detected in the RestApi or SpecRestApi cloudformation template, invoke addToLogicalId with an UUID so that a new hash would be generated.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

^2.158.0

Environment details (OS name and version, etc.)

MacOS 14.6.1 (23G93)

[pahud]

Thank you for raising this issue. While using addLogicalId() can technically force a new API Gateway deployment by causing CloudFormation to replace the resource, this approach comes with several drawbacks:

1. Resource Replacement Impact:

   • Causes temporary downtime during replacement
   • May break existing integrations
   • Requires updates to dependent resources

2. Maintenance Challenges:

   • Makes stack updates more complex
   • Can lead to orphaned resources
   • May cause unexpected behavior in dependent stacks

Instead, I recommend considering these alternative approaches:

1. Native Deployment Triggers:

// Update stage description to trigger deployment
api.deploymentStage.description = `Deployment ${Date.now()}`;

2. Update Description:

const deployment = new apigateway.Deployment(this, 'Deployment', {
  restApi: api,
  description: 'Forced deployment'
});

3. Deployment Pipeline:

1. Implement CI/CD pipeline with versioned deployments
2. Use AWS CodePipeline or similar tools
3. Maintain deployment history and rollback capability

4. Stage Variables:

// Modify stage variables to trigger deployment
api.deploymentStage.addVariable('forceDeploy', Date.now().toString());

These approaches provide more controlled and maintainable ways to manage API Gateway deployments without the risks associated with resource replacement.

[github-actions]

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.