Description Syntaxe Options Sortie Exemples

eb config

Description

Gère les paramètres de configuration actifs et les configurations enregistrées de votre environnement. Vous pouvez utiliser cette commande pour charger, télécharger ou répertorier les configurations enregistrées de votre environnement. Vous pouvez également l'utiliser pour télécharger, afficher ou mettre à jour ses paramètres de configuration actifs.

Si le répertoire racine contient un fichier platform.yaml spécifiant une plateforme personnalisée, cette commande modifie également les paramètres de configuration du générateur. Cela se fait en fonction des valeurs définies dans platform.yaml.

Note

eb config n'affiche pas les propriétés de l'environnement. Pour définir les propriétés de l'environnement que vous pouvez lire à partir de votre application, utilisez eb setenv à la place.

Syntaxe

Les éléments suivants font partie de la syntaxe utilisée pour que la commande eb config fonctionne avec les paramètres de configuration actifs de votre environnement. Pour obtenir des exemples spécifiques, consultez la section Exemples plus loin dans cette rubrique.

eb config– Affiche les paramètres de configuration actifs de votre environnement dans un éditeur de texte que vous avez configuré en tant que variable d'environnement EDITOR. Lorsque vous enregistrez des modifications dans le fichier et que vous fermez l'éditeur, l'environnement est mis à jour avec les paramètres d'option que vous avez enregistrés dans le fichier.

Note
Si vous n'avez pas configuré de variable d'environnement EDITOR, l'interface de ligne de commande (CLI) EB affiche vos paramètres d'options dans votre éditeur par défaut pour les fichiers YAML.
eb config environment-name – Affiche et met à jour la configuration de l'environnement nommé. La configuration s'affiche soit dans un éditeur de texte que vous avez configuré, soit dans les fichiers YAML de votre éditeur par défaut.
eb config save – Enregistre les paramètres de configuration actifs de l'environnement actuel dans .elasticbeanstalk/saved_configs/ avec le nom de fichier [configuration-name].cfg.yml. Par défaut, l'interface de ligne de commande (CLI) EB enregistre les paramètres de configuration avec un configuration-name basé sur le nom de l'environnement. Vous pouvez spécifier un nom de configuration différent en incluant l'option --cfg avec votre nom de la configuration souhaité lorsque vous exécutez la commande.

Vous pouvez baliser votre configuration enregistrée à l'aide de l'option --tags.
eb config --display – Écrit les paramètres de configuration actifs d'un environnement dans stdout au lieu d'un fichier. Par défaut, cela affiche les paramètres de configuration dans le terminal.
eb config --update configuration_string | file_path– Met à jour les paramètres de configuration actifs de l'environnement actuel avec les informations spécifiées dans configuration_string ou dans le fichier identifié par file_path.

Note

Les options --display et --update offrent une flexibilité pour lire et réviser les paramètres de configuration d'un environnement par programmation.

Ce qui suit décrit la syntaxe pour l'utilisation de la commande eb config permettant de travailler avec des configurations enregistrées. Pour obtenir des exemples, consultez la section Exemples plus loin dans cette rubrique.

eb config get config-name– Télécharge la configuration enregistrée nommée depuis Amazon S3.
eb config delete config-name – Supprime la configuration enregistrée nommée d'Amazon S3. Elle la supprime également localement, si vous l'avez déjà téléchargée.
eb config list – Répertorie les configurations enregistrées que vous avez dans Amazon S3.
eb config put filename – Télécharge la nommé configuration enregistrée nommée dans un compartiment Amazon S3. Le nom de fichier doit avoir l'extension de fichier .cfg.yml. Pour spécifier le nom du fichier sans chemin d'accès, vous pouvez enregistrer le fichier dans le dossier .elasticbeanstalk ou dans le dossier .elasticbeanstalk/saved_configs/ avant d'exécuter la commande. Vous pouvez sinon spécifier le nom de fichier en fournissant le chemin d'accès complet.

Options

Nom	Description
`--cfg config-name`	Nom à utiliser pour une configuration enregistrée. Cette option fonctionne avec eb config save uniquement.
`-d` ou `--display`	Affiche les paramètres de configuration de l'environnement actuel (écrit dans stdout). Utilisez l'option `--format` pour spécifier que la sortie doit être au format JSON ou YAML. Si vous ne le spécifiez pas, la sortie est au format YAML. Cette option ne fonctionne que si vous utilisez la commande eb config sans aucune autre sous-commande.
`-f format_type` ou `--format format_type`	Spécifie le format d'affichage. Les valeurs valides sont JSON ou YAML. La valeur par défaut est YAML. Cette option fonctionne uniquement avec l'option `--display`.
`--tags key1=value1[,key2=value2 ...]`	Les balises à ajouter à votre configuration enregistrée. Lorsque vous spécifiez des balises dans la liste, spécifiez-les en tant que paires clé=valeur et séparez-les par une virgule. Pour plus d'informations, consultez Balisage de configurations enregistrées. Cette option fonctionne avec eb config save uniquement.
`--timeout timeout`	Le nombre de minutes avant que la commande expire.
`-u configuration_string \| file_path` ou `--update configuration_string \| file_path`	Met à jour les paramètres de configuration actifs de l'environnement actuel. Cette option ne fonctionne que si vous utilisez la commande eb config sans aucune autre sous-commande. Le paramètre `configuration_string \| file_path` est de type chaîne. La chaîne fournit la liste des espaces de noms et des options correspondantes pour ajouter, mettre à jour ou supprimer des paramètres de configuration de votre environnement. La chaîne d'entrée peut également représenter un fichier contenant les mêmes informations. Pour spécifier un nom de fichier, la chaîne d'entrée doit suivre le format `"file://<path><filename>"`. Pour spécifier le nom de fichier sans un`path`, enregistrez-le dans le dossier dans lequel vous exécutez la commande. Vous pouvez sinon spécifier le nom de fichier en fournissant le chemin d'accès complet. Les informations de configuration doivent répondre aux conditions suivantes. Au moins une des sections,OptionSettings ou OptionsToRemove, est requise. Utilisez OptionSettings pour ajouter ou modifier des options. Utilisez OptionsToRemove pour supprimer des options d'un espace de noms. Pour obtenir des exemples spécifiques, consultez la section Exemples plus loin dans cette rubrique. Format YAML `OptionSettings: namespace1: option-name-1: option-value-1 option-name-2: option-value-2 ... OptionsToRemove: namespace1: option-name-1 option-name-2 ...` Format JSON `{ "OptionSettings": { "namespace1": { "option-name-1": "option-value-1", "option-name-2": "option-value-2", ... } }, "OptionsToRemove": { "namespace1": { "option-name-1", "option-name-2", ... } } }`
Options courantes

Sortie

Si la commande eb config ou eb config environment-nameest exécutée avec succès sans ajout d'une sous-commande ou d'une option, la commande affiche vos paramètres d'options actuels dans l'éditeur de texte que vous avez configuré en tant que variable d'environnement EDITOR. Si vous n'avez pas configuré de variable d'environnement EDITOR, l'interface de ligne de commande (CLI) EB affiche vos paramètres d'options dans votre éditeur par défaut pour les fichiers YAML.

Lorsque vous enregistrez des modifications dans le fichier et que vous fermez l'éditeur, l'environnement est mis à jour avec les paramètres d'option que vous avez enregistrés dans le fichier. La sortie suivante s'affiche pour confirmer la mise à jour de la configuration.


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

Si la commande s'exécute avec succès avec l'option --display, elle affiche les paramètres de configuration de l'environnement actuel (écrit dansstdout).

Si la commande s'exécute avec succès avec le paramètre get, la commande affiche l'emplacement de la copie locale que vous avez téléchargée.

Si la commande s'exécute avec succès avec le paramètre save, la commande affiche l'emplacement du fichier enregistré.

Exemples

Cette section décrit comment modifier l'éditeur de texte que vous utilisez pour afficher et modifier votre fichier de paramètres d'option.

Pour Linux et UNIX, l'exemple suivant remplace l'éditeur par vim :


$ export EDITOR=vim

Pour Linux et UNIX, l'exemple suivant remplace l'éditeur par ce qui est installé à l'emplacement /usr/bin/kate.


$ export EDITOR=/usr/bin/kate

Pour Windows, l'exemple suivant remplace l'éditeur par Notepad++.


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

Cette section fournit des exemples de la commande eb config lorsqu'elle est exécutée avec des sous-commandes.

L'exemple suivant supprime la configuration enregistrée nommée app-tmp.


$ eb config delete app-tmp

L'exemple suivant télécharge la configuration enregistrée avec le nom app-tmp depuis votre compartiment Amazon S3.


$ eb config get app-tmp

L'exemple suivant répertorie les noms des configurations enregistrées qui sont stockées dans votre compartiment Amazon S3.


$ eb config list

L'exemple suivant télécharge la copie locale de la configuration enregistrée nommée app-tmp dans votre compartiment Amazon S3.


$ eb config put app-tmp

L'exemple suivant enregistre les paramètres de configuration de l'environnement en cours d'exécution actuel. Si vous ne fournissez pas un nom à utiliser pour la configuration enregistrée, alors Elastic Beanstalk nomme le fichier de configuration en fonction du nom de l'environnement. Par exemple, un environnement nommé tmp-dev serait appelé tmp-dev.cfg.yml. Elastic Beanstalk enregistre le fichier dans le dossier /.elasticbeanstalk/saved_configs/.


$ eb config save

Dans l'exemple suivant, l'option --cfg est utilisée pour enregistrer les paramètres de configuration de l'environnement tmp-dev dans un fichier appelé v1-app-tmp.cfg.yml. Elastic Beanstalk enregistre le fichier dans le dossier /.elasticbeanstalk/saved_configs/. Si vous ne spécifiez pas un nom d'environnement, Elastic Beanstalk enregistre les paramètres de configuration de l'environnement en cours d'exécution actuel.


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

Cette section fournit des exemples de commande eb config lorsqu'elle est exécutée sans sous-commande.

La commande suivante affiche les paramètres d'options de votre environnement actuel dans un éditeur de texte.


$ eb config

La commande suivante affiche les paramètres d'options de l'environnement my-env dans un éditeur de texte.


$ eb config my-env

L'exemple suivant affiche les paramètres d'options de votre environnement actuel. Il sort au format YAML car aucun format spécifique n'a été spécifié avec l'option --format.


$ eb config --display

L'exemple suivant met à jour les paramètres d'options de votre environnement actuel avec les spécifications du fichier nommé example.txt. Le fichier a un format YAML ou JSON. L'interface de ligne de commande (CLI) EB détecte automatiquement le format de fichier.

L'option Minsize est définie sur 1 pour l'espace de noms aws:autoscaling:asg.
La taille du lot de l'espace de noms aws:elasticbeanstalk:command est définie sur 30 %.
Cela supprime le paramètre d'option IdleTimeout: None de l'espace de noms AWSEBV2LoadBalancer.aws:elbv2:loadbalancer.


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

Exemple - nom de fichier :`example.txt` - format YAML


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

Exemple - nom de fichier :`example.txt` - format JSON


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

Les exemples suivants mettent à jour les paramètres d'options de votre environnement actuel. La commande définit l'option Minsize sur 1 pour l'espace de noms aws:autoscaling:asg.

Note

Ces exemples sont spécifiques à Windows PowerShell. Ils échappent aux occurrences littérales du caractère double guillemet (") en le faisant précéder d'une barre oblique (\). Différents systèmes d'exploitation et environnements de ligne de commande peuvent comporter des séquences d'échappement différentes. Pour cette raison, nous vous recommandons d'utiliser l'option de fichier reprise dans les exemples précédents. La spécification des options de configuration dans un fichier ne nécessite pas l'échappement de caractères et est cohérente entre différents systèmes d'exploitation.

L'exemple suivant est au format JSON. L'interface de ligne de commande (CLI) EB détecte si le format est en JSON ou YAML.


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

L'exemple suivant est au format YAML. Pour entrer la chaîne YAML au format correct, la commande inclut l'espacement et les retours de fin de ligne requis dans un fichier YAML.

Terminez chaque ligne avec la touche « Entrée » ou « retour ».
Commencez la deuxième ligne par deux espaces et commencez la troisième ligne par quatre espaces.


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

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

eb codesource

eb console

eb config

Description

Note

Syntaxe

Note

Note

Options

Sortie

Exemples

Exemple - nom de fichier :example.txt - format YAML

Exemple - nom de fichier :example.txt - format JSON

Note

Exemple - nom de fichier :`example.txt` - format YAML

Exemple - nom de fichier :`example.txt` - format JSON