CloudFormation リソースへのタグ付け

CloudFormation テンプレートの Tags プロパティを使用してリソースにタグを適用できます。これにより、これらのリソースを識別して分類できます。

Tags プロパティをサポートしているリソースの詳細については、「AWS リソースおよびプロパティタイプのリファレンス」の個々のリソースを参照してください。リソースがまだ Tags プロパティをサポートしていない場合、リソースのサービスが独自の API オペレーションを使用したタグ付けをサポートしている可能性があります。詳細については、該当サービスのドキュメントをご参照ください。

ユーザーが定義する任意のタグに加えて、CloudFormation は aws: プレフィックスが付いた次のようなスタックレベルのタグを自動的に作成します。

aws:cloudformation:logical-id
aws:cloudformation:stack-id
aws:cloudformation:stack-name

aws: プレフィックスは AWS 用に限定されています。このプレフィックスでは、大文字と小文字は区別されません。Key または Value プロパティでこのプレフィックスを使用すると、タグを更新または削除することはできません。このプレフィックスを持つタグは、リソースごとのタグ数にはカウントされません。

aws: プレフィックスが付いたタグを含むスタックレベルのタグのリソースへの伝播は、リソースタイプによって異なります。例えば、タグはブロックデバイスマッピングから作成された Amazon EBS ボリュームには反映されません。

注記

一部のリソースでは、明示的なタグの伝播設定が必要です。例えば、タグを EC2 インスタンスに伝達するには、AWS::AutoScaling::AutoScalingGroup リソースの PropagateAtLaunchプロパティを true に設定する必要があります。ただし、スタックレベルのタグは、PropagateAtLaunch 設定に関係なく EC2 インスタンスに自動的に適用されます。

構文

JSON


{
  "Key" : String,
  "Value" : String
}

YAML


Key: String
Value: String

プロパティ

Key

タグのキー名。値には 1～128 文字の Unicode 文字を指定できます。ただし、aws: のプレフィックスを付けることはできません。次の文字を使用できます: 一連の Unicode 文字、数字、空白、_、.、:、/、=、+、@、-、"。

必須: はい

タイプ: 文字列

Value

タグの値。1～256 文字の値を指定できます。以下の文字を使用できます。一連の Unicode 文字、数字、空白、_、.、/、=、+、-。

必須: はい

タイプ: 文字列

例

この例は、Tags プロパティを示します。このプロパティは、このプロパティをサポートするリソースの Properties セクションに指定します。リソースが作成されると、Environment タグはパラメータを使用して動的に設定され、Owner タグは静的に MyName に設定されます。

JSON


"Tags" : [
   {
      "Key" : "Environment",
      "Value" : { "Ref": "Environment" }
   },
   {
      "Key" : "Owner",
      "Value" : "MyName"
   }
]

YAML


Tags: 
  - Key: Environment
    Value: !Ref Environment
  - Key: Owner
    Value: MyName

CloudFormation リソースへのタグ付け

注記

構文

JSON

YAML

プロパティ

例

JSON

YAML

関連情報