AWS Documentation » AWS Elastic Beanstalk » 開発者ガイド » Elastic Beanstalk コマンドラインインターフェイス（EB CLI） » EB CLI コマンドリファレンス » eb tags

eb tags

説明

Elastic Beanstalk 環境タグを追加、削除、更新、および一覧表示します。

環境のタグ付けに関する詳細については、「Elastic Beanstalk 環境でのリソースのタグ付け」を参照してください。

構文

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

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

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

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

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

環境名は 4～40 文字の長さにする必要があり、文字、数字、ハイフンのみを使用できます。環境名の先頭および末尾にはハイフンを使用できません。

オプション

これらのオプションはいずれも必須ではありません。オプションを使用せずに 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 リージョン	環境が実行されている AWS リージョン。 デフォルト: 設定されたデフォルトリージョン。 このオプションで指定できる値のリストについては、『アマゾン ウェブ サービス全般のリファレンス』の「リージョンとエンドポイント」に記載されている「AWS Elastic Beanstalk」を参照してください。

出力

--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 --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.