eb config

Beschreibung

Verwaltet die aktiven Konfigurationseinstellungen und gespeicherten Konfigurationen der Umgebung. Mit diesem Befehl können Sie die gespeicherten Konfigurationen der Umgebung hochladen, herunterladen oder auflisten. Sie können sie auch zum Herunterladen, Anzeigen oder Aktualisieren der aktiven Konfigurationseinstellungen verwenden.

Wenn das Stammverzeichnis eine platform.yaml-Datei enthält, die eine benutzerdefinierte Plattform angibt, ändert dieser Befehl auch die Builder-Konfigurationseinstellungen. Dies geschieht basierend auf den in festgelegten Werte platform.yaml.

Anmerkung

eb config zeigt keine Umgebungseigenschaften. Zum Festlegen von Umgebungseigenschaften, die Sie in Ihrer Anwendung lesen können, verwenden Sie stattdessen eb setenv.

Syntax

Im Folgenden sind Teile der Syntax aufgeführt, die für den Befehl eb config verwendet wird, um mit den aktiven Konfigurationseinstellungen der Umgebung zu arbeiten. Konkrete Beispiele finden Sie im Abschnitt Beispiele weiter unten in diesem Thema.

• eb config – Zeigt die aktiven Konfigurationseinstellungen der Umgebung in einem Texteditor an, den Sie als EDITOR-Umgebungsvariable konfiguriert haben. Wenn Sie Änderungen in der Datei speichern und den Editor schließen, wird die Umgebung mit den in der Datei gespeicherten Optionseinstellungen aktualisiert.

  Anmerkung

  Wenn Sie keine EDITOR-Umgebungsvariable konfiguriert haben, zeigt die EB-CLI Ihre Optionseinstellungen im Standard-Editor für YAML-Dateien an.

• eb config environment-name— Zeigt die Konfiguration für die benannte Umgebung an und aktualisiert diese. Die Konfiguration wird entweder in einem von Ihnen konfigurierten Texteditor oder im Standard-Editor für YAML-Dateien angezeigt.

• eb config save – Speichert die aktiven Konfigurationseinstellungen für die aktuelle Umgebung in .elasticbeanstalk/saved_configs/ mit dem Dateinamen [configuration-name].cfg.yml. Standardmäßig speichert die EB-CLI Konfigurationseinstellungen mit einem configuration-name basierend auf dem Umgebungsnamen. Sie können einen anderen Konfigurationsnamen angeben, indem Sie die --cfg-Option in den gewünschten Konfigurationsnamen einschließen, wenn Sie den Befehl ausführen.

  Sie können Ihre gespeicherte Konfiguration unter Verwendung der --tags-Option markieren.

• eb config --display– Schreibt die aktiven Konfigurationseinstellungen einer Umgebung in stdout statt in eine Datei. Standardmäßig werden dadurch die Konfigurationseinstellungen für das Terminal angezeigt.

• eb config --update configuration_string | file_path– Aktualisiert die aktiven Konfigurationseinstellungen für die aktuelle Umgebung mit den Informationen, die in configuration_string oder innerhalb der durch file_path identifizierten Datei angegeben sind.

Anmerkung

Die Optionen --display und --update bieten Flexibilität beim programmgesteuerten Lesen und Überarbeiten der Konfigurationseinstellungen einer Umgebung.

In der folgenden Tabelle wird die Syntax für den eb config-Befehl für die Arbeit mit gespeicherten Konfigurationen beschrieben. Beispiele finden Sie im Abschnitt Beispiele weiter unten in diesem Thema.

• eb config get config-name – Lädt die benannte gespeicherte Konfiguration von Amazon-S3 herunter.

• eb config delete config-name – Löscht die benannte gespeicherte Konfiguration von Amazon-S3. Löscht sie auch lokal, wenn Sie sie bereits heruntergeladen haben.

• eb config list – Listet die Konfigurationen auf, die Sie in Amazon-S3 gespeichert haben.

• eb config put filename – Lädt die benannte gespeicherte Konfiguration in einen Amazon-S3-Bucket hoch. Der Dateiname muss die Dateierweiterung .cfg.yml haben. Um den Dateinamen ohne Pfad anzugeben, können Sie die Datei im Ordner .elasticbeanstalk oder im Ordner .elasticbeanstalk/saved_configs/ speichern, bevor Sie den Befehl ausführen. Alternativ können Sie den Dateinamen festlegen, indem Sie den vollständigen Pfad angeben.

Optionen

Name	Beschreibung
--cfg config-name	Der Name, der für eine gespeicherte Konfiguration verwendet werden soll. Diese Option funktioniert nur mit dem Befehl eb config save.
-d oder --display	Zeigt die aktiven Konfigurationseinstellungen für die aktuelle Umgebung an (schreibt in stdout). Verwenden Sie sie mit der Option --format, um anzugeben, dass die Ausgabe in JSON oder YAML erfolgen soll. Wenn Sie keine Angaben machen, erfolgt die Ausgabe im YAML-Format. Diese Option kann nur ausgeführt werden, wenn Sie den Befehl eb config ohne einen der anderen Unterbefehle verwenden.
-f format_type oder --format format_type	Gibt das Anzeigeformat an. Gültige Werte sind JSON und YAML. Die Standardeinstellung ist YAML. Diese Option funktioniert nur mit der Option --display.
--tags key1=value1[,key2=value2 ...]	Tags zum Hinzufügen zu Ihrer gespeicherten Konfiguration. Wenn Sie in der Liste Tags angeben, dann geben Sie diese als Schlüssel-Wert-Paare an und trennen Sie jedes mit einem Komma. Weitere Informationen finden Sie unter Markieren von gespeicherten Konfigurationen. Diese Option funktioniert nur mit dem Befehl eb config save.
--timeout timeout	Die Anzahl der Minuten, bevor ein Timeout für den Befehl auftritt.
-u configuration_string | file_path oder --update configuration_string | file_path	Aktualisiert die aktiven Konfigurationseinstellungen für die aktuelle Umgebung. Diese Option kann nur ausgeführt werden, wenn Sie den Befehl eb config ohne einen der anderen Unterbefehle verwenden. Der Parameter configuration_string | file_path hat den Typ Zeichenfolge. Die Zeichenfolge enthält die Liste der Namespaces und die entsprechenden Optionen zum Hinzufügen, Aktualisieren oder Entfernen aus den Konfigurationseinstellungen für die Umgebung. Alternativ kann die Eingabezeichenfolge eine Datei darstellen, die dieselben Informationen enthält. Um einen Dateinamen anzugeben, muss die Eingabezeichenfolge dem Format entspreche "file://<path><filename>". Um den Dateinamen ohne path anzugeben, speichern Sie die Datei in dem Ordner, in dem Sie den Befehl ausführen. Alternativ legen Sie den Dateinamen fest, indem Sie den vollständigen Pfad angeben. Die Konfigurationsinformationen müssen die folgenden Bedingungen erfüllen. Mindestens einer der Abschnitte, OptionSettings oder OptionsToRemove, ist erforderlich. Verwenden Sie OptionSettings, um Optionen hinzuzufügen oder zu ändern. Verwenden Sie OptionsToRemove, um Optionen aus einem Namespace zu entfernen. Konkrete Beispiele finden Sie im Abschnitt Beispiele weiter unten in diesem Thema. YAML-Format OptionSettings: namespace1: option-name-1: option-value-1 option-name-2: option-value-2 ... OptionsToRemove: namespace1: option-name-1 option-name-2 ... JSON-Format { "OptionSettings": { "namespace1": { "option-name-1": "option-value-1", "option-name-2": "option-value-2", ... } }, "OptionsToRemove": { "namespace1": { "option-name-1", "option-name-2", ... } } }
Allgemeine Optionen

Ausgabe

Wenn der Befehl eb config oder eb config environment-name erfolgreich ohne hinzugefügte Unterbefehle oder Optionen ausgeführt wird, zeigt der Befehl Ihre aktuellen Optionseinstellungen im Text-Editor, die Sie als EDITOR-Umgebungsvariable konfiguriert haben. Wenn Sie keine EDITOR-Umgebungsvariable konfiguriert haben, zeigt die EB-CLI Ihre Optionseinstellungen im Standard-Editor für YAML-Dateien an.

Wenn Sie Änderungen in der Datei speichern und den Editor schließen, wird die Umgebung mit den in der Datei gespeicherten Optionseinstellungen aktualisiert. Die folgende Ausgabe wird angezeigt, um das Konfigurationsupdate zu bestätigen.

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

Wenn der Befehl erfolgreich mit der Option --display ausgeführt wird, werden die Konfigurationseinstellungen für die aktuelle Umgebung angezeigt (schreibt instdout).

Wenn der Befehl erfolgreich mit dem get-Parameter ausgeführt wird, zeigt der Befehl den Speicherort der lokalen Kopie, die Sie heruntergeladen haben.

Wenn der Befehl erfolgreich mit dem save-Parameter ausgeführt wird, zeigt der Befehl den Speicherort der gespeicherten Datei.

Beispiele

In diesem Abschnitt wird beschrieben, wie Sie den Text-Editor ändern, den Sie zum Anzeigen und Bearbeiten Ihrer Optionseinstellungen verwenden.

Für Linux und UNIX wird im folgenden Beispiel der Editor auf vim geändert:

$ export EDITOR=vim

Für Linux und UNIX wird im folgenden Beispiel der Editor auf das geändert, was unter installiert is /usr/bin/kate.

$ export EDITOR=/usr/bin/kate

Für Windows wird im folgenden Beispiel der Editor auf Notepad++ geändert:

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

Dieser Abschnitt zeigt Beispiele für den eb config-Befehl, wenn er mit Unterbefehlen ausgeführt wird.

Im folgenden Beispiel wird die gespeicherte Konfiguration mit dem Namen gelösch app-tmp.

$ eb config delete app-tmp

Im folgenden Beispiel wird die gespeicherte Konfiguration mit dem Namen "app-tmp" aus Ihrem Amazon-S3-Bucket heruntergeladen.

$ eb config get app-tmp

Im folgenden Beispiel werden die Namen der gespeicherten Konfigurationen aufgelistet, die in Ihrem Amazon-S3-Bucket gespeichert sind.

$ eb config list

Im folgenden Beispiel wird die lokale Kopie der gespeicherten Konfiguration mit dem Namen "app-tmp" in Ihren Amazon-S3-Bucket hochgeladen.

$ eb config put app-tmp

Im folgenden Beispiel werden Konfigurationseinstellungen aus der aktuell laufenden Umgebung gespeichert. Wenn Sie keinen Namen für die gespeicherte Konfiguration angeben, benennt Elastic Beanstalk die Konfigurationsdatei entsprechend des Umgebungsnamens. Beispiel: Eine Umgebung mit dem Namen tmp-dev würde als tmp-dev.cfg.yml bezeichnet werden. Elastic Beanstalk speichert die Datei im Ordner /.elasticbeanstalk/saved_configs/.

$ eb config save

Im folgenden Beispiel wird die --cfg-Option zum Speichern der Konfigurationseinstellungen aus der Umgebung "tmp-dev" in eine Datei mit dem Namen v1-app-tmp.cfg.yml gespeichert wird. Elastic Beanstalk speichert die Datei im Ordner /.elasticbeanstalk/saved_configs/. Wenn Sie keinen Umgebungsnamen angeben, speichert Elastic-Beanstalk-Konfigurationseinstellungen aus der aktuell laufenden Umgebung.

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

Dieser Abschnitt zeigt Beispiele für den eb config-Befehl, wenn er ohne Unterbefehle ausgeführt wird.

Der folgende Befehl zeigt die Optionseinstellungen Ihrer aktuellen Umgebung in einem Texteditor an.

$ eb config

Der folgende Befehl zeigt die Optionseinstellungen für die my-env-Umgebung in einem Texteditor an.

$ eb config my-env

Im folgenden Beispiel werden die Optionseinstellungen für die aktuelle Umgebung angezeigt. Die Ausgabe erfolgt im YAML-Format, da mit der Option --format kein bestimmtes Format angegeben wurde.

$ eb config --display

Im folgenden Beispiel werden die Optionseinstellungen für Ihre aktuelle Umgebung mit den Angaben in der Datei namens aktualisier example.txt. Die Datei ist entweder im YAML- oder JSON-Format. Die EB-CLI erkennt das Dateiformat automatisch.

• Die Option MinSize ist für den Namespace auf 1 festgeleg aws:autoscaling:asg.

• Die Batch-Größe für den Namespace aws:elasticbeanstalk:command ist auf 30 % festgelegt.

• Damit wird die Optionseinstellung IdleTimeout: None aus dem Namespace AWSEBV2LoadBalancer.aws:elbv2:loadbalancer entfernt.

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

Beispiel - Dateiname: example.txt – YAML-Format

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

Beispiel - Dateiname: example.txt – JSON-Format

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

Im folgenden Beispiel werden die Optionseinstellungen für die aktuelle Umgebung aktualisiert. Der Befehl legt die Minsize-Option für den Namespace aws:autoscaling:asg auf 1 fest.

Anmerkung

Diese Beispiele beziehen sich auf Windows PowerShell. Sie umgehen literale Vorkommen des Anführungszeichens ("), indem sie ihm einen Schrägstrich (\) voranstellen. Verschiedene Betriebssysteme und Befehlszeilenumgebungen haben möglicherweise unterschiedliche Escape-Sequenzen. Aus diesem Grund empfehlen wir, die in den vorherigen Beispielen gezeigte Dateioption zu verwenden. Die Angabe der Konfigurationsoptionen in einer Datei erfordert keine Escape-Zeichen und ist für verschiedene Betriebssysteme konsistent.

Das folgende Beispiel verwendet das JSON-Format. Die EB-CLI erkennt, ob ein JSON- oder YAML-Format vorliegt.

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

Das folgende Beispiel verwendet das YAML-Format. Um die YAML-Zeichenfolge im richtigen Format einzugeben, enthält der Befehl die in einer YAML-Datei erforderlichen Abstände und Zeilenenden.

• Schließen Sie jede Zeile mit der „Enter“- oder „Return“-Taste ab.

• Beginnen Sie die zweite Zeile mit zwei Leerzeichen und die dritte Zeile mit vier Leerzeichen.

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