eb config

描述

管理您環境的作用中組態設定和已儲存組態。您可以使用此命令來上傳、下載或列出您環境的已儲存組態。您也可以使用它來下載、顯示或更新其作用中的組態設定。

如果根目錄包含 platform.yaml 檔案，其中指定自訂的平台，則此命令也會變更建置器的組態設定。這是根據 platform.yaml 中設定的值完成的。

語法

以下是用於 eb config 命令與您環境的作用中組態設定搭配使用的語法部分。如需特定範例，請參閱本主題後半內容中的 範例 部分。

下文說明使用 eb config 命令來使用已儲存組態的語法。如需範例，請參閱本主題後半內容中的 範例 部分。

選項

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

{
   "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

如果使用 Windows，下列範例會將編輯器變更為 Notepad++。

> 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

下列範例將名為 app-tmp 的已儲存組態的本機副本，上傳到您的 Amazon S3 儲存貯體。

$ 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

下列範例會顯示目前環境的選項設定。它以 YAML 格式輸出，因為沒有使用 --format 選項指定特定的格式。

$ eb config --display

下列範例使用名為 example.txt 的檔案中的規格更新目前環境的選項設定。檔案採用 YAML 或 JSON 格式。EB CLI 會自動偵測檔案格式。

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

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

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

下列範例會更新目前環境的選項設定。此命令會將 aws:autoscaling:asg 命名空間的 Minsize 選項設定為 1。

下列範例採用 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 檔案中所需的間距和行尾返回。

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