💻

デプロイをするときにCDKでよく使うコマンド一覧

2025/02/22に公開

はじめに

AWS をソースコードで管理するのに CDK があると知ったためまとめました。

学習では公式チュートリアルを実際に動かしてみるのをオススメします。
https://catalog.workshops.aws/typescript-and-cdk-for-beginner/ja-JP/40-cdk-introduction/10-create-project/10-cdk-init

CDK を使うとコマンドを叩くだけで AWS のリソースをすぐ作れるため
同じリソースをミスなくすぐに作れます。

コマンド

  • テンプレートファイル作成

init コマンドを使うとテンプレートコマンドが作成されます。

cdk init sample-app --language=typescript

実行すると下記ファイルが生成されます。

tree -I "node_modules/"

cdk_workshop/
|-- bin
|   |-- cdk_workshop.ts
|-- lib
|   |-- cdk_workshop-stack.ts
|-- test
|   |-- cdk_workshop.test.ts
|-- node_modules/
|-- README.md
|-- cdk.json
|-- jest.config.js
|-- package-lock.json
|-- package.json
|-- tsconfig.json
|-- .npmignore
|-- .gitignore
  • CloudFormation のテンプレート確認

CDK では ソースコードから CloudFormation が作成されます。synth コマンドでどのような CloudFormation のテンプレートが出力されるか確認できます。

cdk synth
  • 初めてデプロイするとき

デプロイをする前に実行します。

cdk bootstrap
  • 差分確認
cdk diff
  • デプロイ
cdk deploy

https://docs.aws.amazon.com/ja_jp/cdk/v2/guide/ref-cli-cmd-deploy.html

  • リソースの削除

リソースの作りっぱなしは料金が発生するので
今後、使用する予定がない場合は必ず削除コマンドを実行しましょう!

cdk destroy

参考

  • チュートリアル

https://catalog.workshops.aws/typescript-and-cdk-for-beginner/ja-JP

  • ドキュメント

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-construct-library.html

  • 実際のチュートリアルの様子

https://zenn.dev/mo_ri_regen/scraps/59400f57fb72e0

GitHubで編集を提案

Discussion