Defina a AWS região - AWS SDK for JavaScript

O Guia de referência da API do AWS SDK for JavaScript V3 descreve em detalhes todas as operações da API para o AWS SDK for 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á.

Defina a AWS região

Uma AWS região é um conjunto nomeado de AWS recursos 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 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 do JavaScript não seleciona uma região por padrão. No entanto, você pode definir a AWS Região usando uma variável de ambiente ou um config arquivo de configuração compartilhado.

Em um construtor de classes do cliente

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

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

Use 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 a JavaScript lê e a usa.

Use um arquivo de configuração compartilhado

Assim como o arquivo de credenciais compartilhado permite armazenar credenciais para uso pelo SDK, você pode manter sua AWS região e outras configurações em um arquivo compartilhado com o nome config do SDK a ser usado. Se a variável de AWS_SDK_LOAD_CONFIG ambiente for definida como um valor verdadeiro, o SDK JavaScript pesquisará automaticamente um config arquivo quando ele for 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.