タグと AWS CDK

タグは、 AWS CDK アプリのコンストラクトに追加できる情報キーバリュー要素です。特定のコンストラクトに適用されるタグは、そのタグ付け可能なすべての子にも適用されます。タグはアプリケーションから合成された AWS CloudFormation テンプレートに含まれ、デプロイする AWS リソースに適用されます。タグを使用して、以下の目的でリソースを識別および分類できます。

管理の簡素化
コスト配分
アクセスコントロール
ユーザーが考案したその他の目的

ヒント

AWS リソースでタグを使用する方法の詳細については、AWS ホワイトペーパーの「リソースのタグ付けのベストプラクティス AWS」を参照してください。

タグの使用

Tags クラスには静的メソッドが含まれておりof()、このメソッドを使用して、指定したコンストラクトにタグを追加したり、そこからタグを削除したりできます。

Tags.of(SCOPE).add() は、指定されたコンストラクトとそのすべての子に新しいタグを適用します。
Tags.of(SCOPE).remove() は、子コンストラクトがそれ自体に適用した可能性のあるタグを含め、特定のコンストラクトとその子コンストラクトからタグを削除します。

注記

タグ付けはを使用して実装されます側面と AWS CDK。アスペクトとは、特定のスコープ内のすべてのコンストラクトにオペレーション (タグ付けなど) を適用する方法です。

次の例では、値を持つタグキーをコンストラクトに適用します。

次の例では、コンストラクトからタグキーを削除します。

Stage コンストラクトを使用している場合は、タグをStageレベル以下に適用します。タグはStage境界を越えて適用されません。

タグの優先順位

はタグを再帰的に AWS CDK 適用および削除します。競合がある場合、優先順位が最も高いタグ付けオペレーションが優先されます。（優先度はオプションの priorityプロパティを使用して設定されます。） 2 つのオペレーションの優先順位が同じ場合、コンストラクトツリーの下部に最も近いタグ付けオペレーションが優先されます。デフォルトでは、タグの適用の優先度は 100 です (優先度が 50 の AWS CloudFormation リソースに直接追加されたタグを除く）。タグを削除するデフォルトの優先度は 200 です。

次に、優先度が 300 のタグをコンストラクトに適用します。

オプションのプロパティ

タグはproperties、リソースへのタグの適用または削除方法を微調整するサポートを提供します。すべてのプロパティはオプションです。

applyToLaunchedInstances (Python: apply_to_launched_instances): add() でのみ使用できます。デフォルトでは、タグは Auto Scaling グループで起動されたインスタンスに適用されます。Auto Scaling グループで起動されたインスタンスを無視するには、このプロパティを false に設定します。
includeResourceTypes/excludeResourceTypes (Python: include_resource_types/exclude_resource_types）: これらを使用して、リソースタイプに基づいて、 AWS CloudFormation リソースのサブセットでのみタグを操作します。デフォルトでは、オペレーションはコンストラクトサブツリー内のすべてのリソースに適用されますが、これは特定のリソースタイプを含めるか除外するかによって変更できます。両方が指定されている場合、exclude は include よりも優先されます。
priority: これを使用して、他の Tags.add()およびオペレーションに関するこのTags.remove()オペレーションの優先度を設定します。値が大きいほど、小さい値よりも優先されます。デフォルトは、追加オペレーションの場合は 100 ( AWS CloudFormation リソースに直接適用されるタグの場合は 50)、削除オペレーションの場合は 200 です。

次の例では、タグ tagname に値を、優先度 100 をコンストラクトの AWS::Xxx::Yyy タイプのリソースに適用します。Amazon EC2 Auto Scaling グループで起動されたインスタンスや、タイプ AWS::Xxx::Zzz のリソースにはタグは適用されません。（これらは 2 つの任意の異なる AWS CloudFormation リソースタイプのプレースホルダーです。）

次の例では、コンストラクトの AWS::Xxx::Yyy 型のリソースから優先度 200 のタグタグタグ名を削除しますが、 AWS::Xxx::Zzz 型のリソースからは削除しません。

例

次の例では、というStack名前の内で作成されたすべてのリソースTheBestに値StackTypeを持つタグキーを追加しますMarketingSystem。その後、Amazon EC2VPCサブネットを除くすべてのリソースから再度削除されます。その結果、タグが適用されたのはサブネットのみです。

TypeScript


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

const app = new App();
const theBestStack = new Stack(app, 'MarketingSystem');

// Add a tag to all constructs in the stack
Tags.of(theBestStack).add('StackType', 'TheBest');

// Remove the tag from all resources except subnet resources
Tags.of(theBestStack).remove('StackType', {
  excludeResourceTypes: ['AWS::EC2::Subnet']
});

JavaScript


const { App, Stack, Tags } = require('aws-cdk-lib');

const app = new App();
const theBestStack = new Stack(app, 'MarketingSystem');

// Add a tag to all constructs in the stack
Tags.of(theBestStack).add('StackType', 'TheBest');

// Remove the tag from all resources except subnet resources
Tags.of(theBestStack).remove('StackType', {
  excludeResourceTypes: ['AWS::EC2::Subnet']
});

Python


from aws_cdk import App, Stack, Tags

app = App();
the_best_stack = Stack(app, 'MarketingSystem')

# Add a tag to all constructs in the stack
Tags.of(the_best_stack).add("StackType", "TheBest")

# Remove the tag from all resources except subnet resources
Tags.of(the_best_stack).remove("StackType",
    exclude_resource_types=["AWS::EC2::Subnet"])

Java


import software.amazon.awscdk.App;
import software.amazon.awscdk.Tags;

// Add a tag to all constructs in the stack
Tags.of(theBestStack).add("StackType", "TheBest");

// Remove the tag from all resources except subnet resources
Tags.of(theBestStack).remove("StackType", TagProps.builder()
        .excludeResourceTypes(Arrays.asList("AWS::EC2::Subnet"))
        .build());

C#


using Amazon.CDK;

var app = new App();
var theBestStack = new Stack(app, 'MarketingSystem');

// Add a tag to all constructs in the stack
Tags.Of(theBestStack).Add("StackType", "TheBest");

// Remove the tag from all resources except subnet resources
Tags.Of(theBestStack).Remove("StackType", new TagProps
{
    ExcludeResourceTypes = ["AWS::EC2::Subnet"]
});

Go


import "github.com/aws/aws-cdk-go/awscdk/v2"
app := awscdk.NewApp(nil)
theBestStack := awscdk.NewStack(app, jsii.String("MarketingSystem"), &awscdk.StackProps{})

// Add a tag to all constructs in the stack
awscdk.Tags_Of(theBestStack).Add(jsii.String("StackType"), jsii.String("TheBest"), &awscdk.TagProps{})

// Remove the tag from all resources except subnet resources
awscdk.Tags_Of(theBestStack).Add(jsii.String("StackType"), jsii.String("TheBest"), &awscdk.TagProps{
  ExcludeResourceTypes: &[]*string{jsii.String("AWS::EC2::Subnet")},
})

次のコードでも同じ結果が得られます。どのアプローチ (包含または除外) でインテントがより明確になるかを検討します。

単一コンストラクトのタグ付け

Tags.of(scope).add(key, value) は、のコンストラクトにタグを追加する標準的な方法です AWS CDK。そのツリーウォーキング動作は、指定されたスコープ内のすべてのタグ付け可能なリソースを再帰的にタグ付けします。ただし、特定の任意のコンストラクト (またはコンストラクト) にタグ付けする必要がある場合があります。

このようなケースの 1 つは、タグ付けされるコンストラクトのプロパティから値が導出されるタグの適用です。標準のタグ付けアプローチは、スコープ内のすべての一致するリソースに同じキーと値を再帰的に適用します。ただし、ここでは、タグ付けされたコンストラクトごとに値が異なる場合があります。

タグは側面を使用して実装され、はを使用して指定したスコープで各コンストラクトのタグの visit()メソッドをCDK呼び出しますTags.of(scope)。Tag.visit() を直接呼び出して、タグを 1 つのコンストラクトに適用できます。

スコープ内のすべてのコンストラクトにタグを付けることはできますが、タグの値は各コンストラクトのプロパティから派生させることができます。そのためには、前の例に示すように、アスペクトを記述し、アスペクトの visit()メソッドにタグを適用します。次に、を使用して目的のスコープにアスペクトを追加しますAspects.of(scope).add(aspect)。

次の例では、リソースのパスを含むスタック内の各リソースにタグを適用します。

ヒント

優先順位、リソースタイプなどの条件付きタグ付けのロジックは、 Tag クラスに組み込まれています。これらの機能は、任意のリソースにタグを適用するときに使用できます。条件が満たされない場合、タグは適用されません。また、 Tag クラスはタグ付け可能なリソースのみをタグ付けするため、タグを適用する前にコンストラクトにタグ付けできるかどうかをテストする必要はありません。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

パラメータ

アセット