Variáveis de ambiente para configurar a AWS CLI - AWS Command Line Interface

O Python 2.7, 3.4 e 3.5 está sendo defasado para o AWS CLI versão 1. Para obter mais informações, consulte a AWS CLI versão 1 seção de Sobre as AWS CLI versões.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Variáveis de ambiente para configurar a AWS CLI

Variáveis de ambiente fornecem outra maneira de especificar opções de configuração e credenciais e podem ser úteis para criação de scripts ou configuração temporária de um perfil nomeado como o padrão.

nota

Você não pode especificar a autenticação do Logon único da AWS (AWS SSO) usando variáveis de ambiente. Em vez disso, você deve usar um perfil nomeado no arquivo de configuração compartilhado .aws/config. Para obter mais informações, consulte Configurar a AWS CLI para usar o Logon único da AWS .

Precedência de opções

  • Se você especificar uma opção usando uma das variáveis de ambiente descritas nesse tópico, ela substituirá qualquer valor carregado de um perfil no arquivo de configuração.

  • Se você especificar uma opção usando um parâmetro na linha de comandos da CLI, ela substituirá qualquer valor da variável de ambiente correspondente ou de um perfil no arquivo de configuração.

Para obter mais informações sobre precedência e como a AWS CLI determina quais credenciais usar, consulte Definições de configuração e precedência.

Como definir variáveis de ambiente

Os exemplos a seguir mostram como configurar variáveis de ambiente para o usuário padrão.

Linux ou macOS X
$ export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE $ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY $ export AWS_DEFAULT_REGION=us-west-2

Configurar a variável de ambiente altera o valor usado até o final da sua sessão de shell ou até que você defina a variável como um valor diferente. Você pode tornar as variáveis persistentes em sessões futuras definindo-as no script de inicialização do shell.

Windows Command Prompt
C:\> setx AWS_ACCESS_KEY_ID AKIAIOSFODNN7EXAMPLE C:\> setx AWS_SECRET_ACCESS_KEY wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY C:\> setx AWS_DEFAULT_REGION us-west-2

O uso de set para definir uma variável de ambiente altera o valor usado até o final da sessão de prompt de comando atual ou até que você defina a variável como um valor diferente. Usar setx para definir uma variável de ambiente altera o valor usado na sessão de prompt de comando atual e em todas as sessões de prompt de comando criadas após a execução do comando. Ela não afeta outros shells de comando que já estejam em execução no momento em que você executa o comando.

PowerShell
PS C:\> $Env:AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" PS C:\> $Env:AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" PS C:\> $Env:AWS_DEFAULT_REGION="us-west-2"

Se você definir uma variável de ambiente no PowerShell prompt conforme mostrado nos exemplos anteriores, ela salvará o valor somente pela duração da sessão atual. Para tornar a configuração da variável de ambiente persistente em todas as sessões do prompt de comando do PowerShell e do , armazene-a usando o aplicativo System (Sistema) no Control Panel (Painel de controle). Como alternativa, você pode definir a variável para todas as PowerShell sessões futuras adicionando-a ao seu PowerShell perfil. Consulte a PowerShell documentação do para obter mais informações sobre como armazenar variáveis de ambiente ou mantê-las entre sessões.

AWS CLIVariáveis de ambiente compatíveis da

A AWS CLI é compatível com as seguintes variáveis de ambiente.

AWS_ACCESS_KEY_ID

Especifica uma chave de acesso da AWS associada a um usuário ou função do IAM

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil aws_access_key_id. Você não pode especificar o ID de chave de acesso usando uma opção de linha de comando.

AWS_CA_BUNDLE

Especifica o caminho para um pacote de certificado a ser usado para a validação de certificado HTTPS.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil ca_bundle. Você pode substituir essa variável de ambiente usando o parâmetro de linha de --ca-bundle comando .

AWS_CLI_AUTO_PROMPT
Esse recurso está disponível somente na AWS CLI versão 2.

O recurso a seguir só estará disponível se você usar a AWS CLI versão 2. Ele não estará disponível se você executar a AWS CLI versão 1. Para obter informações sobre como instalar a versão 2, consulte Instalar, atualizar e desinstalar aAWS CLI versão 2.

Habilita o aviso automático para o AWS CLI versão 2. Há duas configurações que podem ser usadas:

  • on O usa o modo de prompt automático completo sempre que você tenta executar um aws comando da . Isso inclui pressionar ENTER após um comando completo ou incompleto.

    aws_cli_auto_prompt=on
  • on-partial O usa o modo de aviso automático parcial. Se um comando estiver incompleto ou não puder ser executado devido a erros de validação no lado do cliente, o aviso automático será usado. Esse modo é especialmente útil se você tiver scripts pré-existentes, runbooks ou apenas quiser ser solicitado automaticamente para comandos com os quais não está familiarizado em vez de solicitado em cada comando.

    aws_cli_auto_prompt=on-partial

Se definida, essa variável de ambiente substituirá o valor da configuração cli_auto_prompt de perfil. Você pode substituir essa variável de ambiente usando os parâmetros de linha de --cli-auto-prompt comando --no-cli-auto-prompt e .

Para obter informações sobre o recurso de aviso AWS CLI versão 2 automático, consulte Ter a AWS CLI solicitando comandos a você.

AWS_CLI_FILE_ENCODING

AWS CLI versão 2Somente Especifica a codificação usada para arquivos de texto. Por padrão, a codificação corresponde à sua localidade. Para definir uma codificação diferente da localidade, use a variável de ambiente aws_cli_file_encoding Por exemplo, se você usar o Windows com a codificação padrão CP1252, a configuração de aws_cli_file_encoding=UTF-8 definirá a CLI para abrir arquivos de texto usando UTF-8.

AWS_CONFIG_FILE

Especifica o local do arquivo que a AWS CLI usa para armazenar perfis de configuração. O caminho padrão é ~/.aws/config.

Você não pode especificar esse valor em uma configuração de perfil nomeado nem usando um parâmetro de linha de comando.

AWS_DEFAULT_OUTPUT

Especifica o formato Controlar a saída do comando da AWS CLI de saída a ser usado.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil output. Você pode substituir essa variável de ambiente usando o parâmetro de linha de --output comando .

AWS_DEFAULT_REGION

Especifica a região da AWS para a qual enviar a solicitação.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil region. Você pode substituir essa variável de ambiente usando o parâmetro de linha de --region comando .

AWS_EC2_METADATA_DISABLED

Desabilita o uso do serviço de metadados da Amazon EC2 instância (IMDS).

Se definido como falso, as credenciais ou a configuração do usuário (como a região) não serão solicitadas ao IMDS.

AWS_MAX_ATTEMPTS

Especifica um valor de tentativas máximas de repetição que o manipulador AWS CLI de novas tentativas usa, em que a chamada inicial conta para o valor fornecido. Para obter mais informações sobre novas tentativas, consulte AWS CLI tentar novamente.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfis max_attempts.

AWS_PAGER

Especifica o programa de paginação usado para saída. Por padrão, a AWS CLI versão 2 retorna toda a saída pelo programa de paginação padrão do sistema operacional.

Para desativar o uso total de um programa de paginação externo, defina a variável como uma string vazia.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil cli_pager.

AWS_PROFILE

Especifica o nome do perfil da CLI com as credenciais e as opções a serem usadas. Esse pode ser o nome de um perfil armazenado em um arquivo credentials ou config ou o valor default para usar o perfil padrão.

Se você especificar essa variável de ambiente, ela substituirá o comportamento de usar o perfil nomeado [default] no arquivo de configuração. Você pode substituir essa variável de ambiente usando o parâmetro de linha de comando --profile

AWS_RETRY_MODE

Especifica qual modo de repetição AWS CLI usa. Existem três modos de repetição disponíveis: herdado (padrão), padrão e adaptável. Para obter mais informações sobre novas tentativas, consulte AWS CLI tentar novamente.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfis retry_mode.

AWS_ROLE_SESSION_NAME

Especifica um nome a ser associado à sessão da função. Esse valor é exibido em logs do CloudTrail para comandos executados pelo usuário desse perfil.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil role_session_name. Você não pode especificar um nome de sessão de função como um parâmetro de linha de comando.

AWS_SECRET_ACCESS_KEY

Especifica a chave secreta associada à chave de acesso. Essencialmente, essa é a "senha" para a chave de acesso.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil aws_secret_access_key. Você não pode especificar o ID de chave de acesso secreta como uma opção de linha de comando.

AWS_SESSION_TOKEN

Especifica o valor de token de sessão que é necessário se você estiver usando credenciais de segurança temporárias recuperadas diretamente das operações do AWS STS Para obter mais informações, consulte Seção de saída do comando assume-role no AWS CLI Command Reference.

Se definida, essa variável de ambiente substituirá o valor da configuração de perfil aws_session_token. Você não pode especificar o token de sessão como uma opção de linha de comando.

AWS_SHARED_CREDENTIALS_FILE

Especifica o local do arquivo que a AWS CLI usa para armazenar chaves de acesso. O caminho padrão é ~/.aws/credentials.

Você não pode especificar esse valor em uma configuração de perfil nomeado nem usando um parâmetro de linha de comando.

AWS_STS_REGIONAL_ENDPOINTS

Especifica como a AWS CLI determina o endpoint do serviço da AWS que o cliente da AWS CLI usa para se comunicar com o AWS Security Token Service (AWS STS).

  • O valor padrão para AWS CLI versão 1 é legacy.

  • O valor padrão para AWS CLI versão 2 é regional.

É possível especificar um dos dois valores:

  • legacy – Usa o endpoint global do STS, sts.amazonaws.com, para as seguintes AWS regiões: ap-northeast-1, ap-south-1, ap-southeast-1, ap-southeast-2, aws-global, ca-central-1 eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, e us-west-2. Todas as outras regiões usam automaticamente o respectivo endpoint regional.

  • regional – a AWS CLI sempre usa o endpoint do AWS STS para a região atualmente configurada. Por exemplo, se o cliente estiver configurado para usar us-west-2, todas as chamadas ao AWS STS serão feitas para o endpoint regional sts.us-west-2.amazonaws.com em vez do endpoint global sts.amazonaws.com Para enviar uma solicitação para o endpoint global enquanto a configuração é habilitada, você pode definir a região como aws-global.