eb config - AWS Elastic Beanstalk

eb config

Description

環境に適用中の設定保存されている環境設定を管理します。このコマンドを使用して、保存されている環境設定をアップロード、ダウンロード、または一覧表示できます。また、適用中の設定のダウンロード、表示、または更新にも使用できます。

root ディレクトリにカスタムプラットフォームを指定する platform.yaml ファイルが含まれている場合、このコマンドは ビルダー設定も変更します。これは、platform.yaml で設定された値に基づいて行われます。

注記

eb config は、環境プロパティを表示しません。アプリケーションで読み取り可能な環境プロパティを設定するには、代わりに eb setenv を使用します。

構文

eb config コマンドが環境に適用中の設定を操作するために使用する構文の一部を次に示します。例については、このトピックで後述する「」セクションを参照してください。

  • eb config – EDITOR 環境変数として設定したテキストエディタで、環境に適用中の設定を表示します。変更をファイルに保存してエディタを閉じると、ファイルに保存したオプション設定によって環境が更新されます。

    注記

    EDITOR 環境変数を設定しなかった場合、EB CLI は YAML ファイルのデフォルトエディタにオプション設定を表示します。

  • eb config environment-name – 名前付き環境の設定を表示および更新します。設定は、設定したテキストエディタまたはデフォルトのエディタの YAML ファイルに表示されます。

  • eb config save – 現在の環境に適用中の設定を [configuration-name].cfg.yml というファイル名で .elasticbeanstalk/saved_configs/ に保存します。デフォルトでは、EB CLI は設定を環境名に基いて configuration-name という名前で保存します。コマンドの実行時に --cfg オプションと必要な設定名を含めることで、別の設定名を指定できます。

    --tags オプションを使用して保存された設定にタグを付けることができます。

  • eb config --display – 環境に適用中の設定をファイルではなく stdout に書き込みます。デフォルトでは、これによって端末に設定が表示されます。

  • eb config --update configuration_string | file_path – 現在の環境に適用されている設定を、configuration_string または file_path で識別されるファイル内で指定された情報で更新します。

注記

--display オプションおよび --update オプションは、環境の設定をプログラム的に読み込んだり改訂したりする柔軟性を備えています。

eb config コマンドを使用して保存した設定を操作するための構文について次に説明します。例については、このトピックで後述する「」セクションを参照してください。

  • eb config get config-name – Amazon S3 から名前付きで保存された設定をダウンロードします。

  • eb config delete config-name – Amazon S3 から名前付きで保存された設定を削除します。また、すでにダウンロードしている場合は、ローカルで削除します。

  • eb config list – Amazon S3 内に保存した設定を一覧表示します。

  • eb config put filename – Amazon S3 バケットに名前を付けて保存した設定をアップロードします。filename にはファイル拡張子 .cfg.yml が必要です。パスを指定せずにファイル名を指定するには、.elasticbeanstalk フォルダまたは .elasticbeanstalk/saved_configs/ フォルダにファイルを保存してからコマンドを実行します。また、「filename」にフルパスを指定できます。

オプション

名前

説明

--cfg config-name

保存した設定に使用する名前。

このオプションは、eb config save でのみ使用できます。

-d

または

--display

現在の環境の設定を表示します (stdout への書き込み)。

--format オプションを使用して、出力が JSON か YAML かを指定します。指定しない場合、出力は YAML 形式になります。

このオプションは、他のサブコマンドなしで eb config コマンドを使用する場合にのみ機能します。

-f format_type

または

--format format_type

表示形式を指定します。有効な値は JSON または YAML です。

デフォルトは YAML です。

このオプションは、--display オプションでのみ機能します。

--tags key1=value1[,key2=value2 ...]

保存された設定に追加するタグ。リストでタグを指定するときは、「キー=値」のペアとして指定し、それぞれをカンマで区切ります。

詳細については、「保存された設定にタグ付けする」を参照してください。

このオプションは、eb config save でのみ使用できます。

--timeout timeout

コマンドがタイムアウトするまでの時間(分)。

-u configuration_string | file_path

または

--update configuration_string | file_path

現在の環境に適用中の設定を更新します。

このオプションは、他のサブコマンドなしで eb config コマンドを使用する場合にのみ機能します。

configuration_string | file_path パラメータは文字列型です。文字列で、環境の設定に対して追加、更新、または削除する名前空間と対応するオプションのリストを指定します。または、入力文字列で、これと同じ情報を含むファイルを表すこともできます。

ファイル名を指定するには、入力文字列が "file://<path><filename>" の形式になっている必要があります。path なしでファイル名を指定するには、コマンドを実行するフォルダにファイルを保存します。また、フルパスでファイル名を指定することもできます。

設定情報は、次の条件を満たす必要があります。少なくとも 、OptionSettings または OptionsToRemove のどちらか 1 つのセクションが必要です。OptionSettings を使用して、オプションを追加または変更します。OptionsToRemove を使用して、名前空間からオプションを削除します。例については、このトピックで後述する「」セクションを参照してください。

YAML 形式

OptionSettings: namespace1: option-name-1: option-value-1 option-name-2: option-value-2 ... OptionsToRemove: namespace1: option-name-1 option-name-2 ...

JSON 形式

{ "OptionSettings": { "namespace1": { "option-name-1": "option-value-1", "option-name-2": "option-value-2", ... } }, "OptionsToRemove": { "namespace1": { "option-name-1", "option-name-2", ... } } }

一般的なオプション

出力

サブコマンドやオプションを追加していない状態で eb config または eb config environment-name コマンドが正常に実行されると、EDITOR 環境変数として設定したテキストエディタに現在のオプション設定が表示されます。EDITOR 環境変数を設定しなかった場合、EB CLI は YAML ファイルのデフォルトエディタにオプション設定を表示します。

変更をファイルに保存してエディタを閉じると、ファイルに保存したオプション設定によって環境が更新されます。次の出力は、設定の更新を確認するために表示されます。

$ eb config myApp-dev Printing Status: 2021-05-19 18:09:45 INFO Environment update is starting. 2021-05-19 18:09:55 INFO Updating environment myApp-dev's configuration settings. 2021-05-19 18:11:20 INFO Successfully deployed new configuration to environment.

--display オプションを指定してコマンドが正常に実行されると、現在の環境の設定が表示されます (stdout への書き込み)。

get パラメータを指定したコマンドの実行に成功すると、コマンドはダウンロードしたローカルコピーの場所を表示します。

save パラメータを指定したコマンドの実行に成功すると、コマンドは保存したファイルの場所を表示します。

このセクションでは、オプション設定ファイルの表示や編集に使用するテキストエディタを変更する方法を説明します。

Linux および UNIX の場合、次の例では、エディタが vim に変更されます。

$ export EDITOR=vim

Linux および UNIX の場合、次の例では、エディタが /usr/bin/kate にインストールされているエディタに変更されます。

$ export EDITOR=/usr/bin/kate

次の例では、エディタが Notepad++ に変更されます(Windows の場合)。

> set EDITOR="C:\Program Files\Notepad++\Notepad++.exe

このセクションでは、サブコマンドとともに eb config コマンドを実行する場合の例を示します。

以下の例は app-tmp という名前の保存された設定を削除します。

$ eb config delete app-tmp

以下の例は Amazon S3 バケットから app-tmp という名前の保存済み設定をダウンロードします。

$ eb config get app-tmp

以下の例は Amazon S3 バケットに保存されている保存済み設定の名前を一覧表示します。

$ eb config list

以下の例は Amazon S3 バケットに app-tmp という名前の保存済み設定のローカルコピーをアップロードします。

$ eb config put app-tmp

以下の例は現在実行中の環境から設定を保存します。保存した設定に使用する名前を指定しない場合、Elastic Beanstalk は環境名に従って設定ファイルに名前を付けます。例えば、tmp-dev という名前の環境は tmp-dev.cfg.yml と呼ばれます。Elastic Beanstalk はファイルをフォルダ /.elasticbeanstalk/saved_configs/ に保存します。

$ eb config save

以下の例では、--cfg オプションを使用して環境 tmp-dev から v1-app-tmp.cfg.yml というファイルに設定を保存しています。Elastic Beanstalk はファイルをフォルダ /.elasticbeanstalk/saved_configs/ に保存します。環境名を指定しない場合、Elastic Beanstalk は現在実行中の環境から設定を保存します。

$ eb config save tmp-dev --cfg v1-app-tmp

このセクションでは、サブコマンドを使用せずに eb config コマンドを実行する場合の例を示します。

次のコマンドは、現在の環境のオプション設定をテキストエディタに表示します。

$ eb config

次のコマンドは、my-env 環境のオプション設定をテキストエディタに表示します。

$ eb config my-env

次の例では、現在の環境のオプション設定を表示します。--format オプションに特定の形式が指定されていないため、YAML 形式で出力されます。

$ eb config --display

次の例では、現在の環境のオプション設定を、example.txt という名前のファイルに指定されているように更新します。ファイルは YAML 形式または JSON 形式のいずれかです。EB CLI はファイル形式を自動的に検出します。

  • 名前空間 aws:autoscaling:asg の Minsize オプションは 1 に設定されます。

  • 名前空間 aws:elasticbeanstalk:command のバッチサイズは 30% に設定されます。

  • これにより、名前空間 AWSEBV2LoadBalancer.aws:elbv2:loadbalancer から IdleTimeout: None のオプション設定が削除されます。

$ eb config --update "file://example.txt"

例 - ファイル名: example.txt - YAML 形式

OptionSettings: 'aws:elasticbeanstalk:command': BatchSize: '30' BatchSizeType: Percentage 'aws:autoscaling:asg': MinSize: '1' OptionsToRemove: 'AWSEBV2LoadBalancer.aws:elbv2:loadbalancer': IdleTimeout

例 - ファイル名: example.txt - JSON 形式

{ "OptionSettings": { "aws:elasticbeanstalk:command": { "BatchSize": "30", "BatchSizeType": "Percentage" }, "aws:autoscaling:asg": { "MinSize": "1" } }, "OptionsToRemove": { "AWSEBV2LoadBalancer.aws:elbv2:loadbalancer": { "IdleTimeout" } } }

次の例では、現在の環境のオプション設定を更新します。このコマンドは、aws:autoscaling:asg 名前空間の Minsize オプションを 1 に設定します。

注記

これらの例は、Windows PowerShell に固有のものです。二重引用符 (") 文字の前にスラッシュ (\) 文字を付けてエスケープし、二重引用符という文字そのものであることを示します。オペレーティングシステムやコマンドライン環境が異なると、エスケープシーケンスが異なる場合があります。このため、前の例に示した file オプションを使用することをお勧めします。ファイルに設定オプションを指定する場合は、エスケープ文字を必要とせず、異なるオペレーティングシステム間で一貫性があります。

次の例は JSON 形式です。EB CLI は、形式が JSON または YAML のどちらであるかを検出します。

PS C:\Users\myUser\EB_apps\myApp-env>eb config --update '{\"OptionSettings\":{\"aws:autoscaling:asg\":{\"MaxSize\":\"1\"}}}'

次の例は YAML 形式です。コマンドに YAML ファイルで必要なスペースと行末のリターンが含まれ、YAML 文字列が正しい形式で入力されています。

  • 各行は「Enter」または「Return」キーで終わります。

  • 2 行目を 2 つのスペースで開始し、3 行目を 4 つのスペースで開始します。

PS C:\Users\myUser\EB_apps\myApp-env>eb config --update 'OptionSettings: >> aws:autoscaling:asg: >> MinSize: \"1\"'