CDK Toolkit Library を使用してプログラムによるアクションを実行する - AWS クラウド開発キット (AWS CDK) v2
CDK Toolkit Library についてCDK Toolkit Library を使用するタイミングの選択CDK Toolkit Library の使用次のステップ詳細はこちら

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

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

CDK Toolkit Library を使用してプログラムによるアクションを実行する

CDK Toolkit Library について

CDK Toolkit Library を使用すると、CLI コマンドを使用する代わりに、コードを使用してプログラムで CDK アクションを実行できます。このライブラリを使用して、カスタムツールの作成、特殊な CLI アプリケーションの構築、開発ワークフローへの CDK 機能の統合を行うことができます。

プログラムによる制御でインフラストラクチャのライフサイクルを管理する

CDK Toolkit Library には、次の CDK アクション用のプログラムインターフェイスが用意されています。

  • Synthesis - Generate AWS CloudFormation テンプレートとデプロイアーティファクト。

  • デプロイ - CloudFormation テンプレートを使用してインフラストラクチャをプロビジョニングまたは更新します。

  • リスト - スタックとその依存関係に関する情報を表示します。

  • 監視 - CDK アプリのローカル変更をモニタリングします。

  • ロールバック - スタックを最後の安定状態に戻します。

  • 破棄 - CDK スタックと関連するリソースを削除します。

インフラストラクチャ管理の強化とカスタマイズ

  • コードによる制御 - インフラストラクチャ管理をアプリケーションに直接統合し、応答性の高いデプロイパイプラインを構築します。

  • クラウドアセンブリの管理 - デプロイ前にインフラストラクチャ定義を作成、検査、変換します。

  • デプロイのカスタマイズ - 要件に合わせてパラメータ、ロールバック動作、モニタリングを設定します。

  • エラーを正確に処理する - 詳細な診断情報を使用して構造化されたエラー処理を実装します。

  • コミュニケーションのカスタマイズ - カスタム進行状況インジケータを設定し、IoHost実装を通じてログ記録を行います。

  • と AWS の接続 - プロファイル、リージョン、認証フローをプログラムで設定します。

CDK Toolkit Library を使用するタイミングの選択

CDK Toolkit Library は、以下が必要な場合に特に役立ちます。

  • CI/CD パイプラインの一部としてインフラストラクチャのデプロイを自動化します。

  • 組織のニーズに合わせたカスタムデプロイツールを構築します。

  • CDK アクションを既存のアプリケーションまたはプラットフォームに統合します。

  • カスタム検証または承認ステップを使用して、特殊なデプロイワークフローを作成します。

  • 複数の環境に高度なインフラストラクチャ管理パターンを実装します。

CDK Toolkit Library の使用

次の例は、CDK Toolkit Library を使用してシンプルな S3 バケットを作成してデプロイする方法を示しています。

// Import required packages
import { Toolkit } from '@aws-cdk/toolkit-lib';
import { App, Stack } from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';

// Create and configure the CDK Toolkit
const toolkit = new Toolkit();

// Create a cloud assembly source with an inline app
const cloudAssemblySource = await toolkit.fromAssemblyBuilder(async () => {
   const app = new App();
   const stack = new Stack(app, 'SimpleStorageStack');

   // Create an S3 bucket in the stack
   new s3.Bucket(stack, 'MyFirstBucket', {
      versioned: true
   });

   return app.synth();
});

// Deploy the stack
await toolkit.deploy(cloudAssemblySource);
次にできること

  • デプロイの自動化 - デプロイをプログラムでトリガーし、デプロイ前後のステップを追加します。

  • システムとの統合 - CI/CD ワークフロー、カスタムツール、モニタリングソリューションに接続します。

  • デプロイの詳細を制御する - スタック選択とマルチ環境デプロイの詳細なオプションを設定します。

  • 信頼性の向上 - 本番環境対応のエラー処理とデプロイの進行状況の追跡を実装します。

次のステップ

CDK Toolkit Library の使用を開始するには、「CDK Toolkit Library の開始方法」を参照してください。

詳細はこちら

CDK Toolkit Library の詳細については、以下を参照してください。