AWS CDK の開始方法 - AWS クラウド開発キット (AWS CDK) v2

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

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

AWS CDK の開始方法

AWS CDK コマンドラインインターフェイス (AWS CDK CLI) をインストールして設定することで、 AWS クラウド開発キット (AWS CDK) の使用を開始します。次に、CDK CLI を使用して最初の CDK アプリケーションを作成し、 AWS 環境をブートストラップして、アプリケーションをデプロイします。

前提条件

AWS CDK の使用を開始する前に、すべての前提条件を完了してください。これらの前提条件は、プログラミングを初めて AWS 使用する場合や、プログラミングを初めて使用する場合に必要です。手順については、AWS 「CDK の前提条件」を参照してください。

AWS CDK の概要を理解しておくことをお勧めします。詳細については、AWS 「CDK とは」およびAWS 「CDK のコア概念を学ぶ」を参照してください。

AWS CDK CLI のインストール

Node パッケージマネージャーを使用して CDK CLI をインストールします。次のコマンドを使用してグローバルにインストールすることをお勧めします。

$ npm install -g aws-cdk

CDK CLI の特定のバージョンをインストールするには、次のコマンド構造を使用します。

$ npm install -g aws-cdk@X.YY.Z

AWS CDK の複数のバージョンを使用する場合は、個々の CDK プロジェクトに CDK CLI の一致するバージョンをインストールすることを検討してください。これを行うには、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 をインストールしたら、それを使用してローカルマシンでアプリケーションを開発できます。アプリケーションのデプロイ AWSなどの を操作するには、開始したアクションを実行するアクセス許可を持つセキュリティ認証情報をローカルマシンに設定する必要があります。

ローカルマシンでセキュリティ認証情報を設定するには、 CLI AWS を使用します。セキュリティ認証情報の設定方法は、ユーザーの管理方法によって異なります。手順については、 AWS 「 コマンドラインインターフェイスユーザーガイド」の「認証とアクセスの認証情報」を参照してください。

CDK CLI は、 AWS CLI で設定したセキュリティ認証情報を自動的に使用します。例えば、IAM Identity Center ユーザーの場合、aws configure sso コマンドを使用してセキュリティ認証情報を設定できます。IAM ユーザーの場合、aws configure コマンドを使用できます。 AWS CLI は、ローカルマシンでセキュリティ認証情報を設定し、必要な情報を configおよび credentials ファイルに保存する手順を説明します。次に、 でアプリケーションをデプロイするなど、CDK CLI を使用するとcdk deploy、CDK CLI は設定されたセキュリティ認証情報を使用します。

CLI と同様に、CDK AWS CLI はデフォルトでdefaultプロファイルを使用します。CDK CLI --profileオプションを使用してプロファイルを指定できます。CDK CLI でセキュリティ認証情報を使用する方法の詳細については、AWS 「CDK CLI のセキュリティ認証情報を設定する」を参照してください。

(オプション) 追加の AWS CDK ツールをインストールする

AWS Toolkit for Visual Studio Code は、アプリケーションの作成、デバッグ、デプロイVisual Studio Codeに役立つ のオープンソースプラグインです AWS。ツールキットは、 AWS CDK アプリケーションを開発するための統合されたエクスペリエンスを提供します。これには、 AWS CDK プロジェクトを一覧表示し、 AWS CDK アプリケーションのさまざまなコンポーネントを参照する CDK Explorer 機能が含まれています。手順については、以下を参照してください。

最初の CDK アプリの作成

これで、最初の AWS CDK アプリを作成して CDK の使用を開始する準備が整いました。手順については、「チュートリアル: 最初の AWS CDK アプリを作成する」を参照してください。