AWS SDK for JavaScript v2 のサポート終了が間近に迫っていることが発表
AWS リージョンの設定
リージョンとは、同じ地域内にある AWS リソースの名前付きセットです。リージョンの例は us-east-1
です。これは、米国東部 (バージニア北部) リージョンです。SDK for JavaScript を設定するときにリージョンを指定して、SDK がそのリージョン内のリソースにアクセスできるようにします。 の一部のサービスは、特定のリージョンでのみ利用可能です。
SDK for JavaScript は、デフォルトではリージョンを選択しません。ただし、環境変数、共有 config
ファイル、またはグローバル設定オブジェクトを使用してリージョンを設定できます。
クライアントクラスコンストラクタ内
サービスオブジェクトをインスタンス化する場合、次に示すように、クライアントクラスコンストラクタの一部としてリソースの地域を指定することができます。
var s3 = new AWS.S3({apiVersion: '2006-03-01', region: 'us-east-1'});
グローバル設定オブジェクトの使用
JavaScript コードでリージョンを設定するには、ここに示すように AWS.Config
グローバル設定オブジェクトを更新します。
AWS.config.update({region: 'us-east-1'});
現在のリージョンと、各リージョンで利用可能なサービスの詳細については、「AWS 全般のリファレンス」の「AWS のリージョンとエンドポイント」を参照してください。
環境変数を使用する
AWS_REGION
環境変数を設定して、リージョンを設定できます。この変数を定義すると、SDK for JavaScript がそれを読み込み、使用します。
共有 Config ファイルの使用
共有認証情報ファイルで SDK で使用する認証情報を保存できるのと同じように、リージョンやその他の設定を 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-east-1 output=json
共有設定ファイルと認証情報ファイルの使用の詳細については、AWS Command Line Interfaceユーザーガイドの 共有認証情報ファイルから Node.js に認証情報をロードする設定ファイルと認証情報ファイルを参照してください。
リージョン設定の優先順位
リージョン設定の優先順位は以下のとおりです。
-
リージョンがクライアントクラスコンストラクタに渡された場合、そのリージョンが使用されます。そうでない場合は、次に、
-
グローバル設定オブジェクトにリージョンが設定されている場合は、そのリージョンが使用されます。そうでない場合は、次に、
-
AWS_REGION
環境変数が真の値である場合は、そのリージョンが使用されます。そうでない場合は、次に、 -
AMAZON_REGION
環境変数が真の値である場合は、そのリージョンが使用されます。そうでない場合は、次に、 -
AWS_SDK_LOAD_CONFIG
環境変数を任意の値に設定していて、共有認証情報ファイル (~/.aws/credentials
、またはAWS_SHARED_CREDENTIALS_FILE
に示されているパス) に設定済みプロファイルのリージョンが含まれている場合は、そのリージョンが使用されます。そうでない場合は、次に、 -
AWS_SDK_LOAD_CONFIG
環境変数を任意の値に設定していて、config ファイル (~/.aws/config
、またはAWS_CONFIG_FILE
に示されているパス) に設定済みプロファイルのリージョンが含まれている場合は、そのリージョンが使用されます。