コンテキスト変数値の保存と取得 - AWS クラウド開発キット (AWS CDK) v2
コンテキスト変数の指定コンテキスト変数値の取得

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

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

コンテキスト変数値の保存と取得

AWS Cloud Development Kit (AWS CDK) CLI の使用または cdk.json ファイル内でコンテキスト変数を指定できます。次に、TryGetContext メソッドを使用して値を取得します。

コンテキスト変数の指定

AWS CDK CLI コマンドの一部または cdk.json 内のいずれかとしてコンテキスト変数を指定できます。

コマンドラインのコンテキスト変数を作成するには、次の例で示すように、--context (-c) オプションを使用します。

cdk synth -c bucket_name=mygroovybucket

cdk.json ファイルで同じコンテキスト変数および値を指定するには、次のコードを使用します。

{
  "context": {
    "bucket_name": "myotherbucket"
  }
}

AWS CDK CLI および cdk.json ファイルの両方を使用してコンテキスト変数を指定する場合、AWS CDK CLI 値が優先されます。

コンテキスト変数値の取得

アプリでコンテキスト変数の値を取得するには、TryGetContext メソッドをコンストラクトのコンテキストで使用します。(つまり、this または Python の self が何らかのコンストラクトのインスタンスのとき)。

この例では、bucket_name コンテキスト変数の値を取得します。要求された値が定義されていない場合、TryGetContext は例外を発生させるのではなく、undefined (Python では None、Java および C# では null、Go では nil) を返します。

例
TypeScript
const bucket_name = this.node.tryGetContext('bucket_name');
JavaScript
const bucket_name = this.node.tryGetContext('bucket_name');
Python
bucket_name = self.node.try_get_context("bucket_name")
Java
String bucketName = (String)this.getNode().tryGetContext("bucket_name");
C#
var bucketName = this.Node.TryGetContext("bucket_name");

コンストラクトのコンテキスト外では、このようにアプリオブジェクトからコンテキスト変数にアクセスできます。

例
TypeScript
const app = new cdk.App();
const bucket_name = app.node.tryGetContext('bucket_name')
JavaScript
const app = new cdk.App();
const bucket_name = app.node.tryGetContext('bucket_name');
Python
app = cdk.App()
bucket_name = app.node.try_get_context("bucket_name")
Java
App app = App();
String bucketName = (String)app.getNode().tryGetContext("bucket_name");
C#
app = App();
var bucketName = app.Node.TryGetContext("bucket_name");

コンテキスト変数の使用の詳細については、「コンテキスト値と AWS CDK」を参照してください。