AWS CDK の環境 - AWS クラウド開発キット (AWS CDK) v2
詳細

これは AWS CDK v2 デベロッパーガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

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

AWS CDK の環境

環境は、AWS Cloud Development Kit (AWS CDK) スタックをデプロイする AWS アカウントと AWS リージョンで構成されます。

AWS アカウント

AWS アカウントを作成するとアカウント ID が与えられます。この ID は、012345678901 のような、ユーザーのアカウントを一意に識別する 12 桁の数字です。詳細については、「AWS アカウント管理リファレンスガイド」の「AWS アカウント識別子の表示」を参照してください。

AWS リージョン

AWS リージョンは、地理的位置とリージョンのアベイラビリティーゾーンを表す数値の組み合わせを使用して命名されます。例えば、us-east-1 は米国東部 (バージニア北部) リージョンのアベイラビリティーゾーンを表します。AWS リージョンの詳細については、「リージョンとアベイラビリティーゾーン」を参照してください。リージョンコードのリストについては、「AWS 全般のリファレンス」リファレンスガイドの「リージョンエンドポイント」を参照してください。

AWS CDK は、認証情報と設定ファイルから環境を特定できます。これらのファイルは、AWS コマンドラインインターフェイス (AWS CLI) を使用して作成および管理できます。これらのファイルの基本的な例を以下に示します。

認証情報ファイル: 
[default]
aws_access_key_id=ASIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
aws_session_token = IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE

[user1]
aws_access_key_id=ASIAI44QH8DHBEXAMPLE
aws_secret_access_key=je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY
aws_session_token = fcZib3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE
[Configuration file] (設定ファイル) – 
[default]
region=us-west-2
output=json

[profile user1]
region=us-east-1
output=text

これらのファイルからの環境情報は、CDK が提供する環境変数を介して、CDK コード内に渡されます。cdk deploy などの CDK CLI コマンドを実行する際は、環境情報を収集するために、認証情報と設定ファイルからプロファイルを提供します。

CDK コードでこれらの環境変数を指定する場合の例を以下に示します。

new MyDevStack(app, 'dev', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
}});

以下は、--profile オプションを使用して、user1 プロファイルに関連付けられた値を、認証情報と設定ファイルから CDK CLI に渡す場合の例です。これらのファイルからの値は、環境変数に渡されます。

$ cdk deploy <myStack> --profile <user1>

認証情報と設定ファイルの値を使用する代わりに、CDK コード内で環境値をハードコーディングすることもできます。以下に例を示します。

const envEU = { account: '238383838383', region: 'eu-west-1' };
const envUSA = { account: '837873873873', region: 'us-west-2' };

new MyFirstStack(app, 'first-stack-us', { env: envUSA });
new MyFirstStack(app, 'first-stack-eu', { env: envEU });

詳細

AWS CDK で環境の使用を開始するには、「AWS CDK で使用する環境を設定する」を参照してください。