⛱️

Cfn組み込み関数に登場した「Fn::ForEach」についてcfn-language-discussionを読んで理解してみた。

2023/07/28に公開

AWS

foreach

CloudFormation

tech

Fn::ForEachが登場

2023年7月26日Cloudformarionに新しい組み込み関数「Fn::ForEach」が登場しました。

本記事ではこの組み込み関数を理解するにあたり、記事作成時点(※2023年7月2８日)公式ドキュメント上にある情報だけでは不十分であると感じ、cfn-language-discussionを一読した要点を抜粋したものになります。

この組み込み関数が出来るまでは

一例ですが、以下のようなものも存在しました。

現時点で公式ドキュメントと本関数に言及した記事

前提となる本組み込み関数の構文そのものや利用シーンについては主題の意図する所の外としますので、以下にお目通しいただき次章へ進んでいただけますと嬉しいです。

For=Looping?

「ループ」と聞いて思い浮かぶ処理

forと聞くと以下のような処理を想像します。
(個人的に利用する事が多いVBAの例)

Sub sample1()
	Dim i As Integer
	For i = 1 To 5
		MsgBox "こんにちは"
	Next i
End Sub

上から順番に処理し指定した条件になるまで工程をループします。

For Eachの例は以下です。

Sub sample2(
	Dim ws As Worksheet
	For Each ws In Worksheets
		ws.PrintPreview
	Next ws
Ends Sub

配列の中にある要素の数(Length)分ループします。

この組み込み関数が発表された際、その語感から「ループ機能がでた！」という声が当然あり個人的には自分でもうまく説明できないのですがぼんやりした違和感を覚えました。

その理由を考えてみたのですが、

CloudFormationはスタック実行時、裏でリソース間の参照・依存関係を読み取り、あるべき順にリソースが作成されるプログラムが走っています。

例えばVPCとサブネットを作成するテンプレートの場合,
VPCがないとサブネットは作成開始出来ない為、サブネット側には「どのVPCに作るの？」という設定項目が存在し、被参照側が参照側より早く作成されます。

DependsOnという依存関係を設定する事で、明示的に「こっちの方を先に作ってね(こっちが作り終わるまでそっちは走らせないでね)」と指定する事が出来、それ以外は参照・被参照関係に準拠します。

そして、依存関係の発生しないリソース同士はデプロイ速度が早く済むように並列で作成されるものです。

私が持っている先ほどの「ForEachループ」のイメージに当てはまるのであれば、配列から一つずつの要素を携え、他の処理を実行しないままリソースの作成をする動作でありそうですが、上記プログラム的な観点からいって依存関係を暗黙的に発生させて順次(並列ではなく)処理させる(或いはそうしか出来ない)機能という風な想像になりますがそんな動きするかなというのが疑問でした。

名前から受けるイメージ通り順次処理なのか確認してみた

二章目の記事内のSNS Topicを作成する例のコレクション(=配列)に以下を指定して実行しました。

sample1.yml

AWSTemplateFormatVersion: 2010-09-09
Transform: 'AWS::LanguageExtensions'
# ------------------------------------------------------------#
# Parameters
# ------------------------------------------------------------#
Resources:
  'Fn::ForEach::HogeLoopName':
    - HogeItems
    - [a,b,c,d,e,f,g,h,i,j,k,l]
    - 'Topic${HogeItems}':
        Type: 'AWS::SNS::Topic'
        Properties:
          TopicName: !Ref HogeItems