AWS CDKで一括してタグを付与する

2023年6月20日2023年11月19日

当ページのリンクには広告が含まれている場合があります。

AWS CDKを使用して、AWSサービスの構築をしています。

今回は、定義したスタックとそのスタックで作成される各サービスに一括して、タグを付与していきます。

cdk.Tagsオプションによるタグ付け

aws cdkでタグを付ける場合、それぞれのサービス定義で付与してもいいですが、スタック単位で一括してタグ作成することが可能です。

今回のプロジェクトでは、cdk appのファイル（初期でbinディレクトリ直下のファイル）を作成しています。

さらに、スタックファイルは、API GatewayとLambdaを構築するためのapiStack.tsとVPCを構築するためのvpcStack.tsの二つを作成している状態です。

スタック単位で一括して、タグ付けする場合、cdk appのファイルで、aws-cdk-libライブラリのTagsを利用して付与することができます。

cdk appの更新

binディレクトリ直下のcdk定義ファイルを更新していきます。

現状はいかのように、apiStackとvpcStackを実行している状態です。

#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';

import { ApiStack } from '../lib/ApiStack';
import { VpcStack } from '../lib/VpcStack';

async function createApp(): Promise<cdk.App> {
  const app = new cdk.App();

  const ApiStack = new ApiStack(app, `ApiStack`, )
  const VpcStack = new VpcStack(app, `VpcStack`, )
  return app
}

createApp()

タグのつけ方は二種類

タグのつけ方は、スタックを指定してタグ付けする方法とすべてのスタックに一括してつける方法があります。

cdk.Tagsの使い方は以下のようになります。

#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';

import { ApiStack } from '../lib/ApiStack';
import { VpcStack } from '../lib/VpcStack';

async function createApp(): Promise<cdk.App> {
  const app = new cdk.App();

  const ApiStack = new ApiStack(app, `ApiStack`, )
  const VpcStack = new VpcStack(app, `VpcStack`, )

  // すべてのスタックに共通タグを付与
  cdk.Tags.of(app).add("Project", "samplePloject");
	
// スタックを指定してタグを付与
  cdk.Tags.of(ApiStack).add("group", "sampleGroup")

  return app
}

createApp()

違いは、引数の指定だけです。

appを引数に入れるとすべてのスタックに共通のタグが付与され、スタックファイル名を引数にしてすると、そのスタックにのみタグが付与されます。

タグの作り方は、各プロジェクトによって異なるかと思いますが、私の場合は、プロジェクト単位で共通のタグを使用することにしていますので、主にappによる一括指定のみを利用しています。