AWS CDK チュートリアル with TypeScript

$ node --version
v22.9.0

$ mkdir aws-cdk-example && cd aws-cdk-example
$ npx cdk init --language typescript

{
  "name": "aws-cdk-example",
  "version": "0.1.0",
  "bin": {
    "aws-cdk-example": "bin/aws-cdk-example.js"
  },
  "scripts": {
    "build": "tsc",
    "watch": "tsc -w",
    "test": "jest",
    "cdk": "cdk"
  },
  "devDependencies": {
    "@types/jest": "^29.5.12",
    "@types/node": "22.5.4",
    "jest": "^29.7.0",
    "ts-jest": "^29.2.5",
    "aws-cdk": "2.162.0",
    "ts-node": "^10.9.2",
    "typescript": "~5.6.2"
  },
  "dependencies": {
    "aws-cdk-lib": "2.162.0",
    "constructs": "^10.0.0",
    "source-map-support": "^0.5.21"
  }
}

$ npm uninstall jest ts-jest @types/jest

removed 287 packages, and audited 68 packages in 501ms

3 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

$ npm install --save-dev vitest

added 40 packages, and audited 108 packages in 2s

15 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

-    "test": "jest",
+    "test": "vitest run",
+    "test:watch": "vitest watch",

$ npm install --save dotenv

added 2 packages, and audited 110 packages in 396ms

16 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

$ npm install --save-dev rimraf

added 41 packages, and audited 151 packages in 1s

29 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

   "scripts": {
     "build": "tsc",
     "cdk": "cdk",
+    "clean": "rimraf {bin,lib}/*.{d.ts,js}",
     "test": "vitest",
     "watch": "tsc -w"
   },

$ npm install --save-dev --save-exact @biomejs/biome

added 2 packages, and audited 153 packages in 471ms

30 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

$ npx biome init --jsonc

Welcome to Biome! Let's get you started...

Files created

  - biome.jsonc
    Your project configuration. See https://biomejs.dev/reference/configuration

Next Steps

  1. Setup an editor extension
     Get live errors as you type and format when you save.
     Learn more at https://biomejs.dev/guides/integrate-in-editor/

  2. Try a command
     biome check  checks formatting, import sorting, and lint rules.
     biome --help displays the available commands.

  3. Migrate from ESLint and Prettier
     biome migrate eslint   migrates your ESLint configuration to Biome.
     biome migrate prettier migrates your Prettier configuration to Biome.

  4. Read the documentation
     Find guides and documentation at https://biomejs.dev/guides/getting-started/

  5. Get involved with the community
     Ask questions and contribute on GitHub: https://github.com/biomejs/biome
     Seek for help on Discord: https://discord.gg/BypW39g6Yc

{
  "$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
  "vcs": {
    "enabled": false,
    "clientKind": "git",
    "useIgnoreFile": false
  },
  "files": {
    "ignoreUnknown": false,
    "ignore": []
  },
  "formatter": {
    "enabled": true,
    "indentStyle": "tab"
  },
  "organizeImports": {
    "enabled": true
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  },
  "javascript": {
    "formatter": {
      "quoteStyle": "double"
    }
  }
}

{
  "$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
  "vcs": {
    // Biome の VCS 統合を有効にする
    "enabled": true,
    "clientKind": "git",
    // .gitignore に記述されたファイルを無視する
    "useIgnoreFile": true
  },
  "files": {
    "include": ["bin/**/*.ts", "lib/**/*.ts", "test/**/*.ts", "*.json", "*.jsonc"],
    "ignore": ["**/*.d.ts"]
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  },
  "formatter": {
    "enabled": true,
    "indentStyle": "space",
    "indentWidth": 2,
    "lineWidth": 120
  },
  "organizeImports": {
    "enabled": true
  },
  "javascript": {
    "formatter": {
      "quoteStyle": "single",
      "semicolons": "asNeeded"
    }
  }
}

     "cdk": "cdk",
+    "check": "biome check --write",
+    "check:dry-run": "biome check",
     "clean": "rimraf {bin,lib}/*.{d.ts,js}",

$ npm install --save-dev husky lint-staged

added 49 packages, and audited 202 packages in 3s

58 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

---
'*.{js,ts,json,jsonc}':
  - npm run check

-npm test
+npx lint-staged

import * as cdk from 'aws-cdk-lib'
import type { Construct } from 'constructs'

interface LambdaApiStackProps extends cdk.StackProps {
  hostedZoneName: string
}

export class LambdaApiStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props: LambdaApiStackProps) {
    super(scope, id, props)

    // TODO: 実装する
  }
}

import * as cdk from 'aws-cdk-lib'
import { Template } from 'aws-cdk-lib/assertions'
import { beforeAll, describe, it } from 'vitest'
import { LambdaApiStack } from '../lib/lambda-api-stack'

describe('LambdaApiStack', () => {
  let template: Template

  beforeAll(() => {
    const app = new cdk.App()
    const stack = new LambdaApiStack(app, 'TestStack', {
      hostedZoneName: 'example.org',
    })
    template = Template.fromStack(stack)
  })

  it('has hosted zone', () => {
    template.resourceCountIs('AWS::Route53::HostedZone', 1)
  })

  it('has hosted zone with the specified name', () => {
    template.hasResourceProperties('AWS::Route53::HostedZone', {
      Name: 'example.org.',
    })
  })
})

$ npm test

> aws-cdk-example@0.1.0 test
> vitest run


 RUN  v2.1.2 /Users/shogogg/work/aws-cdk-example

 ❯ test/lambda-api-stack.test.ts (2)
   ❯ LambdaApiStack (2)
     × has hosted zone
     × has hosted zone with the specified name

 export class LambdaApiStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props: LambdaApiStackProps) {
     super(scope, id, props)
+    const { hostedZoneName } = props
+
+    // Route 53: Hosted Zone
+    new route53.HostedZone(this, 'HostedZone', {
+      zoneName: hostedZoneName,
+    })
   }
 }

$ npm test

> aws-cdk-example@0.1.0 test
> vitest run


 RUN  v2.1.2 /Users/shogogg/work/aws-cdk-example

 ✓ test/lambda-api-stack.test.ts (2)
   ✓ LambdaApiStack (2)
     ✓ has hosted zone
     ✓ has hosted zone with the specified name

#!/usr/bin/env node
import 'source-map-support/register'
import * as cdk from 'aws-cdk-lib'
import * as dotenv from 'dotenv'
import { LambdaApiStack } from '../lib/lambda-api-stack'

// Load environment variables from .env file
dotenv.config()

const account = process.env.APP_AWS_ACCOUNT ?? process.env.CDK_DEFAULT_ACCOUNT
const region = process.env.APP_AWS_REGION ?? process.env.CDK_DEFAULT_REGION
const appName = process.env.APP_NAME ?? 'ExampleApp'
const hostedZoneName = process.env.APP_HOSTED_ZONE_NAME ?? 'example.com'

const app = new cdk.App()

new LambdaApiStack(app, `${appName}LambdaApiStack`, {
  env: {
    account,
    region,
  },
  hostedZoneName,
})

APP_NAME=ExampleApp
APP_HOSTED_ZONE_NAME=************
APP_AWS_ACCOUNT=************
APP_AWS_REGION=ap-northeast-1

$ npx cdk bootstrap
MFA token for arn:aws:iam::************:mfa/********: ******
 ⏳  Bootstrapping environment aws://************/ap-northeast-1...
Trusted accounts for deployment: (none)
Trusted accounts for lookup: (none)
Using default execution policy of 'arn:aws:iam::aws:policy/AdministratorAccess'. Pass '--cloudformation-execution-policies' to customize.
CDKToolkit: creating CloudFormation changeset...
 ✅  Environment aws://************/ap-northeast-1 bootstrapped.

-  "exclude": ["node_modules", "cdk.out"]
+  "exclude": ["node_modules", "cdk.out", "test"]

$ npm run build

> aws-cdk-example@0.1.0 build
> tsc

$ npx cdk list
ExampleAppLambdaApiStack

$ npx cdk synth
Resources:
  HostedZoneDB99F866:
    Type: AWS::Route53::HostedZone
    Properties:
      Name: ****************.
    Metadata:
      aws:cdk:path: ExampleAppLambdaApiStack/HostedZone/Resource
  CDKMetadata:
    Type: AWS::CDK::Metadata
    Properties:
      Analytics: v2:deflate64:H4sIAAAAAAAA/zPSMzQz0jNUTCwv1k1OydbNyUzSqw4uSUzO1kksL44vyi8tSTU11qv2yC8uSU2Jys9L1XFOy0PwakHcoNTi/NKi5NRanbz8lFS9rGL9MiMjPUs9A8Ws4sxM3aLSvJLM3FS9IAgNAJXDNSNzAAAA
    Metadata:
      aws:cdk:path: ExampleAppLambdaApiStack/CDKMetadata/Default
Parameters:
  BootstrapVersion:
    Type: AWS::SSM::Parameter::Value<String>
    Default: /cdk-bootstrap/hnb659fds/version
    Description: Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]

$ npx cdk deploy
MFA token for arn:aws:iam::************:mfa/********: ******

✨  Synthesis time: 7.22s

ExampleAppLambdaApiStack: start: Building 2ee87e0922900ea69049ccf5eda7714689d8af4fd6f998a367e8125exxxxxxxx:************-ap-northeast-1
ExampleAppLambdaApiStack: success: Built 2ee87e0922900ea69049ccf5eda7714689d8af4fd6f998a367e8125exxxxxxxx:************-ap-northeast-1
ExampleAppLambdaApiStack: start: Publishing 2ee87e0922900ea69049ccf5eda7714689d8af4fd6f998a367e8125exxxxxxxx:************-ap-northeast-1
ExampleAppLambdaApiStack: success: Published 2ee87e0922900ea69049ccf5eda7714689d8af4fd6f998a367e8125exxxxxxxx:************-ap-northeast-1
Stack undefined
ExampleAppLambdaApiStack: deploying... [1/1]
ExampleAppLambdaApiStack: creating CloudFormation changeset...

 ✅  ExampleAppLambdaApiStack

✨  Deployment time: 72.56s

Stack ARN:
arn:aws:cloudformation:ap-northeast-1:************:stack/ExampleAppLambdaApiStack/635d3fb0-xxxx-xxxx-xxxx-0ad8feee2f63

✨  Total time: 79.78s

$ npx cdk destroy
MFA token for arn:aws:iam::************:mfa/********: ******
Are you sure you want to delete: ExampleAppLambdaApiStack (y/n)? y
ExampleAppLambdaApiStack: destroying... [1/1]

 ✅  ExampleAppLambdaApiStack: destroyed

+  it('has lambda function', () => {
+    template.resourceCountIs('AWS::Lambda::Function', 1)
+  })
+
+  it('has lambda function with the specified runtime', () => {
+    template.hasResourceProperties('AWS::Lambda::Function', {
+      Runtime: 'nodejs20.x',
+    })
+  })

$ npm install --save-dev @types/aws-lambda

added 1 package, and audited 203 packages in 449ms

58 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda'

export const handler = async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
  // クエリパラメータで指定された挨拶を用いる
  const greeting = event.queryStringParameters?.greeting ?? 'Hello'

  // 環境変数で指定された名前を用いる
  const name = process.env.APP_GREETING_NAME ?? 'World'

  return {
    statusCode: 200,
    body: JSON.stringify({
      message: `${greeting}, ${name}!`,
    }),
  }
}

 export class LambdaApiStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props: LambdaApiStackProps) {
     super(scope, id, props)
     const { hostedZoneName } = props
 
+    // Lambda: Function
+    new lambdaNodejs.NodejsFunction(this, 'app', {
+      runtime: lambda.Runtime.NODEJS_20_X,
+    })
+
     // Route 53: Hosted Zone
     new route53.HostedZone(this, 'HostedZone', {
       zoneName: hostedZoneName,
     })
   }
 }

$ npm test

+  it('has API Gateway REST API', () => {
+    template.resourceCountIs('AWS::ApiGateway::RestApi', 1)
+  })
+
+  it('has API Gateway Resource', () => {
+    template.resourceCountIs('AWS::ApiGateway::Resource', 1)
+  })
+
+  it('has API Gateway Resource with the specified path', () => {
+    template.hasResourceProperties('AWS::ApiGateway::Resource', {
+      PathPart: 'example',
+    })
+  })

     // Lambda: Function
-    lambdaNodejs.NodejsFunction(this, 'app', {
+    const apiFunction = new lambdaNodejs.NodejsFunction(this, 'app', {
       runtime: lambda.Runtime.NODEJS_20_X,
     })
+
+    // API Gateway: Routing
+    const api = new apiGateway.RestApi(this, 'ApiGateway')
+    api.root.addResource('example').addMethod('GET', new apiGateway.LambdaIntegration(apiFunction))

 interface LambdaApiStackProps extends cdk.StackProps {
   hostedZoneName: string
+  domainName: string
 }

 const hostedZoneName = process.env.APP_HOSTED_ZONE_NAME ?? 'example.com'
+const domainName = process.env.APP_DOMAIN_NAME ?? 'api.example.com'

 const app = new cdk.App()

 new LambdaApiStack(app, `${appName}LambdaApiStack`, {
   env: {
     account,
     region
   },
   hostedZoneName,
+  domainName
 })

   beforeAll(() => {
     const app = new cdk.App()
     const stack = new LambdaApiStack(app, 'TestStack', {
       hostedZoneName: 'example.org',
+      domainName: 'api.example.org',
     })
     template = Template.fromStack(stack)
   })

+  it('has ACM certificate', () => {
+    template.resourceCountIs('AWS::CertificateManager::Certificate', 1)
+  })
+
+  it('has ACM certificate with the specified domain name', () => {
+    template.hasResourceProperties('AWS::CertificateManager::Certificate', {
+      DomainName: 'api.example.org',
+    })
+  })

     super(scope, id, props)
+    const { hostedZoneName, domainName } = props
 
     // Lambda: Function
     const apiFunction = new lambdaNodejs.NodejsFunction(this, 'app', {
       runtime: lambda.Runtime.NODEJS_20_X,
     })
 
     // API Gateway: Routing
     const api = new apiGateway.RestApi(this, 'ApiGateway')
     api.root.addResource('example').addMethod('GET', new apiGateway.LambdaIntegration(apiFunction))
 
     // Route 53: Hosted Zone
-    new route53.HostedZone(this, 'HostedZone', {
+    const hostedZone = new route53.HostedZone(this, 'HostedZone', {
       zoneName: hostedZoneName,
     })
+
+    // ACM: Certificate
+    new certificationManager.Certificate(this, 'Certificate', {
+      domainName,
+      validation: certificationManager.CertificateValidation.fromDns(hostedZone),
+    })

+  it('has API Gateway Custom Domain', () => {
+    template.resourceCountIs('AWS::ApiGateway::DomainName', 1)
+  })
+
+  it('has API Gateway Custom Domain with the specified domain name', () => {
+    template.hasResourceProperties('AWS::ApiGateway::DomainName', {
+      DomainName: 'api.example.org',
+    })
+  })

     // ACM: Certificate
-    new certificationManager.Certificate(this, 'Certificate', {
+    const certificate = new certificationManager.Certificate(this, 'Certificate', {
       domainName,
       validation: certificationManager.CertificateValidation.fromDns(hostedZone),
     })
+
+    // API Gateway: Custom Domain
+    const customDomain = new apiGateway.DomainName(this, 'CustomDomain', {
+      domainName,
+      certificate,
+      securityPolicy: apiGateway.SecurityPolicy.TLS_1_2,
+      endpointType: apiGateway.EndpointType.REGIONAL,
+    })
+    customDomain.addBasePathMapping(api)

+  it('has Route 53 RecordSet', () => {
+    template.resourceCountIs('AWS::Route53::RecordSet', 1)
+  })
+
+  it('has Route 53 RecordSet with the specified domain name', () => {
+    template.hasResourceProperties('AWS::Route53::RecordSet', {
+      Name: 'api.example.org.',
+    })
+  })
+
+  it('has Route 53 RecordSet with the specified type', () => {
+    template.hasResourceProperties('AWS::Route53::RecordSet', {
+      Type: 'A',
+    })
+  })

     customDomain.addBasePathMapping(api)
+
+    // Route 53: Record
+    new route53.ARecord(this, 'ARecord', {
+      zone: hostedZone,
+      recordName: domainName,
+      target: route53.RecordTarget.fromAlias(new route53Targets.ApiGatewayDomain(customDomain)),
+    })

$ npx cdk deploy
（略）

$ curl "https://api.shogogg.eustylelab.net/example"
{"message": "Hello, World!"}

$ curl "https://api.shogogg.eustylelab.net/example?greeting=Hi"
{"message": "Hi, World!"}

     // Lambda: Function
     const apiFunction = new lambdaNodejs.NodejsFunction(this, 'app', {
       runtime: lambda.Runtime.NODEJS_20_X,
+      environment: {
+        APP_GREETING_NAME: 'Lambda',
+      },
     })

$ npx cdk deploy
（略）

$ curl "https://api.shogogg.eustylelab.net/example"
{"message": "Hello, Lambda!"}

$ curl "https://api.shogogg.eustylelab.net/example?greeting=Hi"
{"message": "Hi, Lambda!"}

import * as cdk from 'aws-cdk-lib'
import * as apiGateway from 'aws-cdk-lib/aws-apigateway'
import * as certificationManager from 'aws-cdk-lib/aws-certificatemanager'
import * as lambda from 'aws-cdk-lib/aws-lambda'
import * as lambdaNodejs from 'aws-cdk-lib/aws-lambda-nodejs'
import * as route53 from 'aws-cdk-lib/aws-route53'
import * as route53Targets from 'aws-cdk-lib/aws-route53-targets'
import type { Construct } from 'constructs'

interface LambdaApiStackProps extends cdk.StackProps {
  hostedZoneName: string
  domainName: string
}

export class LambdaApiStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props: LambdaApiStackProps) {
    super(scope, id, props)
    const { hostedZoneName, domainName } = props

    // Lambda: Function
    const apiFunction = new lambdaNodejs.NodejsFunction(this, 'app', {
      runtime: lambda.Runtime.NODEJS_20_X,
      environment: {
        APP_GREETING_NAME: 'Lambda',
      },
    })

    // API Gateway: Routing
    const api = new apiGateway.RestApi(this, 'ApiGateway')
    api.root.addResource('example').addMethod('GET', new apiGateway.LambdaIntegration(apiFunction))

    // Route 53: Hosted Zone
    const hostedZone = new route53.HostedZone(this, 'HostedZone', {
      zoneName: hostedZoneName,
    })

    // ACM: Certificate
    const certificate = new certificationManager.Certificate(this, 'Certificate', {
      domainName,
      validation: certificationManager.CertificateValidation.fromDns(hostedZone),
    })

    // API Gateway: Custom Domain
    const customDomain = new apiGateway.DomainName(this, 'CustomDomain', {
      domainName,
      certificate,
      securityPolicy: apiGateway.SecurityPolicy.TLS_1_2,
      endpointType: apiGateway.EndpointType.REGIONAL,
    })
    customDomain.addBasePathMapping(api)

    // Route 53: Record
    new route53.ARecord(this, 'ARecord', {
      zone: hostedZone,
      recordName: domainName,
      target: route53.RecordTarget.fromAlias(new route53Targets.ApiGatewayDomain(customDomain)),
    })
  }
}