チュートリアル: 組み合わせ可能な PDK ブループリントを使用したフルスタックアプリケーションの作成

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. CodeCatalyst コンソールで、プロジェクトを作成するスペースに移動します。

3. スペースダッシュボードで、[プロジェクトの作成] を選択します。

4. [ブループリントから始める] を選択します。

5. [PDK - モノレポ] ブループリントを選択し、[次へ] を選択します。

6. [プロジェクトに名前を付ける] で、プロジェクトに割り当てる名前と、関連するリソース名を入力します。名前はスペース内で一意でなければなりません。

7. [プロジェクトのリソース] で、以下を実行します。

   1. [プライマリプログラミング言語] で、プロジェクトコードを開発する言語を選択します。TypeScript、Java、または Python から選択できます。

   2. [コード設定] を選択します。

   3. [ソースリポジトリ] テキスト入力フィールドに、ソースリポジトリの名前を入力します。これにより、新しいリポジトリが作成されるか、既存のリンクされたリポジトリから該当するものが選択されます。既存のリポジトリは空である必要があります。詳細については、「ソースリポジトリをリンクする」を参照してください。

   4. (オプション) [パッケージマネージャー] ドロップダウンメニューから、パッケージマネージャーを選択します。これは、[プライマリプログラミング言語] として TypeScript を選択した場合にのみ必要です。

8. (オプション) 選択したプロジェクトパラメータに基づいて生成されるコードをプレビューするには、[プロジェクトプレビューの生成] から [コードを表示] を選択します。

9. (オプション) ブループリントのカードから [詳細を表示] を選択すると、ブループリントのアーキテクチャの概要、必要な接続とアクセス許可、ブループリントで作成されるリソースの種類など、そのブループリントに関する具体的な情報が表示されます。

10. [プロジェクトを作成] を選択してモノレポプロジェクトを作成します。作成されたルートレベルのプロジェクトでは、モノレポ内のプロジェクト間の相互依存関係の管理と、ビルドキャッシュと依存関係の管理が行われます。

    プロジェクトのブループリントの詳細については、「CodeCatalyst ブループリントを使用した包括的なプロジェクトの作成」を参照してください。

1. モノレポプロジェクトのナビゲーションペインで [ブループリント] を選択し、[ブループリントを追加] を選択します。

2. [PDK - 型安全 API] ブループリントを選択し、[次へ] を選択します。

3. [ブループリントを構成] で、ブループリントのパラメータを設定します。

   • [モデル言語] で、API モデルを定義する言語を選択します。

   • [名前空間] テキスト入力フィールドに、API の名前空間を入力します。

   • [API 名] テキスト入力フィールドに、API の名前を入力します。

   • [CDK 言語] で、API をデプロイするための CDK インフラストラクチャを記述する際に使用する任意の言語を選択します。

   • [ハンドラー言語] ドロップダウンメニューを選択し、API オペレーションのハンドラーを実装する言語を選択します (複数可)。

   • [ドキュメントの形式] ドロップダウンメニューを選択し、API ドキュメントの生成に使用する形式を選択します (複数可)。

4. [コード変更] タブで、変更案を確認します。プルリクエストに表示される差異は、そのプルリクエストが作成された時点におけるプロジェクトへの変更案を示しています。

5. ブループリントの適用時に反映される変更案に問題がなければ、[ブループリントを追加] を選択します。

   プルリクエストを作成したら、コメントを追加できます。コメントは、プルリクエスト、またはファイルの個々の行、およびプルリクエスト全体に追加できます。ファイルなどのリソースへのリンクは、@ 記号に続いてファイルの名前を付けることで追加できます。

   注記

   プルリクエストが承認され、マージされるまで、ブループリントは適用されません。詳細については、「プルリクエストのレビュー」および「プルリクエストをマージする」を参照してください。

6. [ステータス] 列から、[PDK - 型安全 API] ブループリントの行に対して [保留中のプルリクエスト] を選択し、未解決のプルリクエストのリンクを選択します。

7. [マージ] を選択し、優先するマージ戦略を選択した後、[マージ] を選択して、適用されたブループリントの変更を組み込みます。

   プルリクエストがマージされると、モノレポプロジェクト内に新しいフォルダ packages/apis/mypdkapi が生成されます。このフォルダには、設定された型安全 API に関連するすべてのソースコードが含まれます。

8. ナビゲーションペインで [ブループリント] を選択し、[PDK - 型安全 API] の [ステータス] が [最新] と表示されることを確認します。

1. モノレポプロジェクトのナビゲーションペインで [ブループリント] を選択し、[ブループリントを追加] を選択します。

2. [PDK - Cloudscape React ウェブサイト] ブループリントを選択し、[次へ] を選択します。

3. [ブループリントを構成] で、ブループリントのパラメータを設定します。

   • [ウェブサイト名] テキスト入力フィールドに、ウェブサイトの名前を入力します。

   • [型安全 API] ドロップダウンメニューを選択し、ウェブサイトに統合する API ブループリントを選択します。API を渡すと、認証されたクライアントが設定され、必要な依存関係、API Explorer、およびその他の機能が追加されます。

4. [コード変更] タブで、変更案を確認します。プルリクエストに表示される差異は、そのプルリクエストが作成された時点におけるプロジェクトへの変更案を示しています。

5. ブループリントの適用時に反映される変更案に問題がなければ、[ブループリントを追加] を選択します。

   プルリクエストを作成したら、コメントを追加できます。コメントは、プルリクエスト、またはファイルの個々の行、およびプルリクエスト全体に追加できます。ファイルなどのリソースへのリンクは、@ 記号に続いてファイルの名前を付けることで追加できます。

   注記

   プルリクエストが承認され、マージされるまで、ブループリントは適用されません。詳細については、「プルリクエストのレビュー」および「プルリクエストをマージする」を参照してください。

6. [ステータス] 列から、[PDK - Cloudscape React ウェブサイト] ブループリントの行に対して [保留中のプルリクエスト] を選択し、未解決のプルリクエストのリンクを選択します。

7. [マージ] を選択し、優先するマージ戦略を選択した後、[マージ] を選択して、適用されたブループリントの変更を組み込みます。

   プルリクエストがマージされると、モノレポプロジェクト内に新しいフォルダ packages/websites/my-website-name が生成されます。このフォルダには、新しいウェブサイトのすべてのソースコードが含まれます。

8. ナビゲーションペインで [ブループリント] を選択し、[PDK - Cloudscape React ウェブサイト] の [ステータス] が [最新] と表示されることを確認します。

1. モノレポプロジェクトのナビゲーションペインで [ブループリント] を選択し、[ブループリントを追加] を選択します。

2. [PDK - インフラストラクチャ] ブループリントを選択し、[次へ] を選択します。

3. [ブループリントを構成] で、ブループリントのパラメータを設定します。

   • [CDK 言語] で、インフラストラクチャを開発する言語を選択します。

   • [スタック名] テキスト入力フィールドに、ブループリント用に生成された CloudFormation スタックの名前を入力します。

     注記

     このスタック名は、次のステップで DevOps ワークフローを設定する際に必要となるため、書き留めます。

   • [型安全 API] ドロップダウンメニューを選択し、ウェブサイトに統合する API ブループリントを選択します。

   • [Cloudscape React TS ウェブサイト] ドロップダウンメニューを選択し、インフラストラクチャ内にデプロイするウェブサイトブループリント (例: PDK - Cloudscape React ウェブサイト) を選択します。

4. [コード変更] タブで、変更案を確認します。プルリクエストに表示される差異は、そのプルリクエストが作成された時点におけるプロジェクトへの変更案を示しています。

5. ブループリントの適用時に反映される変更案に問題がなければ、[ブループリントを追加] を選択します。

   プルリクエストを作成したら、コメントを追加できます。コメントは、プルリクエスト、またはファイルの個々の行、およびプルリクエスト全体に追加できます。ファイルなどのリソースへのリンクは、@ 記号に続いてファイルの名前を付けることで追加できます。

   注記

   プルリクエストが承認され、マージされるまで、ブループリントは適用されません。詳細については、「プルリクエストのレビュー」および「プルリクエストをマージする」を参照してください。

6. [ステータス] 列から、[PDK - インフラストラクチャ] ブループリントの行に対して [保留中のプルリクエスト] を選択し、未解決のプルリクエストのリンクを選択します。

7. [マージ] を選択し、優先するマージ戦略を選択した後、[マージ] を選択して、適用されたブループリントの変更を組み込みます。

   プルリクエストがマージされると、モノレポプロジェクト内に新しいフォルダ packages/infra が生成されます。このフォルダには、プロジェクトを AWS クラウドにデプロイするためのインフラストラクチャが含まれます。

8. ナビゲーションペインで [ブループリント] を選択し、[PDK - インフラストラクチャ] の [ステータス] が [最新] と表示されることを確認します。

1. モノレポプロジェクトのナビゲーションペインで [ブループリント] を選択し、[ブループリントを追加] を選択します。

2. [PDK - DevOps] ブループリントを選択し、[次へ] を選択します。

3. [ブループリントを構成] で、ブループリントのパラメータを設定します。

   • 現在の環境で [CDK をブートストラップ] を選択します。

   • [スタック名] テキスト入力フィールドに、デプロイする CloudFormation スタックの名前を入力します。この名前は、「ステップ 4: アプリケーションを AWS クラウドにデプロイするためのインフラストラクチャを生成する」で [PDK - インフラストラクチャ] ブループリント用に設定したスタック名と一致する必要があります。

   • [AWS アカウント接続] ドロップダウンメニューを選択し、リソースに使用する AWS アカウントを選択します。詳細については、「AWS アカウントをスペースに追加する」を参照してください。

   • [アプリケーションのデプロイに使用するロール] ドロップダウンメニューを選択し、プロジェクトのアプリケーションのデプロイに使用する IAM ロールを選択します。

     注記

     IAM ロールを作成する際は、SourceArn をプロジェクト設定内にある現在の ProjectID に制限します。詳細については、「CodeCatalystWorkflowDevelopmentRole-spaceName サービスロールについて」を参照してください。

   • [リージョン] ドロップダウンメニューを選択し、モノレポプロジェクトをデプロイするリージョンを選択します。デプロイは、必要な AWS サービスが存在するリージョンでのみ機能します。詳細については、「AWS サービス (リージョン別)」を参照してください。

4. [コード変更] タブで、変更案を確認します。プルリクエストに表示される差異は、そのプルリクエストが作成された時点におけるプロジェクトへの変更案を示しています。

5. ブループリントの適用時に反映される変更案に問題がなければ、[ブループリントを追加] を選択します。

   プルリクエストを作成したら、コメントを追加できます。コメントは、プルリクエスト、またはファイルの個々の行、およびプルリクエスト全体に追加できます。ファイルなどのリソースへのリンクは、@ 記号に続いてファイルの名前を付けることで追加できます。

   注記

   プルリクエストが承認され、マージされるまで、ブループリントは適用されません。詳細については、「プルリクエストのレビュー」および「プルリクエストをマージする」を参照してください。

6. [ステータス] 列から、[PDK - インフラストラクチャ] ブループリントの行に対して [保留中のプルリクエスト] を選択し、未解決のプルリクエストのリンクを選択します。

7. [マージ] を選択し、優先するマージ戦略を選択した後、[マージ] を選択して、適用されたブループリントの変更を組み込みます。

   プルリクエストがマージされると、モノレポプロジェクト内に新しいフォルダ .codecatalyst/workflows が生成されます。

8. ナビゲーションペインで [ブループリント] を選択し、[PDK - DevOps] の [ステータス] が [最新] と表示されることを確認します。

1. モノレポプロジェクトのナビゲーションペインで、[CI/CD] を選択し、[ワークフロー] を選択します。

2. [リリース] ワークフローの最新のワークフロー実行を選択し、具体的な情報を表示します。詳細については、「1 つの実行のステータスと詳細の表示」を参照してください。

3. ワークフロー実行が正常に完了したら、ワークフローにおける前回のアクション (例: Deploy-Beta-ap-souteast-2) を選択してから、[変数] を選択します。

   

4. [変数] テーブルにあるリンク (例: MyPDKApiwebsiteDistributionDomainNameXXXXX) をコピーして新しいブラウザウィンドウに貼り付け、デプロイされたウェブサイトを表示します。

   

   ウェブサイトにログインするには、Amazon Cognito アカウントが必要です。デフォルトでは、ユーザープールは自己登録を許可するように設定されていません。

   1. [AWS Cognito コンソール] に移動します。

   2. [ユーザープール] テーブルから、[PDK - DevOps] ブループリントで作成されたユーザープールに一致する [ユーザープール名] を選択します。この名前は、[変数] テーブルにあります (例: infracalculatebetaUserIdentityinfracalculatebetaUserIdentityIdentityPoolIdXXXXX)。詳細については、「Getting started with user pools」を参照してください。

      

   3. [ユーザーの作成] を選択します。

   4. [ユーザー情報] パラメータを設定します。

      • [招待メッセージ] で、[E メールで招待を送信] を選択します。

      • [ユーザー名] テキスト入力フィールドにユーザー名を入力します。

      • [E メールアドレス] テキスト入力フィールドに E メールアドレスを入力します。

      • [仮パスワード] で、[パスワードの生成] を選択します。

   5. [ユーザーの作成] を選択します。

   6. [ユーザー情報] パラメータに入力した E メールアカウントに移動し、仮パスワードで E メールを開きます。このパスワードを書き留めます。

   7. デプロイされたウェブサイトに戻り、作成したユーザー名と受け取った仮パスワードを入力し、[サインイン] を選択します。

5. (オプション) ワークフロー実行が正常に完了したら、生成された図を表示することもできます。CodeCatalyst の [アーティファクト] タブを選択し、[図] の行の [ダウンロード] を選択して、ダウンロードしたファイル (複数可) を開きます。

   
   

プロジェクト設定タブからメンバーをプロジェクトに招待する方法

1. プロジェクトに移動します。

   ヒント

   上部のナビゲーションバーに表示するプロジェクトを選択できます。

2. ナビゲーションペインで、[プロジェクト設定] を選択します。

3. [メンバー] タブを選択します。

4. [プロジェクトメンバー] で、[新しいメンバーの招待] を選択します。

5. 新しいメンバーの E メールアドレスを入力し、このメンバーのロールを選択して、[招待] を選択します。ロールの詳細については、「ユーザーロールによってアクセス権を付与する」をご参照ください。

プロジェクトの概要ページからメンバーをプロジェクトに招待する方法

1. プロジェクトに移動します。

   ヒント

   上部のナビゲーションバーに表示するプロジェクトを選択できます。

2. [メンバー +] ボタンを選択します。

3. 新しいメンバーの E メールアドレスを入力し、このメンバーのロールを選択して、[招待] を選択します。ロールの詳細については、「ユーザーロールによってアクセス権を付与する」をご参照ください。

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. 問題を作成するモノレポプロジェクトに移動します。

3. プロジェクトのホームページで、[問題の作成] を選択します。または、ナビゲーションペインで [問題] を選択します。

4. [問題の作成] を選択します。

   注記

   グリッドビューを使用する場合、グリッドビュー内で問題を直接追加することもできます。

5. 問題のタイトルを入力します。

6. (オプション) [説明] を入力します。この問題には、a change in the src/mysfit_data.json file. という説明を入力します。マークダウンを使用して書式を追加できます。

7. (オプション) 問題の [ステータス]、[優先度]、[見積もり] を選択します。

8. (オプション) 既存のラベルを追加するか、新しいラベルを作成し、[+ ラベルを追加] を選択して追加します。

   1. 既存のラベルを追加するには、リストからラベルを選択します。フィールドに検索語を入力して、プロジェクト内のその語句を含むすべてのラベルを検索できます。

   2. 新しいラベルを作成して追加するには、作成するラベルの名前を検索フィールドに入力し、Enter キーを押します。

9. (オプション) [+ 担当者を追加] を選択して、担当者を追加します。[+ 自分を追加] を選択すると、自分を担当者としてすばやく追加できます。

   ヒント

   [Amazon Q] に問題を割り当てることで、Amazon Q で問題の解決を試みることができます。詳細については、「チュートリアル: CodeCatalyst の生成 AI 機能を使用して開発作業を高速化する」を参照してください。

   この機能を使用するには、スペースに対して生成 AI 機能を有効にする必要があります。詳細については、生成 AI 機能の管理に関するページを参照してください。

10. (オプション) 既存の [カスタムフィールド] を追加するか、新しいカスタムフィールドを作成します。問題には、複数のカスタムフィールドを含めることができます。

    1. 既存のカスタムフィールドを追加するには、リストからカスタムフィールドを選択します。フィールドに検索語を入力して、プロジェクト内のその語句を含むすべてのカスタムフィールドを検索できます。

    2. 新しいカスタムフィールドを作成して追加するには、作成するカスタムフィールドの名前を検索フィールドに入力し、Enter キーを押します。次に、作成するカスタムフィールドのタイプを選択し、値を設定します。

11. [問題の作成] を選択します。右下隅に通知が表示されます。問題が正常に作成された場合、問題が正常に作成されたことを示す確認メッセージが表示されます。問題が正常に作成されなかった場合、失敗の理由を示すエラーメッセージが表示されます。その後、[再試行] を選択して問題を編集し、作成を再試行するか、[破棄] を選択して問題を破棄できます。どちらのオプションを選択した場合も、通知は解除されます。

    注記

    問題の作成時、その問題にプルリクエストをリンクすることはできません。ただし、作成した問題を編集して、プルリクエストへのリンクを追加できます。

プロジェクトのソースリポジトリに移動する方法

1. 次のいずれかを実行してプロジェクトに移動します。

   • プロジェクトの概要ページで、リストから必要なリポジトリを選択し、[リポジトリの表示] を選択します。

   • ナビゲーションペインで [コード] を選択してから、[ソースリポジトリ] を選択します。[ソースリポジトリ] のリストから、リポジトリの名前を選択します。リポジトリのリストをフィルタリングするには、フィルタバーにリポジトリ名の一部を入力します。

2. リポジトリのホームページで、リポジトリの内容と、プルリクエストやワークフローの数など、関連リソースに関する情報を表示します。デフォルトでは、デフォルトブランチの内容が表示されます。ドロップダウンリストから別のブランチを選択することで、ビューを変更できます。

1. モノレポプロジェクトのナビゲーションペインで、次のいずれかを実行します。

   • [概要] を選択し、次に [My 開発環境] セクションに移動します。

   • [コード] を選択してから、[開発環境] を選択します。

   • [コード] を選択し、[ソースリポジトリ] を選択して、開発環境を作成する [モノレポ] リポジトリを選択します。

2. ドロップダウンメニューからサポートされている IDE を選択します。詳細については、「開発環境でサポートされている統合開発環境」を参照してください。

3. [リポジトリのクローン] を選択します。

4. クローンするリポジトリを選択し、[新しいブランチで作業する] を選択し、[ブランチ名] フィールドにブランチ名を入力し、[ブランチの作成元] ドロップダウンメニューから新しいブランチを作成するブランチを選択します。

   注記

   [ソースリポジトリ] ページまたは特定のソースリポジトリを元に開発環境を作成する場合は、リポジトリを選択する必要はありません。開発環境は [ソースリポジトリ] ページから選択したソースリポジトリを元に作成されます。

5. (オプション) [エイリアス - オプション] で、開発環境のエイリアスを入力します。

6. (オプション) [開発環境設定] 編集ボタンを選択して、開発環境のコンピューティング、ストレージ、またはタイムアウトの設定を編集します。

7. (オプション) [Amazon Virtual Private Cloud (Amazon VPC) - オプション] で、ドロップダウンメニューから開発環境に関連付ける VPC 接続を選択します。

   スペースにデフォルトの VPC が設定されている場合、開発環境はその VPC に接続して実行されます。この設定は、別の VPC 接続を関連付けることでオーバーライドできます。また、VPC に接続された開発環境では AWS Toolkit がサポートされないことに注意してください。

   注記

   VPC 接続を使用して開発環境を作成すると、VPC 内に新しいネットワークインターフェイスが作成されます。CodeCatalyst は、関連付けられた VPC ロールを使用して、このインターフェイスとやり取りします。また、IPv4 CIDR ブロックが IP アドレス範囲 172.16.0.0/12 に設定されていないことを確認してください。

8. [Create] (作成) を選択します。開発環境の作成中は、開発環境のステータス列に [開始中] と表示され、開発環境が作成されると、ステータス列に [実行中] と表示されます。

1. 開発環境の作業ターミナルで、モノレポプロジェクトに移動し、次のコマンドを実行してプロジェクトの依存関係をインストールします。

   npx projen install

2. packages/apis/mypdkapi/model/src/main/smithy/operations/say-hello.smithy に移動します。このファイルに API オペレーションの例が定義されています。このチュートリアルでは、2 つの数値をまとめて追加するシンプルな Calculate オペレーションを構築します。入力と出力を含めてこのオペレーションを定義するようにコードを変更します。

   例:

   $version: "2"
   namespace com.aws
   
   @http(method: "POST", uri: "/calculate")
   @handler(language: "typescript")
   operation Calculate {
       input := {
           @required
           numberA: Integer
           @required
           numberB: Integer
       }
       output := {
           @required
           result: Integer
       }
   }

   @handler 特性は、このオペレーションを TypeScript で記述された AWS Lambda ハンドラーとして実装することを型安全 API に指示します。型安全 API によって、このオペレーションのスタブが生成され、TypeScript で実装できるようになります。@required 特性が追加されます。これにより、デプロイされる API ゲートウェイによって、実行時に強制されます。詳細については、Smithy ドキュメントを参照してください。

3. ファイル名 /say-hello.smithy をコードの変更に合わせたものに変更します (例: calculate.smithy)。

4. packages/apis/mypdkapi/model/src/main/smithy/main.smithy に移動し、コードを変更してオペレーションを接続します。/calculate.smithy で定義された Calculate オペレーションを公開するには、このファイルの operations フィールドにリストします。

   例:

   $version: "2"
   namespace com.aws
   
   use aws.protocols#restJson1
   
   /// A sample smithy api
   @restJson1
   service MyPDKApi {
       version: "1.0"
       operations: [Calculate]
       errors: [
         BadRequestError
         NotAuthorizedError
         InternalFailureError
       ]
   }

5. 次のコマンドを実行して変更をビルドします。

   npx projen build

   注記

   オプションで、--parallel X フラグを渡すことができます。これにより、ビルドが X 個のコア全体に分散されます。

   @handler 特性が追加されているため、ビルドが完了すると次のファイルが生成されます。

   • /packages/apis/mypdkapi/handlers/typescript/src/calculate.ts

   • /packages/apis/mypdkapi/handlers/typescript/test/calculate.test.ts

6. packages/apis/mypdkapi/handlers/typescript/src/calculate.ts に移動し、コードを変更します。このファイルは、 API に対して呼び出されるサーバーハンドラーです。

   import {
     calculateHandler,
     CalculateChainedHandlerFunction,
     INTERCEPTORS,
     Response,
     LoggingInterceptor,
   } from 'mypdkapi-typescript-runtime';
   
   /**
    * Type-safe handler for the Calculate operation
    */
   export const calculate: CalculateChainedHandlerFunction = async (request) => {
     LoggingInterceptor.getLogger(request).info('Start Calculate Operation');
   
     const { input } = request;
   
     return Response.success({
       result: input.body.numberA + input.body.numberB,
     });
   };
   
   /**
    * Entry point for the AWS Lambda handler for the Calculate operation.
    * The calculateHandler method wraps the type-safe handler and manages marshalling inputs and outputs
    */
   export const handler = calculateHandler(...INTERCEPTORS, calculate);

7. /packages/apis/mypdkapi/handlers/typescript/test/calculate.test.ts ファイルに移動し、コードを変更してユニットテストを更新します。

   例:

   import {
     CalculateChainedRequestInput,
     CalculateResponseContent,
   } from 'mypdkapi-typescript-runtime';
   import {
     calculate,
   } from '../src/calculate';
   
   // Common request arguments
   const requestArguments = {
     chain: undefined as never,
     event: {} as any,
     context: {} as any,
     interceptorContext: {
       logger: {
         info: jest.fn(),
       },
     },
   } satisfies Omit<CalculateChainedRequestInput, 'input'>;
   
   describe('Calculate', () => {
   
     it('should return correct sum', async () => {
       const response = await calculate({
         ...requestArguments,
         input: {
           requestParameters: {},
           body: {
             numberA: 1,
             numberB: 2
           }
         },
       });
   
       expect(response.statusCode).toBe(200);
       expect((response.body as CalculateResponseContent).result).toEqual(3);
     });
   
   });

8. /packages/infra/main/src/constructs/apis/mypdkapi.ts ファイルに移動し、コードを変更して、CDK インフラストラクチャに Calculate オペレーションの統合を追加します。API コンストラクトには統合プロパティがあり、以前に追加した実装を渡すことができます。Calculate オペレーションには Smithy モデルで @handler 特性を使用しているため、事前に設定され、生成された CalculateFunction CDK コンストラクトを使用して、ハンドラーの実装を指すことができます。

   例:

   import { UserIdentity } from "@aws/pdk/identity";
   import { Authorizers, Integrations } from "@aws/pdk/type-safe-api";
   import { Stack } from "aws-cdk-lib";
   import { Cors } from "aws-cdk-lib/aws-apigateway";
   import {
     AccountPrincipal,
     AnyPrincipal,
     Effect,
     PolicyDocument,
     PolicyStatement,
   } from "aws-cdk-lib/aws-iam";
   import { Construct } from "constructs";
   import { Api, CalculateFunction } from "calculateapi-typescript-infra";
   
   /**
    * Api construct props.
    */
   export interface CalculateApiProps {
     /**
      * Instance of the UserIdentity.
      */
     readonly userIdentity: UserIdentity;
   }
   
   /**
    * Infrastructure construct to deploy a Type Safe API.
    */
   export class CalculateApi extends Construct {
     /**
      * API instance
      */
     public readonly api: Api;
   
     constructor(scope: Construct, id: string, props?: CalculateApiProps) {
       super(scope, id);
   
       this.api = new Api(this, id, {
         defaultAuthorizer: Authorizers.iam(),
         corsOptions: {
           allowOrigins: Cors.ALL_ORIGINS,
           allowMethods: Cors.ALL_METHODS,
         },
         integrations: {
           calculate: {
             integration: Integrations.lambda(new CalculateFunction(this, "CalculateFunction"))
           }
         },
         policy: new PolicyDocument({
           statements: [
             // Here we grant any AWS credentials from the account that the prototype is deployed in to call the api.
             // Machine to machine fine-grained access can be defined here using more specific principals (eg roles or
             // users) and resources (ie which api paths may be invoked by which principal) if required.
             // If doing so, the cognito identity pool authenticated role must still be granted access for cognito users to
             // still be granted access to the API.
             new PolicyStatement({
               effect: Effect.ALLOW,
               principals: [new AccountPrincipal(Stack.of(this).account)],
               actions: ["execute-api:Invoke"],
               resources: ["execute-api:/*"],
             }),
             // Open up OPTIONS to allow browsers to make unauthenticated preflight requests
             new PolicyStatement({
               effect: Effect.ALLOW,
               principals: [new AnyPrincipal()],
               actions: ["execute-api:Invoke"],
               resources: ["execute-api:/*/OPTIONS/*"],
             }),
           ],
         }),
       });
   
       // Grant authenticated users access to invoke the api
       props?.userIdentity.identityPool.authenticatedRole.addToPrincipalPolicy(
         new PolicyStatement({
           effect: Effect.ALLOW,
           actions: ["execute-api:Invoke"],
           resources: [this.api.api.arnForExecuteApi("*", "/*", "*")],
         }),
       );
     }
   }

9. 次のコマンドを実行して変更をビルドします。

   npx projen build

• 次のコマンドを実行することで、変更をコミットし、機能ブランチにプッシュします。

  git add .

  git commit -m "my commit message"

  git push

1. モノレポプロジェクトで、次のいずれかを実行します。

   • ナビゲーションペインで、[コード] を選択し、[プルリクエスト] を選択して、[プルリクエストの作成] を選択する。

   • リポジトリのホームページで、[その他] を選択し、[プルリクエストの作成] を選択する。

   • プロジェクトページで、[プロジェクトの作成] を選択する。

2. [ソースリポジトリ] で、指定されたソースリポジトリが、コミットされたコードを含むリポジトリであることを確認します。このオプションは、リポジトリのメインページからプルリクエストを作成していない場合にのみ表示されます。

3. [ターゲットブランチ] で、コードがレビューされた後にそのコードをマージする [メイン] ブランチを選択します。

4. [ソースブランチ] で、コミットされたコードを含む機能ブランチを選択します。

5. [プルリクエストのタイトル] に、他のユーザーが確認すべき内容とその理由を理解しやすいタイトルを入力します。

6. (オプション) [プルリクエストの説明] で、問題へのリンクや変更の説明などの情報を提供します。

   ヒント

   [説明を自動的に記述] を選択すると、プルリクエストに含まれる変更の説明が CodeCatalyst で自動的に生成されます。自動的に生成された説明をプルリクエストに追加した後に、その説明を変更できます。

   この機能を使用するには、スペースに対して生成 AI 機能を有効にする必要があります。詳細については、Amazon CodeCatalyst における生成 AI 機能の管理に関するページを参照してください。

7. [問題] で、[問題をリンク] を選択し、ステップ 2: 共同作業と作業追跡のために問題を作成する で作成した問題を選択します。問題のリンクを解除するには、リンク解除アイコンを選択します。

8. (オプション) [必須のレビュー担当者] で、[必須のレビュー担当者を追加] を選択します。プロジェクトメンバーのリストから、追加するメンバーを選択します。プルリクエストをターゲットブランチにマージする前に、必須のレビュー担当者が変更を承認する必要があります。

   注記

   同じレビュー担当者を必須のレビュー担当者とオプションのレビュー担当者の両方に追加することはできません。レビュー担当者として自分を追加することはできません。

9. (オプション) [オプションのレビュー担当者] で、[オプションのレビュー担当者を追加] を選択します。プロジェクトメンバーのリストから、追加するメンバーを選択します。プルリクエストをターゲットブランチにマージする前に、オプションのレビュー担当者が変更を要件として承認する必要はありません。

10. 自分が作成したプルリクエストは、レビュー担当者または自分自身がレビューし、メインブランチにマージする必要があります。詳細については、「プルリクエストをマージする」を参照してください。

    変更がソースリポジトリのメインブランチにマージされると、新しいワークフローが自動的にトリガーされます。

11. マージが完了したら、問題を [完了] に移動できます。

    1. ナビゲーションペインで、[問題] を選択します。

    2. ステップ 2: 共同作業と作業追跡のために問題を作成する で作成した問題を選択し、[ステータス] ドロップダウンを選択して、[完了] を選択します。

1. モノレポプロジェクトのナビゲーションペインで、[CI/CD] を選択し、[ワークフロー] を選択します。

2. [リリース] ワークフローの最新のワークフロー実行を選択し、具体的な情報を表示します。詳細については、「1 つの実行のステータスと詳細の表示」を参照してください。

3. ワークフロー実行が正常に完了したら、ワークフローにおける前回のアクション (Deploy-Beta-ap-souteast-2) を選択してから、[変数] を選択します。

4. MyPDKApiwebsiteDistributionDomainNameXXXXX の行のリンクをコピーして新しいブラウザウィンドウに貼り付け、デプロイされたウェブサイトを表示します。

5. ステップ 6: リリースワークフローを確認し、ウェブサイトを表示する で作成したユーザー名とパスワードを入力し、[サインイン] を選択します。

6. (オプション) アプリケーションで変更をテストします。

   1. [POST] ドロップダウンメニューを選択します。

   2. 2 つの値を numberA と number B に入力し、[実行] を選択します。

   3. [レスポンス本文] で結果を確認します。