Zenn
🐙

AWS CDK

2023/02/12に公開
AWS
AWS CDK
tech

AWS CDKとは

AWS Cloud Development Kit (AWS CDK)

AWSのリソースをTypescriptやPython等のコードで定義するフレームワーク。
コードで定義したリソースがCloudFormationテンプレートに変換され、デプロイされる。

CDK の対応言語は以下の５つです。(2020年5月現在)

  • Typescript
  • JavaScript
  • Python
  • Java
  • C#

手順

参考資料

基本的には、公式のチュートリアルを参考にする。
https://cdkworkshop.com/15-prerequisites/200-account.html

随時、下記も確認。
https://dev.classmethod.jp/articles/aws-cdk-101-typescript/

IAMユーザーを作成

  1. 管理者ユーザでAWSアカウントにサインイン
  2. IAMコンソールに移動して 新しいユーザーを作成
  3. ユーザーの名前を入力（cdk-workshop）
  4. 権限を設定。(既存のポリシーを直接添付する → AdministratorAccess)
  5. 資格情報を設定(profile名もcdk-workshopにした)
aws configure --profile cdk-workshop

AWS Access Key ID [None]: <type key ID here>
AWS Secret Access Key [None]: <type access key>
Default region name [None]: <choose region (ap-notrheast-3 = 大阪にしてみた)>
Default output format [None]: <leave blank>

profileが追加されているか確認(AWS CLIのprofileを確認)

cat ~/.aws/credentials

前提環境確認

nodeは10.13.0以上でないといけない。

node --version
v16.3.0

Typesctiptを使えるか。

tsc --v
Version 4.3.5

cdkコマンドが使えるか。

cdk --version
1.117.0 (build 0047c98)

ディレクトリ作成。(cdk-sample)

mkdir cdk-sample

初期化

雛形を作成。

cdk init --language typescript

コンパイル

TypeScriptはJavaScriptにコンパイルする必要があるため、ソースファイルに変更を加えるたびに、それらをにコンパイルする必要がある。
そのために、新しいターミナルのタブを開いて、watchを実行する。
package.jsonで"watch": "tsc -w"と定義されており、-wはソース変更のたびに自動的にコンパイルしてくれる。
（新しいタブで開くのは、バックグラウンドでずっと動いてほしいため）

npm run watch

Starting compilation in watch mode...
Found 0 errors. Watching for file changes.

主要ファイル

lib/cdk-workshop-stack.ts

主要なファイル。CDKアプリケーションのメインスタックを定義。

bin/cdk-workshop.ts

CDKアプリケーションのエントリポイント。
lib/cdk-workshop-stack.tsで定義されたスタックをロード。

cdk.json

アプリの実行方法をツールキットに指示。

コマンド（動作確認）

こちらも詳しい
https://dev.classmethod.jp/articles/aws-cdk-command-line-interface/#toc-10

cdk synth

lib/cdk-workshop-stack.tsにサンプル実装して、cdk synthを実行。
しかしエラー発生のため、下記のようにnpx経由で実行した。

cdk synth

This CDK CLI is not compatible with the CDK library used by your application. Please upgrade the CLI to the latest version.
(Cloud assembly schema version mismatch: Maximum schema version supported is 13.0.0, but found 14.0.0)

yarn global upgrade aws-cdk@latest
(これは必要かは不明)

npm install -g npx
npx cdk synth

cdk bootstrap

cdk bootstrap: AWSアカウント、リージョン単位で一度だけ実行するコマンド。
CDKで利用するリソースを置いておくS3バケットを作成してくれる。

npx cdk bootstrap --profile cdk-workshop

cdk deploy

npx cdk deploy --profile cdk-workshop

リソースがAWS上に作成され、コンソール画面の CloudFormation にて、リソースタブを開くと作成されたリソースが確認できた。

cdk diff

npx cdk diff --profile cdk-workshop

cdk destroy

スタックごとリソースを削除。

npx cdk destroy --profile cdk-workshop

AWS Lamdaリソースを作る

  1. lamdaディレクトリを作り、hello.jsを作成。
    実行したい関数を定義。
lambda/hello.js
// "Hello"を返却するLambda関数
exports.handler = async function (event) {
  console.log("request: ", JSON.stringify(event, undefined, 2));
  return {
    statusCode: 200,
    headers: { "Content-Type": "text/plain" },
    body: `Hello, CDK! You've hit ${event.path}\m`
  }
}
  1. AWSコンストラクトライブラリをインストール。

AWSコンストラクトライブラリ

AWSサービスごとに1つずつ、モジュールに分割されているライブラリ。
たとえば、AWS Lambda関数を定義する場合は、AWSLambdaコンストラクトライブラリを使用する。

yarn add @aws-cdk/aws-lambda
  1. lib/cdk-sample-stack.tsに追加したいリソースを定義。
    AWSLambda関数をスタックに追加。
lib/cdk-sample-stack.ts
import * as cdk from '@aws-cdk/core';
import * as lambda from '@aws-cdk/aws-lambda';

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

    // Lamdaリソースをスタックに追加
    const hello = new lambda.Function(this, 'HelloHandler', {
      runtime: lambda.Runtime.NODEJS_14_X, // 実行環境
      code: lambda.Code.fromAsset('lambda'), // lamdaディレクトリのコードを読み込む
      handler: 'hello.handler' // "hello"ファイルの"handler"関数を実行する
    });
  }
}
  1. 差分を確認。(cdk diff)
  2. デプロイ（cdk deploy)
  3. Lambdaのコンソール画面から、テスト
    (イベントテンプレートリストからAmazonAPI Gateway AWSProxyを選択)
  4. 出力に、レスポンスが表示されている。（成功）

AWS APIGatewayリソースを作る

Lambdaの前にAPIGatewayを配置する。
(ブラウザやcurlで叩ける)パブリックHTTPエンドポイントを公開する。

  1. AWSコンストラクトライブラリをインストール。
yarn add @aws-cdk/aws-apigateway
  1. lib/cdk-sample-stack.tsに追加したいリソースを定義。
    AWSAPIGateway関数をスタックに追加。
lib/cdk-sample-stack.ts
import * as cdk from '@aws-cdk/core';
import * as lambda from '@aws-cdk/aws-lambda';
import * as apigw from '@aws-cdk/aws-apigateway';

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

    // Lamdaリソースをスタックに追加
    const hello = new lambda.Function(this, 'HelloHandler', {
      runtime: lambda.Runtime.NODEJS_14_X, // 実行環境
      code: lambda.Code.fromAsset('lambda'), // lamdaディレクトリのコードを読み込む
      handler: 'hello.handler' // "hello"ファイルの"handler"関数を実行する
    });

    // hello関数(Lamdaリソース)へのリクエストをプロキシするAPIGatewayを定義
    new apigw.LambdaRestApi(this, 'Endpoint', {
      handler: hello
    });
  }
}
  1. 差分を確認。(cdk diff)
  2. デプロイ（cdk deploy)
  3. deploy完了時のターミナルに表示されているエンドポイントにcurlやブラウザでアクセス。
  4. Hello, CDK! You've hit /mと出力される。（成功）

ヒットカウンターを作る

リクエストの回数をカウントし、DynamoDBに保存する。

lib/cdk-sample-stack.ts
import * as cdk from '@aws-cdk/core';
import * as lambda from '@aws-cdk/aws-lambda';
import * as apigw from '@aws-cdk/aws-apigateway';
import { HitCounter } from './hitcounter';

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

    // Lamdaリソースをスタックに追加
    const hello = new lambda.Function(this, 'HelloHandler', {
      runtime: lambda.Runtime.NODEJS_14_X, // 実行環境
      code: lambda.Code.fromAsset('lambda'), // lamdaディレクトリのコードを読み込む
      handler: 'hello.handler' // "hello"ファイルの"handler"関数を実行する
    });

    const helloWithCounter = new HitCounter(this, 'HelloHitCounter', {
      downstream: hello
    });

    // hello関数(Lamdaリソース)へのリクエストをプロキシするAPIGatewayを定義
    new apigw.LambdaRestApi(this, 'Endpoint', {
      handler: helloWithCounter.handler
    });
  }
}
lib/hitcounter.ts
import * as cdk from '@aws-cdk/core';
import * as lambda from '@aws-cdk/aws-lambda';
import * as dynamodb from '@aws-cdk/aws-dynamodb';

export interface HitCounterProps {
  // カウントする関数
  downstream: lambda.IFunction;
}

// 構造体（→スタックに追加する）
export class HitCounter extends cdk.Construct {
  public readonly handler: lambda.Function;

  constructor(scope: cdk.Construct, id: string, props: HitCounterProps) {
    super(scope, id);

    const table = new dynamodb.Table(this, 'Hits', {
      partitionKey: { name: 'path', type: dynamodb.AttributeType.STRING }
    });

    this.handler = new lambda.Function(this, 'HitCounterHandler', {
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: 'hitcounter.handler',
      code: lambda.Code.fromAsset('lambda'),
      environment: {
        DOWNSTREAM_FUNCTION_NAME: props.downstream.functionName,
        HITS_TABLE_NAME: table.tableName
      }
    });

    table.grantReadWriteData(this.handler);

    props.downstream.grantInvoke(this.handler);
  }
}
lambda/hitcounter.js
const { DynamoDB, Lambda } = require('aws-sdk');

exports.handler = async function(event) {
  console.log("request:", JSON.stringify(event, undefined, 2));

  const dynamo = new DynamoDB();
  const lambda = new Lambda();

  await dynamo.updateItem({
    TableName: process.env.HITS_TABLE_NAME, // DynamoDBテーブル名
    Key: { path: { S: event.path} },
    UpdateExpression: 'ADD hits :incr',
    ExpressionAttributeValues: { ':incr': { N: '1'}}
  }).promise();

  const resp = await lambda.invoke({
    FunctionName: process.env.DOWNSTREAM_FUNCTION_NAME, // Lambda関数名
    Payload: JSON.stringify(event) // 返却値
  }).promise();

  console.log('downstream response:', JSON.stringify(resp, undefined, 2));

  return JSON.parse(resp.Payload);
}

Discussion