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

O Guia de referência da API do AWS SDK para JavaScript V3 descreve em detalhes todas as operações da API para o AWS SDK para JavaScript versão 3 (V3).

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

Definir a região da AWS

Uma região da AWS é 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 criar um cliente de serviço no SDK para JavaScript para que o SDK acesse o serviço 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 da AWS usando uma variável de ambiente ou um arquivo config compartilhado.

Em um construtor de classes do cliente

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

const s3Client = new S3.S3Client({region: 'us-west-2'});

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 config compartilhado

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

  • Usuários de Linux, macOS ou 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-west-2 output=json

Para obter mais informações sobre o uso de arquivos config e credentials compartilhados, consulte Arquivos compartilhados de configuração e credenciais no Guia de referência de ferramentas e SDKs da AWS.

Ordem de precedência para definir a região

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

  1. Se uma região for passada para um construtor de classe de cliente, essa região será usada.

  2. Se uma região for definida na variável de ambiente, essa região será usada.

  3. Caso contrário, a região definida no arquivo de configuração compartilhado será usada.