如何通过CDK清除API Gateway资源策略？传递undefined无效

问题分析 #

通过RestApiBaseProps.policy设置API Gateway资源策略后，传递undefined无法清除已存在的策略，部署后策略仍保留在资源策略编辑器中。这是因为多数基础设施即代码（IaC）工具在处理属性更新时，不会主动移除已设置的资源属性，除非明确指定移除操作。

可行解决方案 #

• 传递空策略文档：不要用undefined，而是传递一个空的JSON策略对象（{}），强制覆盖原有策略。示例代码：

  const restApi = new RestApi(this, 'MyApi', {
    policy: {} // 空策略对象，清除原有策略
  });
  

• 使用工具特定的移除操作：如果用AWS CDK，可通过addOverride方法直接移除policy属性。示例：

  restApi.addOverride('Properties.Policy', undefined);
  

  这种方式会直接在CloudFormation模板中移除该属性，触发API Gateway更新时清除策略。
• 手动清除（临时方案）：若代码方式不生效，可直接在API Gateway控制台的资源策略编辑器中手动删除策略内容并保存，再重新部署API。

注意事项 #

• 部署API时要确认变更已被IaC工具正确识别，生成的CloudFormation变更集里包含移除或覆盖策略的操作。
• 部分场景下，可能需要先部署一次带空策略的版本，再部署不带policy属性的版本，确保策略被彻底清除。

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