API GatewayをCloudFormationでデプロイする際にTagsを設定する方法

API GatewayをCloudFormationでデプロイする際にTagsを設定する方法

CloudFormationでTagsを設定しようとしたのですが、どうも設定が上手くいきません。ドキュメントにはTagがあるのですが。

AWS::ApiGateway::RestApi - AWS CloudFormation
Use the AWS CloudFormation AWS::ApiGateway::RestApi resource for ApiGateway.

AWS CLIでTagsを設定する

CloudFormationでデプロイした後にaws apigateway tag-resourceコマンドでTagsを設定していくことができます。

aws apigateway tag-resource helpコマンドでオプションの詳細が見れます。

--resource-arn--tagsが必須になります。

ARNのフォーマットは以下の通りです。

arn:aws:apigateway:{region}::/restapis/{rest_api_id}/stages/{stage_name}

ステージごとにTagsを設定することができます。またTagsの設定はステージエディターの右上で確認することが出来ます。

API GatewayをCloudFormationでデプロイする際にTagsを設定する方法

tag-resource — AWS CLI 1.25.53 Command Reference

--tagsオプションにkey=valueでタグを設定することができます。複数設定する場合はカンマ区切りで設定します。

key1=val1,key2=val2

以下コマンド実行例です。

aws apigateway tag-resource --resource-arn arn:aws:apigateway:ap-northeast-1::/restapis/90zh5pcwee/stages/dev --tags Stage=dev,Name=hoge

CloudFormationでTagsが設定できなくても、CLIでTagsの設定をすることが出来ます。

コメント

タイトルとURLをコピーしました