eb config

Descrição

Gerencia as configurações ativas e as configurações salvas do seu ambiente. Você pode usar esse comando para fazer upload, fazer download ou listar as configurações salvas do seu ambiente. Você também pode usá-lo para fazer download, exibir ou atualizar suas configurações ativas.

Se o diretório raiz contém um arquivo platform.yaml especificando uma plataforma personalizada, este comando também altera as configurações do construtor. Isso é feito com base nos valores definidos em platform.yaml.

nota

eb config não exibe as propriedades do ambiente. Para definir as propriedades do ambiente que você pode ler a partir da sua aplicação, use eb setenv.

Sintaxe

A seguir estão partes da sintaxe que é usada para que o comando eb config funcione com as configurações ativas do seu ambiente. Para obter exemplo específicos, consulte a seção Exemplos mais adiante neste tópico.

eb config: exibe as configurações ativas do seu ambiente em um editor de texto que você configurou como a variável de ambiente EDITOR. Quando você salvar as alterações no arquivo e fechar o editor, o ambiente será atualizado com as configurações da opção no arquivo.

nota
Se você não configurou uma variável de ambiente EDITOR, a EB CLI exibirá suas configurações de opção no editor padrão para arquivos YAML.
eb config environment-name: exibe e atualiza a configuração para o ambiente nomeado. A configuração é exibida em um editor de texto que você configurou ou em seus arquivos YAML do editor padrão.
eb config save: salva as configurações ativas para o ambiente atual .elasticbeanstalk/saved_configs/ com o nome do arquivo[configuration-name].cfg.yml. Por padrão, a CLI do EB salva as configurações com configuration-name base no nome do ambiente. Você pode especificar um nome de configuração diferente incluindo a opção --cfg com o nome de configuração desejado quando executar o comando.

Você pode marcar a configuração salva usando a opção --tags.
eb config --display: grava as configurações ativas de um ambiente em stdout em vez de um arquivo. Por padrão, isso exibe as configurações para o final.
eb config --update configuration_string | file_path— atualiza as configurações ativas do ambiente atual com as informações configuration_string especificadas no arquivo identificado porfile_path.

nota

As opções --display e --update oferecem flexibilidade para ler e revisar as configurações de um ambiente programaticamente.

A tabela a seguir descreve a sintaxe para usar o comando eb config para funcionar com configurações salvas. Para obter exemplos, consulte a seção Exemplos mais adiante neste tópico.

eb config get config-name: faz o download da configuração salva nomeada do Amazon S3.
eb config delete config-name : exclui a configuração salva nomeada do Amazon S3. Também o exclui localmente, se você já fez o download.
eb config list: lista as configurações salvas que você tem no Amazon S3.
eb config put filename: faz upload da configuração salva nomeada em um bucket do Amazon S3. Eles filename devem ter a extensão do arquivo.cfg.yml. Para especificar o nome de arquivo sem um caminho, você pode salvar o arquivo na pasta .elasticbeanstalk ou .elasticbeanstalk/saved_configs/ antes de executar o comando. Como alternativa, você pode especificar o filename fornecendo o caminho completo.

Opções

Nome	Descrição
`--cfg config-name`	O nome a ser usado para uma configuração salva. Essa opção funciona apenas com eb config save.
`-d` ou `--display`	Exibe as configurações do ambiente atual (gravações em stdout). Use com a opção `--format` para especificar a saída para estar em JSON ou YAML. Se você não especificar, a saída estará no formato YAML. Essa opção só funciona se você usar o comando eb config sem nenhum dos outros subcomandos.
`-f format_type` ou `--format format_type`	Especifica o formato de exibição. Os valores válidos são JSON ou YAML. O padrão é YAML. Essa opção funciona somente com a opção `--display`.
`--tags key1=value1[,key2=value2 ...]`	As tags a serem adicionadas à sua configuração salva. Ao especificar tags na lista, especifique-as como pares chave=valor e separe cada uma com uma vírgula. Para obter mais informações, consulte Marcação de configurações salvas. Essa opção funciona apenas com eb config save.
`--timeout timeout`	O número de minutos antes de esgotar o tempo limite do comando.
`-u configuration_string \| file_path` ou `--update configuration_string \| file_path`	Atualiza as configurações ativas para o ambiente atual. Essa opção só funciona se você usar o comando eb config sem nenhum dos outros subcomandos. O parâmetro `configuration_string \| file_path` é do tipo de string. A string fornece a lista de namespaces e opções correspondentes para adicionar, atualizar ou remover das configurações do seu ambiente. Como alternativa, a string de entrada pode representar um arquivo que contém as mesmas informações. Para especificar um nome de arquivo, a string de entrada deve seguir o formato `"file://<path><filename>"`. Para especificar o nome do arquivo sem um `path`, salve o arquivo na pasta em que você executa o comando. Como alternativa, você pode especificar o nome de arquivo fornecendo o caminho completo. As informações de configuração devem atender às condições a seguir. Pelo menos uma das seções,OptionSettings ou OptionsToRemove, é necessária. Use OptionSettings para adicionar ou alterar opções. Use OptionsToRemove para remover opções de um namespace. Para obter exemplo específicos, consulte a seção Exemplos mais adiante neste tópico. Formato YAML `OptionSettings: namespace1: option-name-1: option-value-1 option-name-2: option-value-2 ... OptionsToRemove: namespace1: option-name-1 option-name-2 ...` Formato JSON `{ "OptionSettings": { "namespace1": { "option-name-1": "option-value-1", "option-name-2": "option-value-2", ... } }, "OptionsToRemove": { "namespace1": { "option-name-1", "option-name-2", ... } } }`
Opções comuns

Saída

Se o comando eb config ou eb config environment-name for executado com êxito sem subcomandos ou opções adicionadas, o comando exibirá as configurações de opção atuais no editor de texto que você configurou como a variável de ambiente EDITOR. Se você não configurou uma variável de ambiente EDITOR, a EB CLI exibirá suas configurações de opção no editor padrão para arquivos YAML.

Quando você salvar as alterações no arquivo e fechar o editor, o ambiente será atualizado com as configurações da opção no arquivo. A saída a seguir é exibida para confirmar a atualização de configuração.


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

Se o comando for executado com êxito com a opção --display, ele exibirá as configurações do ambiente atual (gravações em stdout).

Se o comando for executado com êxito com o parâmetro get, o comando exibirá a localização da cópia local que você baixou.

Se o comando for executado com êxito com o parâmetro save, o comando exibirá a localização do arquivo salvo.

Exemplos

Esta seção descreve como alterar o editor de texto usado para visualizar e editar o arquivo de configurações de opção.

Para Linux e UNIX, o seguinte exemplo altera o editor para vim:


$ export EDITOR=vim

Para Linux e UNIX, o exemplo a seguir altera o editor para aquele que estiver instalado em /usr/bin/kate.


$ export EDITOR=/usr/bin/kate

Para Windows, o exemplo a seguir altera o editor para Notepad++.


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

Esta seção fornece exemplos do comando eb config quando ele é executado com os parâmetros.

O exemplo a seguir exclui a configuração salva chamada app-tmp.


$ eb config delete app-tmp

O exemplo a seguir faz download da configuração salva com o nome app-tmp do bucket do Amazon S3.


$ eb config get app-tmp

O exemplo a seguir lista os nomes das configurações salvas que são armazenadas no bucket do Amazon S3.


$ eb config list

O exemplo a seguir faz upload da cópia local da configuração salva app-tmp no bucket do Amazon S3.


$ eb config put app-tmp

O exemplo a seguir salva as configurações do ambiente em execução no momento. Se você não fornecer um nome a ser usado para a configuração salva, o Elastic Beanstalk fornecerá um nome ao arquivo de configuração de acordo com o nome do ambiente. Por exemplo, um ambiente chamado tmp-dev seria chamado tmp-dev.cfg.yml. O Elastic Beanstalk salva o arquivo na pasta /.elasticbeanstalk/saved_configs/.


$ eb config save

O exemplo a seguir mostra como usar a opção --cfg para salvar as configurações do ambiente tmp-dev em um arquivo chamado v1-app-tmp.cfg.yml. O Elastic Beanstalk salva o arquivo na pasta /.elasticbeanstalk/saved_configs/. Se você não especificar um nome de ambiente, o Elastic Beanstalk salvará as configurações do ambiente em execução no momento.


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

Esta seção fornece exemplos para o comando eb config quando ele é executado sem subcomandos.

O comando a seguir exibe as configurações de opção do ambiente atual em um editor de texto.


$ eb config

O comando a seguir exibe as configurações de opção para o ambiente my-env em um editor de texto.


$ eb config my-env

O exemplo a seguir exibe as configurações de opções para o ambiente atual. Ele produz no formato YAML porque nenhum formato específico foi especificado com a opção --format.


$ eb config --display

O exemplo a seguir atualiza as configurações de opções para seu ambiente atual com as especificações no arquivo nomeado example.txt. O arquivo está no formato YAML ou JSON. A EB CLI detecta automaticamente o formato do arquivo.

A opção Minsize é definida como 1 para o namespace aws:autoscaling:asg.
O tamanho do lote para o namespace aws:elasticbeanstalk:command é definido como 30%.
Ele remove a configuração da opção IdleTimeout: Nenhuma do namespaceAWSEBV2LoadBalancer.aws:elbv2:loadbalancer.


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

exemplo - nome do arquivo:`example.txt` - formato YAML


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

exemplo - nome do arquivo:`example.txt` - formato JSON


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

Os exemplos a seguir atualizam as configurações de opções para seu ambiente atual. O comando define a opção Minsize como 1 para o namespace aws:autoscaling:asg.

nota

Esses exemplos são específicos para o Windows PowerShell. Eles escapam das ocorrências literais do caractere de aspas duplas ("), precedendo-o com um caractere barra (\). Diferentes sistemas operacionais e ambientes de linha de comando podem ter sequências de escape diferentes. Por esse motivo, recomendamos usar a opção de arquivo mostrada nos exemplos anteriores. Especificar as opções de configuração em um arquivo não requer caracteres de escape e é consistente em diferentes sistemas operacionais.

O exemplo a seguir está no formato JSON. A EB CLI detecta se o formato está em JSON ou YAML.


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

O exemplo a seguir está no formato YAML. Para inserir a string YAML no formato correto, o comando inclui espaçamento e end-of-line retornos necessários em um arquivo YAML.

Termine cada linha com a chave “enter” ou “return”.
Inicie a segunda linha com dois espaços e inicie a terceira linha com quatro espaços.


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

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

eb codesource

eb console

eb config

Descrição

nota

Sintaxe

nota

nota

Opções

Saída

Exemplos

exemplo - nome do arquivo:example.txt - formato YAML

exemplo - nome do arquivo:example.txt - formato JSON

nota

exemplo - nome do arquivo:`example.txt` - formato YAML

exemplo - nome do arquivo:`example.txt` - formato JSON