こんにちは。はやしです。
本記事ではCDKを使ってAWSサービスを作成してみます。
使用する言語はPythonです。

# 前提条件
macOS 13.0.1

# Node.jsのインストール
CDK CLIをインストールするためにNode.jsをインストールします。
インストールは[こちら](https://nodejs.org/ja/)からできます。LTSがおすすめです。
後にNPMを利用します。インストールされたか確認しておきましょう。
```shell
$ npm --version
```

# CDK CLIのインストール
NPMでCDK CLIのインストールをします。
```shell
$ npm install -g aws-cdk
```
こちらもインストールされたか確認しておきましょう。
```shell
$ cdk --version
```

# AWS CLIによる認証情報設定
ローカルからAWSアカウントにコマンドを実行するので、事前に認証情報を登録しておく必要があります。
認証情報はAWS CLIで設定します。
具体的な方法はこの記事に書かれていますので割愛します。
[AWS CLIの利用開始方法 | Kokosyna](https://www.kokosyna.com/posts/421d730a-2ac7-4d62-b453-3b506816239a)

# AWSアカウントのブートストラップ
CDKの初期化のようなものです。
CDKはデプロイなどにS3バケットやECR等のサブセットを必要としますので、それらを構築します。
```sh
$ cdk bootstrap aws://ACCOUNT-ID/REGION
```
「ACCOUNT-ID」と「REGION」は実際の値に置き換えてください。
ブートストラップはデプロイ先リージョン毎に1度必要です。
既にそのリージョンで実行されている場合は不要です。

# CDKプロジェクトの作成
事前に空のディレクトリを作成してから、CDKプロジェクトの作成を行います。
```shell
$ mkdir cdk-tutorial
$ cd cdk-tutorial
$ cdk init --language python
```

# Python実行環境整備
.venvファイルを削除して、仮想環境を構築する。
```shell
$ rm -rf .venv
$ pipenv shell
$ pipenv install
```

# AWSリソースの定義
![](https://kokosyna-post-bucket-prd.s3.ap-northeast-1.amazonaws.com/ee6d68ab-059f-4c89-ae4e-8692b49acb07.webp)
上の画像の赤枠にはAmazon SQSの定義（デプロイするためのコード）が書かれています。
コメントアウトを解除して、ファイルを保存しましょう。

# AWSリソースの作成
```shell
$ cdk deploy --all
```
上記のコマンドを実行するとデプロイが開始されます。しばらく待ちましょう。

# 動作確認
AWS コンソール上でSQSが作成されたら成功です！🎉
![](https://kokosyna-post-bucket-prd.s3.ap-northeast-1.amazonaws.com/89a7777e-4707-4696-a6f6-b6fe7e32dc52.webp)

# AWSリソースの削除
最後に検証で作成したAWSリソースを削除します。
仮想環境からも抜ければ終了です。
```shell
$ cdk destroy --all
$ exit
```

# まとめ
AWSサービスの管理はこのようにコードで行います。
他にもTypeScript、Go、Javaなどサポートされている言語がありますので、普段利用されている言語で試してみてください。
本記事が皆さんのAWS入門のきっかけになればと思います。

# 参考文献
[AWS CDK の使用を開始する](https://aws.amazon.com/jp/getting-started/guides/setup-cdk/)


AWS CDK(Python)でAWSサービスのデプロイまで試す

こんにちは！はやしです。
API Gatewayといえば、「API Gateway + LambdaでサーバレスなREST API」というイメージが強いですが、他のAWSサービスとも連携可能です。
今回はDynamoDBと連携してREST APIを構築したいと思います。
構築はIaC(AWS CDK)で行います。

# ローカル環境
- macOS 13.0.1
- cdk 2.51.1
- node 16.15.1

# 設計
「記事」のリソースが必要と仮定してAPIを構築します。
## API仕様
|メソッド|エンドポイント|概要|
|-|-|-|
|GET|/posts|記事一覧取得|
|GET|/posts/{id}|記事取得|
|POST|/posts/{id}|記事追加|
|PUT|/posts/{id}|記事更新|
|DELETE|/posts/{id}|記事削除|

## DB設計
|PK|項目名|型|
|-|-|-|
|○|id|String|
||title|String|
||content|String|
||createAt|Number|
||updatedAt|Number|

## AWS構成図
![](https://kokosyna-post-bucket-prd.s3.ap-northeast-1.amazonaws.com/bce13ed0-6b6b-4cfa-9076-f48fe36d21ad.webp)
API Gatewayでは「統合リクエスト」「統合レスポンス」を定義します。
- 統合リクエスト・・・DynamoDBにどのような操作(CRUD)をするのか定義します。
- 統合レスポンス・・・クライアントが必要としているデータ形式に整形します。

# 実装
CDKはAWSリソースをデプロイするためのツールです。
本記事での詳細な説明は割愛します。

## スタック
```typescript:agw-integrate-ddb-stack.ts
import * as cdk from "aws-cdk-lib";
import { Construct } from "constructs";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
import * as iam from "aws-cdk-lib/aws-iam";
import reqGetPost from "../src/agw/reqTemplates/reqGetPost";
import resGetPost from "../src/agw/resTemplates/resGetPost";
import { HttpMethod } from "aws-cdk-lib/aws-events";
import reqListPost from "../src/agw/reqTemplates/reqListPost";
import resListPost from "../src/agw/resTemplates/resListPost";
import reqDeletePost from "../src/agw/reqTemplates/reqDeletePost";
import reqPutPost from "../src/agw/reqTemplates/reqPutPost";
import reqUpdatePost from "../src/agw/reqTemplates/reqUpdatePost";
import resDeletePost from "../src/agw/resTemplates/resDeletePost";
import resPutPost from "../src/agw/resTemplates/resPutPost";
import resUpdatePost from "../src/agw/resTemplates/resUpdatePost";

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

    // DynamoDBテーブル
    const ddbTable = new dynamodb.Table(this, "PostTable", {
      tableName: "Post",
      partitionKey: {
        name: "id",
        type: dynamodb.AttributeType.STRING,
      },
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: cdk.RemovalPolicy.DESTROY,
    });

    // API Gateway
    const restApi = new apigateway.RestApi(this, "RestApi", {
      restApiName: "api",
      cloudWatchRole: true,
      deployOptions: {
        loggingLevel: apigateway.MethodLoggingLevel.ERROR,
        metricsEnabled: true,
        dataTraceEnabled: true,
      },
      defaultCorsPreflightOptions: {
        allowOrigins: apigateway.Cors.ALL_ORIGINS,
      },
    });

    // API GatewayがDynamoDBにアクセスするためのIAMロール
    const credentialsRole = new iam.Role(this, "AccessibleDdbRole", {
      assumedBy: new iam.ServicePrincipal("apigateway.amazonaws.com"),
    });

    // DynamoDBへのCRUD権限を付与
    ddbTable.grantReadWriteData(credentialsRole);

    // /posts/{id}のエンドポイントを作成する
    const posts = restApi.root.addResource("posts");
    const post = posts.addResource("{id}");

    // 【GET】/posts
    this.addMethod(
      posts,
      credentialsRole,
      HttpMethod.GET,
      dynamodb.Operation.SCAN,
      reqListPost,
      resListPost
    );

    // 【GET】/posts/{id}
    this.addMethod(
      post,
      credentialsRole,
      HttpMethod.GET,
      dynamodb.Operation.GET_ITEM,
      reqGetPost,
      resGetPost
    );
    // 【POST】/posts/{id}
    this.addMethod(
      post,
      credentialsRole,
      HttpMethod.POST,
      dynamodb.Operation.PUT_ITEM,
      reqPutPost,
      resPutPost
    );
    // 【PUT】/posts/{id}
    this.addMethod(
      post,
      credentialsRole,
      HttpMethod.PUT,
      dynamodb.Operation.UPDATE_ITEM,
      reqUpdatePost,
      resUpdatePost
    );
    // 【DELETE】/posts/{id}
    this.addMethod(
      post,
      credentialsRole,
      HttpMethod.DELETE,
      dynamodb.Operation.DELETE_ITEM,
      reqDeletePost,
      resDeletePost
    );
  }

  /**
   * API GatewayにHTTP Methodを追加する
   * @param resource メソッド追加対象のリソース
   * @param credentialsRole DynamoDBアクセス用のIAMロール
   * @param httpMethod 追加するHTTPメソッド
   * @param action DynamoDBの操作タイプ
   * @param requestTemplates 統合リクエストのテンプレート
   * @param responseTemplates  統合レスポンスのテンプレート
   */
  private addMethod(
    resource: apigateway.Resource,
    credentialsRole: iam.Role,
    httpMethod: HttpMethod,
    action: dynamodb.Operation,
    requestTemplates: {
      [contentType: string]: string;
    },
    responseTemplates: {
      [contentType: string]: string;
    }
  ) {
    resource.addMethod(
      httpMethod,
      new apigateway.AwsIntegration({
        service: "dynamodb",
        action,
        options: {
          credentialsRole,
          requestTemplates,
          integrationResponses: [
            {
              statusCode: "200",
              responseTemplates,
            },
          ],
        },
      }),
      {
        methodResponses: [
          {
            statusCode: "200",
          },
        ],
      }
    );
  }
}
```
DynamoDBへのアクセスの最小権限を一行で設定している部分や、使いまわす冗長なコードはメソッド化しているところがポイントです。

## 統合テンプレート
テンプレートはVTLエンジンで動作しています。
JavaScriptのような親しみのある言語がサポートされて欲しいですね。
意外と世に出回っているリファレンス少なく、試行錯誤で実装してみたので参考にしてみてください。
### 【GET】/posts
```typescript:reqListPost.ts
export default {
  "application/json": `{
    "TableName": "Post"
}`,
};
```
```typescript:resListPost.ts
export default {
  "application/json": `{
        #set($body=$input.path('$'))
        "data":[
            #foreach($item in $body.Items)
                {
                    "id": "$item.id.S",
                    "title": "$item.title.S",
                    "content": "$item.content.S",
                    "createdAt": "$item.createdAt.N",
                    "updatedAt": "$item.updatedAt.N"
                }
                #if($foreach.hasNext),#end
            #end
        ]
    }`,
};

```
### 【GET】/posts/{id}
```typescript:reqGetPost.ts
export default {
  "application/json": `{
    "TableName": "Post",
    "Key": {
        "id": {
            "S": "$input.params('id')"
        }
    }
}`,
};
```
```typescript:resGetPost.ts
export default {
  "application/json": `{
        #set($body=$input.path('$'))
        #if($body.Item.id.S!="")
            "id": "$body.Item.id.S",
            "title": "$body.Item.title.S",
            "content": "$body.Item.content.S",
            "createdAt": "$item.createdAt.N",
            "updatedAt": "$item.updatedAt.N"
        #end
    }`,
};
```
### 【POST】/posts/{id}
```typescript:reqPutPost.ts
export default {
  "application/json": `{
    "TableName": "Post",
    "Item": {
        "id": {
            "S": "$input.params('id')"
        },
        "title": {
            "S": $input.json('$.title')
        },
        "content": {
            "S": $input.json('$.content')
        },
        "createdAt": {
            "N": "$context.requestTimeEpoch"
        },
        "updatedAt": {
            "N": "$context.requestTimeEpoch"
        }
    }
}`,
};
```
```typescript:resPutPost.ts
export default {
    "application/json": `{}`
}
```
### 【PUT】/posts/{id}
```typescript:reqUpdatePost.ts
export default {
  "application/json": `{
    "TableName": "Post",
    "Key": {
        "id": {
            "S": "$input.params('id')"
        }
    },
    "AttributeUpdates": {
        #set($body=$input.path('$'))
        #if($body.title != "")
        "title": {
            "Action":"PUT",
            "Value":{
                "S": "$body.title"
            }
        },
        #end
        #if($body.content != "")
        "content": {
            "Action":"PUT",
            "Value":{
                "S": "$body.content"
            }
        },
        #end
        "updatedAt": {
            "Action":"PUT",
            "Value":{
                "N": "$context.requestTimeEpoch"
            }
        }
    }
}`,
};
```
```typescript:resUpdatePost.ts
export default {
    "application/json": `{}`
}
```
### 【DELETE】/posts/{id}
```typescript:reqDeletePost.ts
export default {
  "application/json": `{
    "TableName": "Post",
    "Key": {
        "id": {
            "S": "$input.params('id')"
        }
    }
}`,
};
```
```typescript:resDeletePost.ts
export default {
    "application/json": `{}`
}
```
# 動作確認
AWS コンソール上からAPI Gatewayの動作確認ができればOKです。
以下では記事のリストを取得できているのがわかります。
![](https://kokosyna-post-bucket-prd.s3.ap-northeast-1.amazonaws.com/a52c88b0-023b-48b5-b497-5defd74fe5ef.webp)

# まとめ
API GatewayとDynamoDBの間のLambdaをなくすことで、管理するリソースが減り、コストが削減され、パフォーマンスも向上します。
API統合が使える場面では積極的に採用していきたいですね。
ではまた👋