Definir a região da AWS - AWS SDK for JavaScript

Anunciamos o próximo fim do suporte para o AWS SDK for JavaScript v2. Recomendamos migrar para o AWS SDK for JavaScript v3. Para saber as datas e receber detalhes adicionais e informações sobre como migrar, consulte o anúncio vinculado.

Definir a região da AWS

Uma região é um conjunto de recursos da AWS nomeado na mesma área geográfica. Um exemplo de uma Região é us-east-1, que é a Região Leste dos EUA (Norte da Virgínia). Você especifica uma região ao configurar o SDK para , de maneira que o SDK acesse os recursos nessa região. Alguns serviços só estão disponíveis em regiões específicas.

O SDK para JavaScript. não seleciona uma região por padrão. No entanto, é possível definir a região usando uma variável de ambiente, um arquivo config compartilhado ou o objeto de configuração global.

Em um construtor de classes do cliente

Ao instanciar um objeto de serviço, especifique a região da desse recurso como parte do construtor de classe de cliente, conforme mostrado aqui.

var s3 = new AWS.S3({apiVersion: '2006-03-01', region: 'us-east-1'});

Usar o objeto de configuração global

Para definir a região no código JavaScript, atualize o objeto de configuração global AWS.Config conforme mostrado aqui.

AWS.config.update({region: 'us-east-1'});

Para obter mais informações sobre regiões atuais e serviços disponíveis em cada região, consulte Regiões e endpoints da AWS na Referência geral da AWS.

Usar uma variável de ambiente

Defina a região usando a variável de ambiente AWS_REGION. Se você definir essa variável, o SDK para JavaScript vai lê-la e usá-la.

Usar um arquivo de configuração compartilhado

Assim como o arquivo de credenciais compartilhado permite armazenar credenciais a serem usadas pelo SDK, é possível manter a região e outras definições de configuração compartilhadas em um arquivo chamado config usado pelos SDKs. Caso a variável de ambiente AWS_SDK_LOAD_CONFIG tenha sido definida como qualquer valor, o SDK para JavaScript procurará automaticamente um arquivo config quando ele for carregado. Onde você salva o arquivo config depende do sistema operacional:

  • Usuários do macOS ou do Unix: ~/.aws/config

  • Usuários do Windows: C:\Users\USER_NAME\.aws\config

Se não tiver um arquivo config compartilhado, você poderá criar um no diretório designado. No exemplo a seguir, o arquivo config define a região e o formato de saída.

[default] region=us-east-1 output=json

Para obter mais informações sobre como usar arquivos de configuração e credenciais compartilhados, consulte o Carregar credenciais em Node.js do arquivo de credenciais compartilhado ou Arquivos de configuração e credencial no Guia de usuário do AWS Command Line Interface.

Ordem de precedência para definir a região

A ordem de precedência de definição da região é a seguinte:

  • Se uma região for passada para um construtor de classe de cliente, essa região será usada. Do contrário...

  • Se uma região for definida no objeto de configuração global, essa região será usada. Do contrário...

  • Se a variável de ambiente AWS_REGION for um valor confiável, essa região será usada. Do contrário...

  • Se a variável de ambiente AMAZON_REGION for um valor confiável, essa região será usada. Do contrário...

  • Se a variável de ambiente AWS_SDK_LOAD_CONFIG for definida como qualquer valor e o arquivo de credenciais compartilhado (~/.aws/credentials ou o caminho indicado por AWS_SHARED_CREDENTIALS_FILE) contiver uma região para o perfil configurado, será usada essa região. Do contrário...

  • Se a variável de ambiente AWS_SDK_LOAD_CONFIG for definida como qualquer valor e o arquivo de configuração (~/.aws/config ou o caminho indicado por AWS_CONFIG_FILE) contiver uma região para o perfil configurado, será usada essa região.