CDK Diff始终显示API Gateway部署存在变更，如何抑制？

问题描述 #

使用Java版本CDK（2.53.0）构建API Gateway到S3的代理服务，部署堆栈后，即便代码未做任何修改，执行cdk diff始终报告存在变更，具体输出如下：

Resources
[-] AWS::ApiGateway::Deployment apiDeployment149F129425c1eab792837971bc799db7cbb35642 destroy
[+] AWS::ApiGateway::Deployment api/Deployment apiDeployment149F1294513443c293e803fe7996a9d31691b8b7
[~] AWS::ApiGateway::Stage api/DeploymentStage.prod apiDeploymentStageprod896C8101
 └─ [~] DeploymentId
     └─ [~] .Ref:
         ├─ [-] apiDeployment149F129425c1eab792837971bc799db7cbb35642
         └─ [+] apiDeployment149F1294513443c293e803fe7996a9d31691b8b7

原因分析 #

这是Java CDK默认行为导致的：当未显式创建API Gateway Deployment时，CDK会自动生成Deployment资源，且每次cdk synth都会生成新的随机逻辑ID，导致CDK误判为资源需要替换。同时默认启用的Stage自动部署会关联这个动态生成的Deployment，进一步触发变更报告。

解决方案 #

通过显式创建固定逻辑ID的Deployment并禁用Stage自动部署，即可消除误报：

1. 手动创建Deployment并指定稳定的逻辑ID，让CDK识别为同一资源
2. 创建Stage时关闭自动部署，关联显式创建的Deployment

代码修改示例 #

// 创建API Gateway实例
RestApi api = RestApi.Builder.create(this, "S3ProxyApi")
        .restApiName("S3ProxyApi")
        .build();

// 配置S3集成（原有逻辑保留）
Integration s3Integration = AwsIntegration.Builder.create()
        .service("s3")
        .path("{bucket}/{object}")
        .integrationHttpMethod("GET")
        .options(IntegrationOptions.builder()
                .credentialsRole(s3AccessRole)
                .requestParameters(Map.of(
                        "integration.request.path.bucket", "method.request.path.bucket",
                        "integration.request.path.object", "method.request.path.object"
                ))
                .build())
        .build();

// 添加API方法（原有逻辑保留）
api.getRoot().addResource("{bucket}").addResource("{object}")
        .addMethod("GET", s3Integration, MethodOptions.builder()
                .requestParameters(Map.of(
                        "method.request.path.bucket", true,
                        "method.request.path.object", true
                ))
                .build());

// 显式创建Deployment，指定固定逻辑ID
Deployment stableDeployment = Deployment.Builder.create(this, "StableApiDeployment")
        .api(api)
        .description("Fixed deployment for S3 proxy API")
        .build();

// 创建Stage，禁用自动部署并关联固定Deployment
Stage.Builder.create(this, "ProdStage")
        .stageName("prod")
        .api(api)
        .deployment(stableDeployment)
        .autoDeploy(false) // 关键：关闭自动部署，避免动态生成Deployment
        .build();

验证效果 #

修改后执行cdk synth，再运行cdk diff，将不再出现Deployment和Stage的变更误报。

内容的提问来源于stack exchange，提问作者noelob