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

Anunciamos el próximo fin del soporte para AWS SDK for JavaScript v2. Se recomienda que migre a AWS SDK for JavaScript v3. Para ver las fechas, los detalles adicionales y la información sobre cómo realizar la migración, consulte el anuncio enlazado.

Configuración de la región de AWS

Una región es un conjunto designado de recursos de AWS que están 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). La región se especifica al configurar el SDK para JavaScript para que el SDK obtenga acceso a los recursos de dicha 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 su código JavaScript, actualice el objeto de configuración global AWS.Config tal y 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 define esta variable, el SDK para JavaScript la lee y la utiliza.

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 entorno AWS_SDK_LOAD_CONFIG se establece en cualquier valor, el SDK para JavaScript busca automáticamente un archivo config 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 cualquier valor 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 cualquier valor 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.