Configuration de la AWS région - AWS SDK for JavaScript

Nous avons annoncé la sortie end-of-support de la AWS SDK for JavaScript v2. Nous vous recommandons de migrer vers la AWS SDK for JavaScript version 3. Pour les dates, les détails supplémentaires et les informations sur la façon de migrer, reportez-vous à l'annonce associée.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configuration de la AWS région

Une région est un ensemble nommé de AWS ressources dans la même zone géographique. Un exemple de région est us-east-1 la région de l'est des États-Unis (Virginie du Nord). Vous spécifiez une région lors de la configuration du SDK JavaScript afin que le SDK accède aux ressources de cette région. Certains services sont disponibles uniquement dans certaines régions.

Le SDK pour JavaScript ne sélectionne pas de région par défaut. Toutefois, vous pouvez définir la région à l'aide d'une variable d'environnement, un fichier config partagé ou l'objet de configuration globale.

Dans un constructeur de classe client

Lorsque vous instanciez un objet de service, vous pouvez spécifier la région pour cette ressource dans le cadre du constructeur de classe client, comme illustré ici.

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

Utilisation de l'objet de configuration globale

Pour définir la région dans votre JavaScript code, mettez à jour l'objet de configuration AWS.Config globale comme indiqué ici.

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

Pour plus d'informations sur les régions actuelles et les services disponibles dans chaque région, voir AWS Régions et points de terminaison dans le Références générales AWS.

À l'aide d'une variable d'environnement

Vous pouvez définir la région à l'aide de la variable d'environnement AWS_REGION. Si vous définissez cette variable, le SDK for la JavaScript lit et l'utilise.

À l'aide d'un fichier de configuration partagé

De même que le fichier d'informations d'identification partagé permet de stocker les informations d'identification pour qu'elles soient utilisées par le kit SDK, vous pouvez conserver les paramètres des régions et autres paramètres de configuration dans un fichier partagé nommé config qui est utilisé par les kits SDK. Si la variable d'AWS_SDK_LOAD_CONFIGenvironnement a été définie sur une valeur quelconque, le SDK recherche JavaScript automatiquement un config fichier lors de son chargement. L'emplacement d'enregistrement du fichier config dépend de votre système d'exploitation :

  • Sous Linux, macOS ou Unix : ~/.aws/config

  • Sous Windows : C:\Users\USER_NAME\.aws\config

Si vous n'avez pas encore de fichier config partagé, vous pouvez en créer un dans le répertoire désigné. Dans l'exemple suivant, le fichier config définit la région et le format de sortie.

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

Pour plus d'informations sur l'utilisation de fichiers de configuration et d'informations d'identification partagés, consultez Chargement des informations d'identification dans Node.js à partir du fichier d'informations d'identification partagé la section Fichiers de configuration et d'identification dans le guide de l'AWS Command Line Interface utilisateur.

Ordre de priorité pour définir la région

L'ordre de priorité pour définir la région est le suivant :

  • Si une région est transmise à un constructeur de classe client, cette région est utilisée. Si ce n'est pas le cas, alors...

  • Si une région est définie sur l'objet de configuration globale, cette région est utilisée. Si ce n'est pas le cas, alors...

  • Si la variable d'environnement AWS_REGION est une valeur truthy, cette région est utilisée. Si ce n'est pas le cas, alors...

  • Si la variable d'environnement AMAZON_REGION est une valeur truthy, cette région est utilisée. Si ce n'est pas le cas, alors...

  • Si la variable d'AWS_SDK_LOAD_CONFIGenvironnement est définie sur une valeur quelconque et que le fichier d'informations d'identification partagé (~/.aws/credentialsou le chemin indiqué parAWS_SHARED_CREDENTIALS_FILE) contient une région pour le profil configuré, cette région est utilisée. Si ce n'est pas le cas, alors...

  • Si la variable d'AWS_SDK_LOAD_CONFIGenvironnement est définie sur une valeur quelconque et que le fichier de configuration (~/.aws/configou le chemin indiqué parAWS_CONFIG_FILE) contient une région pour le profil configuré, cette région est utilisée.