AWS CDK の設計では Construct の構造も意識しよう！

2024/11/01 に開催された「クラスメソッドのCDK事情大公開スペシャル#1」の登壇資料です。
https://classmethod.connpass.com/event/332020/

Transcript

1. 若槻⿓太 クラスメソッド株式会社 AWS CDK の設計では Construct の構造も意識しよう！
2. ⾃⼰紹介 2 • 若槻⿓太 • 2019年11⽉クラスメソッド⼊社 • 製造ビジネステクノロジー部 所属 • 主な業務 ◦ 各種アプリケーション開発 ◦ プラットフォームエンジニアリング ◦ 投資領域（デジタルツインなど） • 2024 Japan AWS Top Engineers 選出 • 2024 AWS Community Builders 選出 https://dev.classmethod.jp/author/wakatsuki-ryuta/
3. AWS CDK で管理しているリソースの情報を マネジメントコンソールから確認したい 3
4. サービスページのリソース⼀覧から⽬当てのリソースを探す 4
5. サービスページのリソース⼀覧から⽬当てのリソースを探す 5 ⾟いポイント • リソース名 が CDK で⾃動⽣成され ている • ⼿動での命名でも⻑い似たような 名前になりがち • すべての Cfn スタックのリソースが 表⽰される
6. どうすれば認知負荷を下げられるか？ 6
7. CloudFormation のツリービューを利⽤する 7
8. CloudFormation のツリービューを利⽤する 8 ⽬当てのリソースの論理 ID までツ リーを展開し、対応する物理 ID から リソースページに直接アクセスする
9. CloudFormation のツリービューを利⽤する 9 ⽬当てのリソースの論理 ID までツ リーを展開し、対応する物理 ID から リソースページに直接アクセスする サービスページから直接リソースを探すよりも良さそう！
10. CloudFormation のツリービューを利⽤する 10 このリソースのツリー構造は、CDK ではコ ンストラクト構造の作り⽅で決まる
11. どのようなコンストラクト構造で作るべきか？ 11
12. どのようなコンストラクト構造で作るべきか？ 12 https://speakerdeck.com/winteryukky/aws-cdk-construct-partition-strategy-implementing-level-oriented-practice?slide=9 WinterYukky「AWS CDK コンストラクトの分割戦略: レベル指向プラクティス」
13. どのようなコンストラクト構造で作るべきか？ 13 • リソースグループカット ◦ リソース種類単位でのコンストラクト分割 • コンポーネントカット ◦ サービス単位でのコンストラクト分割
14. 例えば、このようなサーバーレスシステムを CDK で構築したい 14
15. リソース種類単位でコンストラクトを分割する 15 • リソースグループカット ◦ リソース種類単位でのコンストラクト分割 • コンポーネントカット ◦ サービス単位でのコンストラクト分割 こちらを使って やってみる
16. リソース種類単位でコンストラクトを分割する 16
17. リソース種類単位でコンストラクトを分割する 17 DynamoDB
18. リソース種類単位でコンストラクトを分割する 18 Lambda
19. リソース種類単位でコンストラクトを分割する 19 API Gateway
20. リソース種類単位でコンストラクトを分割する 20 EventBridge
21. リソース種類単位でコンストラクトを分割する 21 ⼀⾒良さそうだが、本当にこれで良いのか？
22. ユースケースを考える：Lambda 関数のログを参照したい 22 500エラーが返る API Function の ログを調査したい
23. スタック内に Lambda 関数が多数あると... 23
24. スタック内に Lambda 関数が多数あると... 24 どれが⽬当ての Lambda 関数なんだっけ？
25. スタック内に Lambda 関数が多数あると... 25 どれが⽬当ての Lambda 関数なんだっけ？ やはり⾟さがある...
26. 2つの分割⽅法を組み合わせる 26 • リソースグループカット ◦ リソース種類単位でのコンストラクト分割 • コンポーネントカット ◦ サービス単位でのコンストラクト分割 両⽅を組み合わせ て使ってみたらど うか
27. 2つの分割⽅法を組み合わせる 27
28. 2つの分割⽅法を組み合わせる 28 • リソースグループカット ◦ リソース種類単位でのコンストラクト ▪ 複数のサービスから依存されうるリソース • データベース、ユーザーディレクトリ、ネットワークなど • コンポーネントカット ◦ サービス単位でのコンストラクト ▪ ある⼀連の処理を実現する⽬的にのみ使⽤される同期的に動作するリソース群 • 複数のサービスが依存するリソースは含まない • ⼀時テーブルやクエリ⽤インデックスは含んでもよいかも
29. 2つの分割⽅法を組み合わせる 29 HogeAPI Service
30. 2つの分割⽅法を組み合わせる 30 FugaBatch Service
31. 2つの分割⽅法を組み合わせる 31 DynamoDB Resource
32. 2つの分割⽅法を組み合わせる 32
33. 2つの分割⽅法を組み合わせる 33 DynamoDB Resource
34. 2つの分割⽅法を組み合わせる 34 HogeAPI Service
35. 2つの分割⽅法を組み合わせる 35 FugaBatch Service
36. ユースケースを考える：Lambda 関数のログを参照したい 36 500エラーが返る API Function の ログを調査したい
37. ユースケースを考える：Lambda 関数のログを参照したい 37
38. ユースケースを考える：Lambda 関数のログを参照したい 38 Service -> HogeAPI -> Function と展 開し、対応する物理 ID からリソース ページに直接アクセスする
39. ユースケースを考える：Lambda 関数のログを参照したい 39 ⼤きな認知負荷なくアクセスができる！ Service -> HogeAPI -> Function と展 開し、対応する物理 ID からリソース ページに直接アクセスする
40. CDK のコード実装側も合わせて改善できる 40 ディレクトリ構造 スタックコード
41. CDK のコード実装側も合わせて改善できる 41 ディレクトリ構造 スタックコード 依存⽅向 依存⽅向 リソースの依存関係とサービスの境界が直感的になる！
42. • CloudFormation のツリービューを活⽤しよう • コンストラクト分割は、リソース種類単位とサービ ス単位を組み合わせて⾏うと良さげ • 上記を意識するとコンストラクト構造が直感的にな り、開発‧運⽤上の認知負荷を低減できる ◦ マネコンからのリソース探索時 ◦ CDK コードによる開発時 まとめ 42