タグ付け - AWS Cloud Development Kit (AWS CDK) v2
タグの使用タグの優先順位オプションのプロパティ例単一コンストラクトのタグ付け

これは AWS CDK v2 開発者ガイドです。古い CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

タグ付け

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

  • 管理の簡素化

  • コスト配分

  • アクセスコントロール

  • お客様が考案したその他の目的

ヒント

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

タグの使用

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

  • Tags.of(SCOPE).add() は、指定されたコンストラクトとそのすべての子に新しいタグを適用します。

  • Tags.of(SCOPE).remove() は、子コンストラクト自体に適用したタグを含め、特定のコンストラクトとその子からタグを削除します。

注記

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

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

TypeScript
Tags.of(myConstruct).add('key', 'value');
JavaScript
Tags.of(myConstruct).add('key', 'value');
Python
Tags.of(my_construct).add("key", "value")
Java
Tags.of(myConstruct).add("key", "value");
C#
Tags.Of(myConstruct).Add("key", "value");

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

TypeScript
Tags.of(myConstruct).remove('key');
JavaScript
Tags.of(myConstruct).remove('key');
Python
Tags.of(my_construct).remove("key")
Java
Tags.of(myConstruct).remove("key");
C#
Tags.Of(myConstruct).Remove("key");

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

タグの優先順位

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

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

TypeScript
Tags.of(myConstruct).add('key', 'value', {
  priority: 300
});
JavaScript
Tags.of(myConstruct).add('key', 'value', {
  priority: 300
});
Python
Tags.of(my_construct).add("key", "value", priority=300)
Java
Tags.of(myConstruct).add("key", "value", TagProps.builder()
        .priority(300).build());
C#
Tags.Of(myConstruct).Add("key", "value", new TagProps { Priority = 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 です。

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

TypeScript
Tags.of(myConstruct).add('tagname', 'value', {
  applyToLaunchedInstances: false,
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 100,
});
JavaScript
Tags.of(myConstruct).add('tagname', 'value', {
  applyToLaunchedInstances: false,
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 100
});
Python
Tags.of(my_construct).add("tagname", "value",
    apply_to_launched_instances=False,
    include_resource_types=["AWS::Xxx::Yyy"],
    exclude_resource_types=["AWS::Xxx::Zzz"],
    priority=100)
Java
Tags.of(myConstruct).add("key", "value", TagProps.builder()
                .applyToLaunchedInstances(false)
                .includeResourceTypes(Arrays.asList("AWS::Xxx::Yyy"))
                .excludeResourceTypes(Arrays.asList("AWS::Xxx::Zzz"))
                .priority(100).build());
C#
Tags.Of(myConstruct).Add("tagname", "value", new TagProps
{
    ApplyToLaunchedInstances = false,
    IncludeResourceTypes = ["AWS::Xxx::Yyy"],
    ExcludeResourceTypes = ["AWS::Xxx::Zzz"],
    Priority = 100
});

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

TypeScript
Tags.of(myConstruct).remove('tagname', {
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 200,
});
JavaScript
Tags.of(myConstruct).remove('tagname', {
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 200
});
Python
Tags.of(my_construct).remove("tagname",
    include_resource_types=["AWS::Xxx::Yyy"],
    exclude_resource_types=["AWS::Xxx::Zzz"],
    priority=200,)
Java
Tags.of((myConstruct).remove("tagname", TagProps.builder()
        .includeResourceTypes(Arrays.asList("AWS::Xxx::Yyy"))
        .excludeResourceTypes(Arrays.asList("AWS::Xxx::Zzz"))
        .priority(100).build());
C#
Tags.Of(myConstruct).Remove("tagname", new TagProps
{
    IncludeResourceTypes = ["AWS::Xxx::Yyy"],
    ExcludeResourceTypes = ["AWS::Xxx::Zzz"],
    Priority = 100
});

例

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

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"]
});

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

TypeScript
Tags.of(theBestStack).add('StackType', 'TheBest',
  { includeResourceTypes: ['AWS::EC2::Subnet']});
JavaScript
Tags.of(theBestStack).add('StackType', 'TheBest',
  { includeResourceTypes: ['AWS::EC2::Subnet']});
Python
Tags.of(the_best_stack).add("StackType", "TheBest",
    include_resource_types=["AWS::EC2::Subnet"])
Java
Tags.of(theBestStack).add("StackType", "TheBest", TagProps.builder()
        .includeResourceTypes(Arrays.asList("AWS::EC2::Subnet"))
        .build());
C#
Tags.Of(theBestStack).Add("StackType", "TheBest", new TagProps {
    IncludeResourceTypes = ["AWS::EC2::Subnet"]
});

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

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

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

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

TypeScript
new cdk.Tag(key, value).visit(scope);
JavaScript
new cdk.Tag(key, value).visit(scope);
Python
cdk.Tag(key, value).visit(scope)
Java
Tag.Builder.create(key, value).build().visit(scope);
C#
new Tag(key, value).Visit(scope);

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

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

TypeScript
class PathTagger implements cdk.IAspect {
  visit(node: IConstruct) {
    new cdk.Tag("aws-cdk-path", node.node.path).visit(node);
  }
}
 
stack = new MyStack(app);
cdk.Aspects.of(stack).add(new PathTagger())
JavaScript
class PathTagger {
  visit(node) {
    new cdk.Tag("aws-cdk-path", node.node.path).visit(node);
  }
}

stack = new MyStack(app);
cdk.Aspects.of(stack).add(new PathTagger())
Python
@jsii.implements(cdk.IAspect)
class PathTagger:
    def visit(self, node: IConstruct):
        cdk.Tag("aws-cdk-path", node.node.path).visit(node)

stack = MyStack(app) 
cdk.Aspects.of(stack).add(PathTagger())
Java
final class PathTagger implements IAspect {
	public void visit(IConstruct node) {
		Tag.Builder.create("aws-cdk-path", node.getNode().getPath()).build().visit(node);
	}
}

stack stack = new MyStack(app);
Aspects.of(stack).add(new PathTagger());
C#
public class PathTagger : IAspect
{
    public void Visit(IConstruct node)
    {
        new Tag("aws-cdk-path", node.Node.Path).Visit(node);
    }
}

var stack = new MyStack(app);
Aspects.Of(stack).Add(new PathTagger);
ヒント

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