如何配置AWS CDK自动删除ApiGatewayV2 Stage的Base Path Mapping避免销毁失败

数据老陈

2026-8-17

问题：CDK销毁ApiGatewayV2 Stage时因Base Path Mapping无法自动删除失败

我使用AWS CDK创建了带有Base Path Mapping配置的AWS::ApiGatewayV2::Stage资源，执行cdk destroy命令时销毁失败，必须先手动删除该Base Path Mapping才能完成销毁。请问是否可以配置CDK让这个过程无需手动干预？

编辑补充： CloudFormation错误信息如下：

The following resource(s) failed to delete: [mystage].

Deleting stage $default failed. Please remove all base path mappings related to the stage in your domains: api-us-west-2.dev.mydomain.com (Service: AmazonApiGatewayV2; Status Code: 400; Error Code: BadRequestException; Proxy: null)

解决方案

确保Base Path Mapping由CDK管理：如果你的Base Path Mapping是通过CDK创建的（比如调用DomainName.addBasePathMapping()或直接实例化CfnBasePathMapping），CDK默认会处理资源删除顺序，先删除Base Path Mapping再删除Stage。如果该映射是手动在控制台创建的，CDK无法感知，必须手动删除或把它纳入CDK的资源栈管理。
显式设置删除依赖关系：若CDK自动生成的删除顺序不符合预期，可通过addDependency()方法强制指定依赖逻辑，确保Base Path Mapping先于Stage被删除。示例代码（TypeScript）：

import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';

// 假设已创建api、domainName、stage资源
const basePathMapping = new apigatewayv2.CfnBasePathMapping(this, 'MyBasePathMapping', {
  apiId: api.apiId,
  domainName: domainName.domainName,
  stage: stage.stageName,
});

// 让Stage依赖Base Path Mapping，调整删除顺序
stage.node.addDependency(basePathMapping);