AWS Elastic Beanstalk
開発者ガイド

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

AWS Elastic Beanstalk 環境にタグを適用できます。タグは、AWS リソースに関連付けられるキーと値です。Elastic Beanstalk リソースのタグ付け、ユースケース、タグのキーと値の制約、サポートされているリソースタイプの詳細については、「AWS Elastic Beanstalk のアプリケーションリソースへのタグ付け」を参照してください。

また、タグを使用して、環境内の特定のリソースレベルでアクセス権限を管理することもできます。詳細については、Linux インスタンス用 Amazon EC2 ユーザーガイドの「Amazon EC2 リソースにタグを付ける」を参照してください。

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

  • elasticbeanstalk:environment-name – 環境の名前。

  • elasticbeanstalk:environment-id – 環境 ID。

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

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

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

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

Elastic Beanstalk コンソールを使用して環境を作成する際に、次に示すように [新しい環境の作成] ウィザードの [タグ] ページでタグのキーと値を指定できます。


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

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 によって環境に適用されるデフォルトのタグを編集することはできません。

Elastic Beanstalk コンソールで環境のタグを管理するには

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

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

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

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

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

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

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

  4. [適用] を選択します。

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"

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

注記

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

$ aws elasticbeanstalk describe-environments