如何为CDK Pipelines部署的堆栈添加标签？

有两种可靠的方式可以实现这一需求：

方式一：全局标签配置（推荐） #

直接在CDK App层面设置全局标签，所有由该App部署的堆栈及其下属资源都会自动继承这些标签，无需修改Pipeline的抽象部署逻辑：

import { App, Tags } from 'aws-cdk-lib';

const app = new App();
// 添加全局标签，所有CDK管理的资源都会带上这些标签
Tags.of(app).add('Environment', 'Production');
Tags.of(app).add('Project', 'MyCDKProject');

// 后续正常定义你的Pipeline和业务堆栈
// ...

这种方式覆盖范围广，实现简单，是最常用的批量打标签方案。

方式二：自定义Pipeline部署操作 #

如果需要针对特定部署阶段单独配置标签，可以替换CDK Pipelines自动生成的CloudFormation部署操作：

1. 创建自定义的CloudFormationCreateUpdateStackAction，通过templateConfiguration指向包含标签的配置文件；
2. 在Pipeline的目标部署阶段替换原有默认操作。

示例代码：

import { pipelines, aws_codepipeline_actions as codepipeline_actions } from 'aws-cdk-lib';

const pipeline = new pipelines.CodePipeline(this, 'MyPipeline', {
  // 基础配置如源、构建阶段等
});

// 获取底层的CodePipeline实例
const underlyingPipeline = pipeline.pipeline;

// 定位到目标部署阶段并替换操作
const deployStage = underlyingPipeline.stage('YourDeployStageName');
deployStage.actions.forEach((action, index) => {
  if (action instanceof codepipeline_actions.CloudFormationCreateUpdateStackAction) {
    const customDeployAction = new codepipeline_actions.CloudFormationCreateUpdateStackAction({
      ...action.props,
      templateConfiguration: {
        bucket: action.props.templateConfiguration?.bucket,
        key: 'configs/deploy-tags.json' // 指向S3中存的标签配置文件
      }
    });
    // 替换原有操作
    deployStage.addAction(customDeployAction, { replace: index });
  }
});

对应的deploy-tags.json配置示例：

{
  "Parameters": {},
  "Tags": [
    {
      "Key": "Environment",
      "Value": "Staging"
    },
    {
      "Key": "Team",
      "Value": "DevOps"
    }
  ]
}

注意事项 #

• 全局标签不会覆盖资源单独设置的标签（资源级标签优先级更高）；
• 自定义操作方案需要确保标签配置文件已上传到指定S3桶，可以在Pipeline的源或构建阶段完成文件上传。

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