AWS CDK バージョニング - AWS Cloud Development Kit (AWS CDK) v2

これは AWS CDK v2 開発者ガイドです。古い CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

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

AWS CDK バージョニング

このトピックでは、 がバージョニング AWS Cloud Development Kit (AWS CDK) を処理する方法に関するリファレンス情報を提供します。

バージョン番号は、メジャー .minor .patch の 3 つの数値バージョン部分で構成され、セマンティックバージョニングモデルに厳密に準拠しています。つまり、安定した APIsされます。

マイナーリリースとパッチリリースには下位互換性があります。同じメジャーバージョンを持つ以前のバージョンで記述されたコードは、同じメジャーバージョン内の新しいバージョンにアップグレードできます。また、ビルドと実行が継続され、同じ出力が生成されます。

AWS CDKCLI 互換性

AWS CDK CLI は常に、意味的に下位または等しいバージョン番号のコンストラクトライブラリと互換性があります。したがって、同じメジャーバージョン内で常に安全に を AWS CDK CLIアップグレードできます。

AWS CDK CLI は、意味的に上位のバージョンのコンストラクトライブラリと常に互換性があるわけではありません。互換性は、同じクラウドアセンブリスキーマバージョンが 2 つのコンポーネントで使用されているかどうかによって異なります。 AWS CDK フレームワークは、合成中にクラウドアセンブリを生成し、 はそれをデプロイに AWS CDK CLI消費します。クラウドアセンブリの形式を定義するスキーマは厳密に指定され、バージョン管理されます。

AWS 特定のクラウドアセンブリスキーマバージョンを使用してライブラリを構築することは、そのスキーマバージョン 以降を使用するバージョンと AWS CDK CLI互換性があります。これには、 AWS CDK CLI特定のコンストラクトライブラリリリースより前の のリリースが含まれる場合があります。

コンストラクトライブラリに必要なクラウドアセンブリのバージョンが、 でサポートされているバージョンと互換性がない場合 AWS CDK CLI、次のようなエラーメッセージが表示されます。

Cloud assembly schema version mismatch: Maximum schema version supported is 3.0.0, but found 4.0.0.
    Please upgrade your CLI in order to interact with this app.

このエラーを AWS CDK CLI解決するには、 を必要なクラウドアセンブリバージョンと互換性のあるバージョンに更新するか、利用可能な最新バージョンに更新します。代替方法 (アプリケーションが使用するコンストラクトライブラリモジュールをダウングレードする) は、一般的にお勧めしません。

注記

クラウドアセンブリスキーマの詳細については、「Cloud Assembly Versioning」を参照してください。

AWS ライブラリのバージョニングを構築する

AWS Construct Library のモジュールは、概念から成熟した API に進化するにつれて、さまざまな段階を移動します。ステージによって、 の後続のバージョンでさまざまな程度の API 安定性が提供されます AWS CDK。

メイン AWS CDK ライブラリ の APIs aws-cdk-libは安定しており、ライブラリは完全に意味的にバージョン管理されています。このパッケージには、すべての AWS サービスと、安定しているすべての上位レベル AWS CloudFormation (L2 および L3) モジュール用の (L1) コンストラクトが含まれています。( Appや などのコア CDK クラスも含まれていますStack)。APIs は、CDK の次のメジャーリリースまで、このパッケージから削除されません (ただし、廃止される可能性があります)。個々の API に重大な変更が加えられることはありません。重大な変更が必要な場合は、まったく新しい API が追加されます。

既に組み込まれているサービスの開発中の新しい APIs aws-cdk-libは、 BetaN サフィックスを使用して識別されます。 は 1 からN始まり、新しい API への重大な変更があるたびに増加します。 BetaNAPIs は削除されることはなく、非推奨にすぎないため、既存のアプリは引き続き の新しいバージョンで動作しますaws-cdk-lib。API が安定していると見なされると、 サフィックスのない新しい API BetaN が追加されます。

以前は L1 APIs しか持っていなかった AWS サービスに対して上位レベルの (L2 または L3) APIsの開発が開始されると、これらの APIsは最初は別のパッケージに配布されます。このようなパッケージの名前には「アルファ」サフィックスがあり、そのバージョンは、 alphaサブバージョンと互換性のある最初のバージョンと一致しaws-cdk-libます。モジュールが意図したユースケースをサポートすると、その APIsが に追加されますaws-cdk-lib

言語バインディングの安定性

時間の経過とともに、追加のプログラミング言語 AWS CDK のサポートが に追加される可能性があります。すべての言語で説明されている API は同じですが、API の表現方法は言語によって異なり、言語サポートの進化に伴って変更される可能性があります。このため、言語バインディングは、本番環境での使用準備が整っていると見なされるまで、しばらく実験的と見なされます。

Language Stability
TypeScript Stable
JavaScript Stable
Python Stable
Java Stable
C#/.NET Stable
Go Stable