AWS CDK v1 から AWS CDK v2 への移行

npm install または yarn install

npm install または yarn install

python -m pip install -r requirements.txt

mvn package

dotnet restore

go get

アプリケーション

CDK アプリの場合、次のように package.json を更新します。v1 形式の個々の安定モジュールへの依存関係を削除し、アプリケーションに必要な aws-cdk-lib の最低バージョンを確立します (ここでは 2.0.0)。

実験コンストラクトは、alpha とアルファバージョン番号で終わる名前を持つ個別で独立したバージョニングパッケージで提供されます。アルファバージョン番号は、互換性のある aws-cdk-lib の最初のリリースに対応します。こちらでは、 v2.0.0-alpha.1 に aws-codestar を固定しました。

{
  "dependencies": {
    "aws-cdk-lib": "^2.0.0",
    "@aws-cdk/aws-codestar-alpha": "2.0.0-alpha.1",
    "constructs": "^10.0.0"
  }
}

コンストラクトライブラリ

コンストラクトライブラリの場合、アプリケーションに必要な aws-cdk-lib の最低バージョンを確立し (ここでは 2.0.0)、package.json を次のように更新します。

aws-cdk-lib は、ピア依存関係およびデベロッパー依存関係の両方として表示されることに注意してください。

{
  "peerDependencies": {
    "aws-cdk-lib": "^2.0.0",
    "constructs": "^10.0.0"
  },
  "devDependencies": {
    "aws-cdk-lib": "^2.0.0",
    "constructs": "^10.0.0",
    "typescript": "~3.9.0"
  }
}

ライブラリとアプリの両方

npm install または yarn install を実行し、新しい依存関係をインストールします。

インポートを変更し、新しい constructs モジュール、aws-cdk-lib の最上位レベルから App および Stack などのコアタイプ、aws-cdk-lib の名前空間から使用するサービスの安定したコンストラクトライブラリモジュールから Construct をインポートします。

import { Construct } from 'constructs';
import { App, Stack } from 'aws-cdk-lib';                 // core constructs
import { aws_s3 as s3 } from 'aws-cdk-lib';               // stable module
import * as codestar from '@aws-cdk/aws-codestar-alpha';  // experimental module

次のように package.json を更新します。v1 形式の個々の安定モジュールへの依存関係を削除し、アプリケーションに必要な aws-cdk-lib の最低バージョンを確立します (ここでは 2.0.0)。

実験コンストラクトは、alpha とアルファバージョン番号で終わる名前を持つ個別で独立したバージョニングパッケージで提供されます。アルファバージョン番号は、互換性のある aws-cdk-lib の最初のリリースに対応します。こちらでは、 v2.0.0-alpha.1 に aws-codestar を固定しました。

{
  "dependencies": {
    "aws-cdk-lib": "^2.0.0",
    "@aws-cdk/aws-codestar-alpha": "2.0.0-alpha.1",
    "constructs": "^10.0.0"
  }
}

npm install または yarn install を実行し、新しい依存関係をインストールします。

アプリのインポートを変更し、次の内容を実行します。

const { Construct } = require('constructs');
const { App, Stack } = require('aws-cdk-lib');              // core constructs
const s3 = require('aws-cdk-lib').aws_s3;                   // stable module
const codestar = require('@aws-cdk/aws-codestar-alpha');    // experimental module

setup.py の requirements.txt または install_requires の定義を次のように更新します。v1 形式の個々の安定モジュールへの依存関係を削除します。

実験コンストラクトは、alpha とアルファバージョン番号で終わる名前を持つ個別で独立したバージョニングパッケージで提供されます。アルファバージョン番号は、互換性のある aws-cdk-lib の最初のリリースに対応します。こちらでは、aws-codestar を v2.0.0alpha1 に固定しました。

install_requires=[
     "aws-cdk-lib>=2.0.0",
     "constructs>=10.0.0",
     "aws-cdk.aws-codestar-alpha>=2.0.0alpha1",
     # ...
],

アプリのインポートを変更し、次の内容を実行します。

from constructs import Construct
from aws_cdk import App, Stack                    # core constructs
from aws_cdk import aws_s3 as s3                  # stable module
import aws_cdk.aws_codestar_alpha as codestar     # experimental module

# ...

class MyConstruct(Construct):
    # ...

class MyStack(Stack):
    # ...

s3.Bucket(...)

pom.xml で、安定したモジュールのsoftware.amazon.awscdk依存関係をすべて削除し、software.constructs (Construct の場合) および software.amazon.awscdk の依存関係に置き換えます。

実験コンストラクトは、alpha とアルファバージョン番号で終わる名前を持つ個別で独立したバージョニングパッケージで提供されます。アルファバージョン番号は、互換性のある aws-cdk-lib の最初のリリースに対応します。こちらでは、 v2.0.0-alpha.1 に aws-codestar を固定しました。

<dependency>
    <groupId>software.amazon.awscdk</groupId>
    <artifactId>aws-cdk-lib</artifactId>
    <version>2.0.0</version>
</dependency><dependency>
    <groupId>software.amazon.awscdk</groupId>
    <artifactId>code-star-alpha</artifactId>
    <version>2.0.0-alpha.1</version>
</dependency>
<dependency>
    <groupId>software.constructs</groupId>
    <artifactId>constructs</artifactId>
    <version>10.0.0</version>
</dependency>

mvn package を実行して新しい依存関係をインストールします。

コードを変更し、次の内容を実行します。

import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.App;
import software.amazon.awscdk.services.s3.Bucket;
import software.amazon.awscdk.services.codestar.alpha.GitHubRepository;

C# CDK アプリケーションの依存関係をアップグレードする最も簡単な方法は、.csproj ファイルを手動で編集することです。安定した Amazon.CDK.* パッケージリファレンスをすべて削除し、Amazon.CDK.Lib および Constructs パッケージへの参照に置き換えます。

実験コンストラクトは、alpha とアルファバージョン番号で終わる名前を持つ個別で独立したバージョニングパッケージで提供されます。アルファバージョン番号は、互換性のある aws-cdk-lib の最初のリリースに対応します。こちらでは、 v2.0.0-alpha.1 に aws-codestar を固定しました。

<PackageReference Include="Amazon.CDK.Lib" Version="2.0.0" />
<PackageReference Include="Amazon.CDK.AWS.Codestar.Alpha" Version="2.0.0-alpha.1" />
<PackageReference Include="Constructs" Version="10.0.0" />

dotnet restore を実行して新しい依存関係をインストールします。

ソースファイルのインポートを次のように変更します。

using Constructs;                   // for Construct class
using Amazon.CDK;                   // for core classes like App and Stack
using Amazon.CDK.AWS.S3;            // for stable constructs like Bucket
using Amazon.CDK.Codestar.Alpha;    // for experimental constructs

go get を発行し、依存関係を最新バージョンに更新してプロジェクトの .mod ファイルを更新します。