@certenza/aws-cdk-infrastructure-commons 2.0.1 → 2.0.2

package/dist/src/apigateway.js

@@ -94,20 +94,23 @@ const createApiGateway = (scope, apiName, domainName, hostedZoneId, zoneName) =>
         removalPolicy: cdk.RemovalPolicy.DESTROY, // Destroy log group when API is deleted
     });
     // Create deployment that automatically updates when API changes
-    // The Deployment construct should automatically detect when the API definition changes
-    // and create a new deployment. The dependency on api.root helps ensure this works.
-    // Note: If you add methods/resources and the stage doesn't update, the deployment
-    // might not be detecting changes. In that case, you may need to manually trigger
-    // a redeployment or use a hash-based approach.
+    // To ensure the stage updates when new methods/resources are added, we include
+    // the API root resource ID in the deployment description. This forces CloudFormation
+    // to recognize when the API changes and update both the deployment and stage.
     const deployment = new apigateway.Deployment(scope, `${apiName}-Deployment`, {
         api: api,
         retainDeployments: false,
     });
-    // Add dependency on API root to help ensure deployment updates when API changes
-    // This dependency ensures the deployment is recreated when methods/resources are added
+    // Add dependency on API root to ensure deployment updates when API changes
+    // This ensures the deployment is recreated when methods/resources are added
     deployment.node.addDependency(api.root);
+    // Ensure stage depends on deployment to update when deployment changes
+    // This forces the stage to update its deployment reference when a new deployment is created
     // Create stage with logging configuration
     // The execution log group must exist before the stage is created so API Gateway uses it
+    // IMPORTANT: The stage must reference the deployment. When a new deployment is created
+    // (when API methods/resources change), CloudFormation should update the stage automatically.
+    // However, to ensure this works, we add an explicit dependency and include deployment info.
     const stage = new apigateway.Stage(scope, `${apiName}-Stage`, {
         deployment: deployment,
         stageName: "prod",
@@ -115,6 +118,9 @@ const createApiGateway = (scope, apiName, domainName, hostedZoneId, zoneName) =>
         dataTraceEnabled: false,
         accessLogDestination: new apigateway.LogGroupLogDestination(accessLogGroup),
     });
+    // Explicitly add dependency to ensure stage updates when deployment changes
+    // This is necessary because CloudFormation might not detect the change automatically
+    stage.node.addDependency(deployment);
     // Ensure the execution log group is created before the stage
     // This is necessary because the stage doesn't reference the log group directly,
     // but API Gateway needs it to exist when the stage is created

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@certenza/aws-cdk-infrastructure-commons",
-    "version": "2.0.1",
+    "version": "2.0.2",
     "description": "Common infrastructure reusable utilities and resources for Certenza projects",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",