CDKインフラストラクチャ

AWS CDK はクラウドインフラストラクチャをコードで定義し、AWS CloudFormation を通じてプロビジョニングするフレームワークです。

TypeScript インフラストラクチャジェネレータは、TypeScript で記述された AWS CDK インフラストラクチャアプリケーションを作成します。生成されたアプリケーションには CFN Guard チェックによるセキュリティベストプラクティスが含まれます。

使用方法

インフラストラクチャプロジェクトの生成

新しいインフラストラクチャプロジェクトは2つの方法で生成できます:

VSCode

1. インストール Nx Console VSCode Plugin まだインストールしていない場合
2. VSCodeでNxコンソールを開く
3. クリック Generate (UI) "Common Nx Commands"セクションで
4. 検索 @aws/nx-plugin - ts#infra
5. 必須パラメータを入力
6. クリック Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:ts#infra

yarn

yarn nx g @aws/nx-plugin:ts#infra

npm

npx nx g @aws/nx-plugin:ts#infra

bun

bunx nx g @aws/nx-plugin:ts#infra

変更されるファイルを確認するためにドライランを実行することもできます

pnpm

pnpm nx g @aws/nx-plugin:ts#infra --dry-run

yarn

yarn nx g @aws/nx-plugin:ts#infra --dry-run

npm

npx nx g @aws/nx-plugin:ts#infra --dry-run

bun

bunx nx g @aws/nx-plugin:ts#infra --dry-run

オプション

パラメータ	型	デフォルト	説明
name 必須	string	-	The name of the application.
ruleSet	string	aws_prototyping	Rule set to validate your AWS resources with.
directory	string	packages	The directory of the new application.

ジェネレータの出力結果

ジェネレータは <directory>/<name> ディレクトリに以下のプロジェクト構造を作成します:

• Directorysrc

  • main.ts CDK スタックをインスタンス化してデプロイするアプリケーションエントリポイント
  • Directorystacks CDK スタック定義

    • application-stack.ts メインアプリケーションスタック
• cdk.json CDK 設定ファイル
• project.json プロジェクト設定とビルドターゲット

Tip

インフラストラクチャは TypeScript プロジェクトですので、一般的な使用方法の詳細については TypeScript プロジェクトドキュメント を参照してください。

CDK インフラストラクチャの実装

src/stacks/application-stack.ts 内で CDK インフラストラクチャの記述を開始できます。例:

src/stacks/application-stack.ts

import * as cdk from 'aws-cdk-lib';
import { Bucket } from 'aws-cdk-lib/aws-s3'
import { Construct } from 'constructs';

export class ApplicationStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // インフラストラクチャをここに宣言
    new Bucket(this, 'MyBucket');
  }
}

API インフラストラクチャ

tRPC API または FastAPI ジェネレータを使用して API を作成した場合、packages/common/constructs にそれらをデプロイするためのコンストラクトが既に存在します。

例えば my-api という名前の tRPC API を作成した場合、コンストラクトをインポートしてインスタンス化するだけで必要なインフラストラクチャを追加できます:

src/stacks/application-stack.ts

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { MyApi } from ':my-scope/common-constructs';

export class ApplicationStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // API のインフラストラクチャを追加
    new MyApi(this, 'MyApi');
  }
}

ウェブサイトインフラストラクチャ

CloudScape ウェブサイト ジェネレータを使用した場合、packages/common/constructs にデプロイ用のコンストラクトが存在します。例:

src/stacks/application-stack.ts

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { MyWebsite } from ':my-scope/common-constructs';

export class ApplicationStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // ウェブサイトのインフラストラクチャを追加
    new MyWebsite(this, 'MyWebsite');
  }
}

ウェブサイトの ランタイム設定 にすべての API 設定を含めるためには、API コンストラクトの「後」にウェブサイトを宣言することが重要です。

インフラストラクチャの合成

build ターゲットの一部として、デフォルトのコンパイル、リンター、テストターゲット を実行するのに加え、インフラストラクチャプロジェクトを CloudFormation に「合成」します。これは synth ターゲットを実行することで単独でも実行可能です:

pnpm

pnpm nx run <my-infra>:synth

yarn

yarn nx run <my-infra>:synth

npm

npx nx run <my-infra>:synth

bun

bunx nx run <my-infra>:synth

合成されたクラウドアセンブリはルートの dist フォルダ内の dist/packages/<my-infra-project>/cdk.out に配置されます。

AWS アカウントのブートストラップ

AWS アカウントに初めて CDK アプリケーションをデプロイする場合、事前にブートストラップが必要です。

まず AWS アカウントの認証情報を設定 してください。

次に cdk bootstrap コマンドを使用します:

npx cdk bootstrap aws://<account-id>/<region>

詳細は CDK ドキュメント を参照してください。

AWS へのデプロイ

ビルド後、deploy ターゲットを使用してインフラストラクチャを AWS にデプロイできます。

Caution

CI/CD パイプラインでのデプロイには deploy-ci ターゲットを使用してください。詳細は後述します。

まず AWS アカウントの認証情報を設定 してください。

次にデプロイターゲットを実行します:

pnpm

pnpm nx run <my-infra>:deploy --all

yarn

yarn nx run <my-infra>:deploy --all

npm

npx nx run <my-infra>:deploy --all

bun

bunx nx run <my-infra>:deploy --all

Tip

上記のコマンドは main.ts で定義されたすべてのスタックをデプロイします。特にアプリケーションの複数ステージを構成している場合など、個別のスタックを対象にしたい場合があります:

pnpm

pnpm nx run <my-infra>:deploy my-sandbox-stack

yarn

yarn nx run <my-infra>:deploy my-sandbox-stack

npm

npx nx run <my-infra>:deploy my-sandbox-stack

bun

bunx nx run <my-infra>:deploy my-sandbox-stack

CI/CD パイプラインでの AWS デプロイ

CI/CD パイプラインの一部として AWS にデプロイする場合は deploy-ci ターゲットを使用します。

pnpm

pnpm nx run <my-infra>:deploy-ci my-stack

yarn

yarn nx run <my-infra>:deploy-ci my-stack

npm

npx nx run <my-infra>:deploy-ci my-stack

bun

bunx nx run <my-infra>:deploy-ci my-stack

このターゲットは通常の deploy ターゲットと異なり、事前に合成されたクラウドアセンブリをデプロイすることを保証します。これによりパッケージバージョンの変更に伴う非決定性の問題を回避し、すべてのパイプラインステージで同じクラウドアセンブリを使用してデプロイできます。

追加情報

CDK の詳細については CDK 開発者ガイド と API リファレンス を参照してください。