eb tags

説明

Elastic Beanstalk リソースのタグを追加、削除、更新、および一覧表示します。

Elastic Beanstalk でのリソースのタグ付けの詳細については「Elastic Beanstalk のアプリケーションリソースへのタグ付け」を参照してください。

構文

eb tags [environment-name] [--resource ARN] -l | --list

eb tags [environment-name] [--resource ARN] -a | --add key1=value1[,key2=value2 ...]

eb tags [environment-name] [--resource ARN] -u | --update key1=value1[,key2=value2 ...]

eb tags [environment-name] [--resource ARN] -d | --delete key1[,key2 ...]

--add、--update、--delete のサブコマンドオプションは、1 つのコマンドで組み合わせることができます。少なくとも 1 つのサブコマンドオプションが必要です。これらの 3 つのサブコマンドオプションを --list で組み合わせることはできません。

追加の引数を指定しない場合、これらすべてのコマンドは、現在のディレクトリのアプリケーションでデフォルト環境のタグを一覧表示または変更します。environment-name 引数を使用すると、コマンドはその環境のタグを一覧表示または変更します。--resource オプションを使用すると、コマンドは任意の Elastic Beanstalk リソース (アプリケーション、環境、アプリケーションバージョン、保存された設定、またはカスタムプラットフォームバージョン) のタグを一覧表示または変更します。リソースを Amazon リソースネーム (ARN) で指定します。

オプション

これらのオプションはいずれも必須ではありません。オプションを使用せずに eb create を実行すると、各設定の値を入力または選択するよう求められます。

名前	説明
-l または --list	リソースに現在適用されているすべてのタグを一覧表示します。
-a key1=value1[,key2=value2 ...] または --add key1=value1[,key2=value2 ...]	リソースに新しいタグを適用します。key=value ペアのカンマ区切りリストとしてタグを指定します。既存のタグのキーを指定することはできません。 有効な値については、「リソースのタグ付け」を参照してください。
-u key1=value1[,key2=value2 ...] または --update key1=value1[,key2=value2 ...]	既存のリソースタグの値を更新します。key=value ペアのカンマ区切りリストとしてタグを指定します。既存のタグのキーを指定する必要があります。 有効な値については、「リソースのタグ付け」を参照してください。
-d key1[,key2 ...] または --delete key1[,key2 ...]	既存のリソースタグを削除します。キーのカンマ区切りリストとしてタグを指定します。既存のタグのキーを指定する必要があります。 有効な値については、「リソースのタグ付け」を参照してください。
-r region または --region region	リソースが存在する AWS リージョン。 デフォルト: 設定されたデフォルトリージョン。 このオプションに指定できる値のリストについては、AWS General Reference の「AWS Elastic Beanstalk エンドポイントとクォータ」を参照してください。
--resource ARN	コマンドでタグを変更または一覧表示するリソースの ARN。指定しない場合、コマンドは現在のディレクトリのアプリケーションにおける (デフォルトまたは指定された) 環境を参照します。 有効な値については、該当するリソース別の リソースのタグ付け のサブトピックを参照してください。これらのトピックでは、リソースの ARN の構築方法を示し、該当するリソースの ARN のリストをアプリケーションまたはアカウントで取得する方法について説明しています。

出力

--list サブコマンドオプションは、リソースのタグを一覧表示します。出力には、Elastic Beanstalk でデフォルトで適用するタグとカスタムタグの両方が表示されます。

$ eb tags --list
Showing tags for environment 'MyApp-env':

Key                                 Value

Name                                MyApp-env
elasticbeanstalk:environment-id     e-63cmxwjaut
elasticbeanstalk:environment-name   MyApp-env
mytag                               tagvalue
tag2                                2nd value

成功した場合、--add、--update、--delete のサブコマンドオプションには出力されません。コマンドのアクティビティの詳細な出力を表示するには、--verbose オプションを追加します。

$ eb tags --verbose --update "mytag=tag value"
Updated Tags:

Key                                 Value

mytag                               tag value

例

次のコマンドは、キー tag1 と値 value1 を使用するタグをアプリケーションのデフォルト環境に正常に追加し、同時にタグ tag2 を削除します。

$ eb tags --add tag1=value1 --delete tag2

次のコマンドは、アプリケーション内の保存された設定にタグを正常に追加します。

$ eb tags --add tag1=value1 \
      --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:configurationtemplate/my-app/my-template"

次のコマンドは、存在しないタグを更新しようとしているため失敗します。

$ eb tags --update tag3=newval
ERROR: Tags with the following keys can't be updated because they don't exist:

  tag3

次のコマンドは、同じキーを更新しようとしているため失敗します。

$ eb tags --update mytag=newval --delete mytag
ERROR: A tag with the key 'mytag' is specified for both '--delete' and '--update'. Each tag can be either deleted or updated in a single operation.