AWS リージョンを設定する - AWS SDK for JavaScript

AWS SDK for JavaScript V3 API リファレンスガイドでは、 AWS SDK for JavaScript バージョン3 (V3) のすべての API オペレーションについて詳しく説明します。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS リージョンを設定する

AWS リージョンは、同じ地理的エリアにある AWS リソースの名前付きセットです。リージョンの例は us-east-1 です。これは、米国東部 (バージニア北部) リージョンです。SDK がその地域内のサービスにアクセスするように、SDK for JavaScript でサービスクライアントを作成するときに地域を指定します。 の一部のサービスは、特定のリージョンでのみ利用可能です。

SDK for JavaScript は、デフォルトではリージョンを選択しません。ただし、環境変数または共有設定configファイルを使用して AWS リージョンを設定できます。

クライアントクラスコンストラクタ内

サービスオブジェクトをインスタンス化するときは、次に示すように、クライアントクラスコンストラクタの一部としてそのリソースの AWS リージョンを指定できます。

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

環境変数を使用する

AWS_REGION 環境変数を設定して、リージョンを設定できます。この変数を定義すると、SDK for JavaScript がそれを読み込み、使用します。

共有 config ファイルを使用する

共有認証情報ファイルで SDK で使用する認証情報を保存できるのと同様に、 AWS リージョンやその他の設定は、SDK config が使用する という名前の共有ファイルに保持できます。AWS_SDK_LOAD_CONFIG 環境変数が真の値に設定されている場合、SDK for JavaScript はロード時にconfigファイルを自動的に検索します。config ファイルを保存する場所はオペレーティングシステムによって異なります。

  • Linux、macOS、またはUnix ユーザー-~/.aws/config

  • Windows ユーザー-C:\Users\USER_NAME\.aws\config

共有 config ファイルがまだない場合は、指定されたディレクトリに 1 つ作成することができます。次の例では、config ファイルはリージョンと出力形式の両方を設定します。

[default] region=us-west-2 output=json

共有された config および credentials ファイルの使用についての詳細は、「AWS SDK とツールのリファレンスガイド」の「共有設定ファイルおよび認証情報ファイル」を参照してください。

地域設定の優先順位

地域設定の優先順位は以下の通りです。

  1. リージョンがクライアントクラスコンストラクタに渡された場合、そのリージョンが使用されます。

  2. 環境変数に地域が設定されている場合は、その地域が使用されます。

  3. それ以外の場合は、共有 config ファイルで定義された地域が使用されます。