メニュー
AWS Elastic Beanstalk
開発者ガイド (API Version 2010-12-01)

Elastic Beanstalk 環境でのリソースのタグ付け

環境タグ付けの概要

AWS Elastic Beanstalk では、環境のリソースに適用するタグを指定することができます。タグはキーと値のペアです。タグは、コスト割り当てレポートで環境を識別するのに役立ちます。多数の環境を管理する場合に特に便利です。また、タグを使用して、リソースレベルでアクセス権限を管理することもできます。

Elastic Beanstalk はデフォルトで 3 つのタグを適用します。

  • elasticbeanstalk:environment-name は環境の名前です。elasticbeanstalk:environment-id は環境 ID です。

  • elasticbeanstalk:environment-id は環境 ID です。

  • Name は環境の名前でもあります。Name は、Amazon EC2 ダッシュボードでリソースを識別およびソートするのに使用されます。

これらのデフォルトのタグは編集できません。

タグは、Elastic Beanstalk 環境の作成時に指定できます。既存の環境では、タグの追加や削除に加え、既存タグの値の更新が可能です。デフォルトのタグに加え、最大 47 のタグを各環境に追加することができます。

制約

  • キーおよび値には、文字、数字、空白、および記号 (_) を使用できます。: / = + - @

  • キーの長さは最大 128 文字です。値の長さは最大 256 文字です。

  • キーでは、大文字と小文字が区別されます。

  • キーは aws: または elasticbeanstalk: で始めることはできません。

  • 値と環境名を同じすることはできません。

AWS リソースの使用状況を追跡するために、コスト割り当てレポートを使用できます。レポートにはタグ付きのリソースとタグが付いていないリソースが含まれていますが、タグに従ってコストを集計します。コスト配分レポートでタグがどのように使用されているかについては、『AWS 請求とコスト管理ユーザーガイド』の「コスト配分タグを使用したカスタム請求レポート」を参照してください。

環境作成時にタグを追加する

AWS マネジメントコンソール を使用して環境を作成する際、以下に示すように [Create New Environment] ウィザードの [Tags] ページでタグのキーと値を指定することができます。

 タグのキーと値を指定するタグページ

EB CLI を使用して環境を作成する場合は、eb create--tags オプションを使用してタグを追加します。

~/workspace/my-app$ eb create --tags mytag1=value1,mytag2=value2

AWS CLI やその他の API ベースのクライアントでは、create-environment コマンドで --tags パラメータを使用します。

$ aws elasticbeanstalk create-environment --tags Key=mytag1,Value=value1 Key=mytag2,Value=value2 --application-name my-app --environment-name my-env --cname-prefix my-app --version-label v1 --template-name my-saved-config

保存済み設定にはユーザー定義タグが含まれます。環境の作成時にタグが含まれる情報を適用すると、新しいタグを指定しない限り、これらのタグが新しい環境に適用されます。前述の方法の 1 つを使用して環境にタグを追加した場合、保存済み設定に定義されているタグはすべて破棄されます。

既存環境のタグの管理

既存の Elastic Beanstalk 環境にあるタグを追加、更新、および削除することができます。これらの変更は、Elastic Beanstalk 環境のリソースに適用されます。

Elastic Beanstalk によって環境に適用されるデフォルトのタグを編集することはできません。これらのデフォルトタグの詳細については、「環境タグ付けの概要」を参照してください。

AWS マネジメントコンソール で環境のタグを管理するには

  1. 環境に対応する環境マネジメントコンソールに移動します。

  2. サイドナビゲーションペインで、[ Tags] を選択します。

    タグの管理ページに、現在環境に存在するタグのリストが表示されます。

     環境のタグを示すタグの管理ページ
  3. タグを追加、更新、または削除します。

    • タグを追加するには、リスト下部にある空のボックスに入力します。

    • タグのキーまたは値を更新するには、タグ行の各ボックスを編集します。

    • タグを削除するには、タグの値ボックスの横にある  タグの削除 を選択します。

  4. [Apply] を選択します。

EB CLI を使用して環境を更新する場合は、eb tags を使用してタグを追加、更新、削除、一覧表示します。

たとえば、次のコマンドでは、デフォルト環境のタグが一覧表示されます。

~/workspace/my-app$ eb tags --list

次のコマンドでは、mytag1 タグの更新と mytag2 タグの削除が行われます。

~/workspace/my-app$ eb tags --update mytag1=newvalue --delete mytag2

オプションの完全なリストおよび詳細な例については、「eb tags」を参照してください。

AWS CLI、またはその他の API ベースのクライアントでは、list-tags-for-resource コマンドを使用して、環境のタグを一覧表示します。

$ aws elasticbeanstalk list-tags-for-resource --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:environment/my-app/my-env"

環境のタグを追加、更新、または削除するには、update-tags-for-resource コマンドを使用します。

$ aws elasticbeanstalk update-tags-for-resource --tags-to-add
      Key=mytag1,Value=newvalue --tags-to-remove mytag2 --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:environment/my-app/my-env"

注記

Elastic Beanstalk 環境でこれらの 2 つのコマンドを使用するには、環境の ARN が必要です。ARN を取得するには、次のコマンドを使用します。

aws elasticbeanstalk describe-environments

追加するタグと更新するタグを update-tags-for-resource--tags-to-add パラメータで指定します。存在しないタグが追加され、既存のタグの値が更新されます。