Configuración de la región AWS - AWS SDK for JavaScript

Anunciamos la próxima AWS SDK for JavaScript versión end-of-support para la versión 2. Le recomendamos que migre a la AWS SDK for JavaScript versión 3. Para ver las fechas, los detalles adicionales y la información sobre cómo realizar la migración, consulte el anuncio enlazado.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Configuración de la región AWS

Una región es un conjunto de AWS recursos con nombre asignado en la misma área geográfica. Un ejemplo de región es us-east-1, que es la región Este de EE.UU. (Norte de Virginia). Al configurar el SDK, se especifica una región para JavaScript que el SDK acceda a los recursos de esa región. Algunos servicios de solo están disponibles en regiones específicas.

El SDK para JavaScript no selecciona una región de forma predeterminada. Sin embargo, puede configurar la región mediante una variable de entorno, un archivo config compartido o el objeto de configuración global.

En un constructor de clase de cliente

Cuando cree una instancia de un objeto de servicio, puede especificar la región de AWS de dicho recurso como parte del constructor de clases de cliente, tal y como se muestra aquí.

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

Uso del objeto de configuración global

Para establecer la región en tu JavaScript código, actualiza el objeto de configuración AWS.Config global como se muestra aquí.

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

Para obtener más información acerca de las regiones y los servicios disponibles actualmente en cada región, consulte Regiones y puntos de conexión de AWS en la Referencia general de AWS.

Uso de una variable de entorno

Puede establecer la región mediante la variable de entorno AWS_REGION. Si defines esta variable, el SDK la JavaScript lee y la usa.

Uso de un archivo de configuración compartido

Al igual que el archivo de credenciales compartidas le permite almacenar credenciales para que el SDK las use, puede mantener su región y otras opciones de configuración en un archivo compartido denominado config que el SDK utiliza. Si la variable de AWS_SDK_LOAD_CONFIG entorno se ha establecido en un valor verdadero, el SDK busca JavaScript automáticamente un config archivo cuando se carga. La ubicación donde guarde el archivo config depende de su sistema operativo:

  • Usuarios de Linux, macOS o Unix: ~/.aws/config

  • Usuarios de Windows: C:\Users\USER_NAME\.aws\config

Si todavía no tiene un archivo config compartido, puede crear uno en el directorio designado. En el siguiente ejemplo, el archivo config establece la región y el formato de salida.

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

Para obtener más información acerca del uso de archivos de configuración y de credenciales compartidos, consulte Carga de credenciales en Node.js desde el archivo de credenciales compartidas o Archivos de configuración y credenciales en la Guía del usuario de AWS Command Line Interface .

Orden de prioridad para establecer la región

El orden de prioridad para la configuración de una región es el siguiente:

  • Si se transfiere una región a un constructor de clase de cliente, se usa dicha región. De lo contrario, entonces...

  • Si se establece una región en el objeto de configuración global, se usa dicha región. De lo contrario, entonces...

  • Si la variable de entorno AWS_REGION es un valor truthy, se usa esa región. De lo contrario, entonces...

  • Si la variable de entorno AMAZON_REGION es un valor truthy, se usa esa región. De lo contrario, entonces...

  • Si la variable de entorno AWS_SDK_LOAD_CONFIG se establece en un valor truthy y el archivo de credenciales compartidas (~/.aws/credentials o la ruta indicada por AWS_SHARED_CREDENTIALS_FILE) contiene una región para el perfil configurado, se usa esa región. De lo contrario, entonces...

  • Si la variable de entorno AWS_SDK_LOAD_CONFIG se establece en un valor truthy y el archivo de configuración (~/.aws/config o la ruta indicada por AWS_CONFIG_FILE) contiene una región para el perfil configurado, se usa esa región.