Définissez la AWS région - AWS SDK for JavaScript

Le guide de API référence AWS SDK for JavaScript V3 décrit en détail toutes les API opérations de la AWS SDK for JavaScript version 3 (V3).

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.

Définissez la AWS région

Une AWS 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 création d'un client SDK de service dans le formulaire JavaScript afin que SDK celui-ci accède au service dans cette région. Certains services sont disponibles uniquement dans certaines régions.

Le SDK formulaire JavaScript ne sélectionne pas de région par défaut. Vous pouvez toutefois définir la AWS région à l'aide d'une variable d'environnement ou d'un config fichier de configuration partagé.

Dans un constructeur de classe client

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

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

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

Utiliser un fichier de configuration partagé

Tout comme le fichier d'informations d'identification partagé vous permet de stocker les informations d'identification à utiliser par leSDK, vous pouvez conserver votre AWS région et les autres paramètres de configuration dans un fichier partagé nommé config d'après le nom SDK à utiliser. Si la variable d'AWS_SDK_LOAD_CONFIGenvironnement est définie sur une valeur vraie, le SDK for 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 :

  • Utilisateurs de Linux, macOS ou Unix - ~/.aws/config

  • Utilisateurs de 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-west-2 output=json

Pour plus d'informations sur l'utilisation du partage config et credentials des fichiers, consultez la section Fichiers de configuration et d'informations d'identification partagés dans le Guide de référence des outils AWS SDKs et.

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

L'ordre de priorité pour le réglage des régions est le suivant :

  1. Si une région est transmise à un constructeur de classe client, cette région est utilisée.

  2. Si une région est définie dans la variable d'environnement, cette région est utilisée.

  3. Dans le cas contraire, la région définie dans le fichier de configuration partagé est utilisée.