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リファレンスを参照してください。