これは AWS CDK v2 開発者ガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。
AWS CDK の使用を開始する
AWS CDK コマンドラインインターフェイス (AWS CDK CLI) をインストールして設定することで、AWS Cloud Development Kit (AWS CDK) の使用を開始します。次に、CDK CLI を使用して最初の CDK アプリを作成し、AWS 環境をブートストラップしてアプリケーションをデプロイします。
前提条件
AWS CDK の使用を開始する前に、前提条件をすべて完了させてください。これらの前提条件は、AWS またはプログラミングが初めてのユーザーには必要です。手順については、「AWS CDK 前提条件」を参照してください。
AWS CDK とは何かについての基本的な理解を得ることをお勧めします。詳細については、「AWS CDK とは」および「AWS CDK のコアコンセプトの説明」を参照してください。
AWS CDK CLI のインストール
Node Package Manager を使用して CKD CLI をインストールします。次のコマンドを使用してグローバルにインストールすることをお勧めします。
$ npm install -g aws-cdk
CDK CLI の特定のバージョンをインストールするには、次のコマンド構造を使用します。
$ npm install -g aws-cdk@X.YY.Z
AWS CDK の複数のバージョンを使用する場合、CDK CLI と一致するバージョンを個々の CDK プロジェクトにインストールすることを検討してください。これを行うには、npm install コマンドから -g オプションを削除します。次に、npx aws-cdk を使用して CDK CLI を呼び出します。ローカルバージョンが存在する場合、実行されます。それ以外の場合、グローバルにインストールされたバージョンが使用されます。
- CDK CLI のインストールのトラブルシューティング
-
アクセス許可エラーが発生し、システムで管理者アクセス権がある場合、次の内容を実行します。
$ sudo npm install -g aws-cdkエラーメッセージが表示された場合、次の内容を実行して CDK CLI をアンインストールしてみてください。
$ npm uninstall -g aws-cdk次に、ステップを繰り返して CDK CLI を再インストールします。
CDK CLI の正常なインストールの確認
次のコマンドを実行し、正常なインストールを確認します。AWS CDK CLI はバージョン番号を出力します。
$ cdk --version
AWS CDK CLI を設定する
CDK CLI をインストールしたら、CDK の使用を開始してローカルマシンでアプリケーションを開発できます。アプリケーションのデプロイなど、AWS を操作するには、開始したアクションを実行するアクセス許可を持つセキュリティ認証情報をローカルマシンに設定する必要があります。
ローカルマシンでセキュリティ認証情報を設定するには、AWS CLI を使用します。セキュリティ認証情報の設定方法は、ユーザーの管理方法によって異なります。手順については、「AWS コマンドラインインターフェイスユーザーガイド」の「認証とアクセスの認証情報」を参照してください。
CDK CLI は、AWS CLI で設定したセキュリティ認証情報を自動的に使用します。例えば、IAM Identity Center ユーザーの場合、aws configure sso コマンドを使用してセキュリティ認証情報を設定できます。IAM ユーザーの場合、aws configure コマンドを使用できます。AWS CLI では、ローカルマシンでセキュリティ認証情報を設定し、必要な情報を config および credentials ファイルに保存する方法について説明します。次に、cdk deploy を使用してアプリケーションをデプロイするなど、CDK CLI を使用するとき、CDK CLI は設定したセキュリティ認証情報を使用します。
AWS CLI と同様に、CDK CLI はデフォルトで default プロファイルを使用します。CDK CLI の --profile オプションを使用してプロファイルを指定できます。CDK CLI を使用してセキュリティ認証情報を使用する方法の詳細については、「AWS CDK CLI のセキュリティ認証情報を設定する」を参照してください。
(オプション) 追加の AWS CDK ツールのインストール
AWS Toolkit for Visual Studio Code
最初の CDK アプリの作成
最初の CDK アプリを作成し、AWS CDK の使用を開始する準備ができました。手順については、「チュートリアル: 最初の AWS CDK アプリの作成」を参照してください。
