Step FunctionsのChoiceを使用した条件分岐

2022-11-262024-04-22

Step FunctionsのChoiceを使用した条件分岐

AWS DVAの出題範囲であるリファクタリングに関する内容です。

以下のページで、Step Functionsの基本的な事項について取り上げました。

https://awstut.com/2022/06/18/introduction-to-step-functions-with-cfn

上記のページでは、2つのステートで構成されたシンプルなステートマシンを構築しました。
今回は選択ステートを使用して、条件に応じて処理が分岐するステートマシンを構築することを目指します。

構築する環境

Diagram of Step Functions - Conditional branching using Choice State

Step Functionsステートマシン内に、3つのステートを定義します。

各ステートは、以下のLambda関数を実行するタスクとします。

Lambda関数1：現在日時情報からUNIX時間を計算し、これが偶数か奇数か判定する。
Lambda関数2：偶数であること旨の文字列を返す。
Lambda関数3：奇数であること旨の文字列を返す。

関数のランタイム環境はPython3.8とします。

最初のステートが完了後、選択ステートで次に実行するステートを分岐させます。
分岐の条件は、偶数/奇数の判定結果に応じて行います。
この値が偶数の判定だった場合は、Lambda関数2のステートが選ばれ、奇数の判定だった場合は、Lambda関数3のステートが選ばれます。

CloudFormationテンプレートファイル

上記の構成をCloudFormationで構築します。
以下のURLにCloudFormationテンプレートを配置しています。

https://github.com/awstut-an-r/awstut-dva/tree/main/04/003

テンプレートファイルのポイント解説

Lambda関数

関数1

Resources:
  Function1:
    Type: AWS::Lambda::Function
    Properties:
      Code:
        ZipFile: |
          import datetime
          import time

          def lambda_handler(event, context):
            now = datetime.datetime.now()
            epoch_time = int(time.mktime(now.timetuple()))

            return {
              'now':  now.strftime('%Y%m%d%H%M%S%f'),
              'epoch_time': {
                'value': epoch_time,
                'is_even': (not bool(epoch_time % 2))
              }
            }
      FunctionName: !Sub "${Prefix}-function-01"
      Handler: !Ref Handler
      Runtime: !Ref Runtime
      Role: !GetAtt FunctionRole.Arn
Code language: YAML (yaml)

Step Functionsで実行する上で、特別な設定は不要です。

実行するコードに注目します。

現在日時を取得し、これをUNIX時間に変換します。
このUNIX時間の数値を2で割った時の余りを求め、これから偶数/奇数を判定します。

return文で辞書型オブジェクトを返します。
例えば以下のようなオブジェクトとなります。

{
  "now": "20221117135316055513",
  "epoch_time": {
    "value": 1668693196,
    "is_even": True
  }
}
Code language: JSON / JSON with Comments (json)

関数2

Lambdaそのものは関数1と同様です。
実行するコードに注目します。

import datetime
import time

def lambda_handler(event, context):
  return '{epoch_time} is even !'.format(
    epoch_time=event['epoch_time']['value'])
Code language: YAML (yaml)

偶数である旨の文字列を返します。

文字列を作成するために、eventオブジェクトを参照します。
このeventは、関数1で生成される辞書型オブジェクトと同様の構造を持っているものとします。

関数3

import datetime
import time

def lambda_handler(event, context):
  return '{epoch_time} is even !'.format(
    epoch_time=event['epoch_time']['value'])
Code language: YAML (yaml)

こちらも実行するコードに注目します。

内容は関数2とほとんど同様です。
eventオブジェクトを参照し、奇数である旨の文字列を返します。

Step Functions

Resources:
  StateMachine:
    Type: AWS::StepFunctions::StateMachine
    Properties:
      Definition:
        Comment: !Sub "${Prefix}-StateMachine"
        StartAt: FirstState
        States:
          FirstState:
            Type: Task
            Resource: !Ref FunctionArn1
            Next: ChoiceState
          ChoiceState:
            Type: Choice
            Choices:
              - Variable: $.epoch_time.is_even
                BooleanEquals: true
                Next: EvenState
              - Variable: $.epoch_time.is_even
                BooleanEquals: false
                Next: OddState
          EvenState:
            Type: Task
            Resource: !Ref FunctionArn2
            End: true
          OddState:
            Type: Task
            Resource: !Ref FunctionArn3
            End: true
      LoggingConfiguration:
        Destinations:
          - CloudWatchLogsLogGroup:
              LogGroupArn: !GetAtt LogGroup.Arn
        IncludeExecutionData: true
        Level: ALL
      RoleArn: !GetAtt StateMachineRole.Arn
      StateMachineName: !Ref Prefix
      StateMachineType: STANDARD
Code language: YAML (yaml)

ステートマシン全体の構造を確認します。

StartAtプロパティを見ると、FirstStateから処理が開始されることがわかります。
FirstStateでは、関数1を実行します。

その後ChoiceStateに移行し、FirstStateから返ってきた値を参照して、条件分岐の判定が行われます。
「$.epoch_time.is_even」のような記法で参照先を指定することができます。
今回は組み込み関数BooleanEqualsを使用して、真理値を判定します。
この値がtrueの場合、EventStateに移行し、falseの場合はOddStateに移行します。

EventState・OddStateでは、それぞれ関数2・関数3を実行します。
各ステートの終了後、ステートマシン全体の処理が完了となります。