[JAWS-UG CLI] StepFunctions #6 ステートマシンの作成 (RetryStateMachine)

前提条件

StepFunctionsへの権限

StepFunctionsに対してフル権限があること。

AWS CLIのバージョン

以下のバージョンで動作確認済

• AWS CLI 1.11.63

コマンド

aws --version

結果(例):

  aws-cli/1.11.63 Python/2.7.10 Darwin/15.6.0 botocore/1.5.26

バージョンが古い場合は最新版に更新しましょう。

コマンド

sudo -H pip install -U awscli

1. 準備
   =======

まず変数の確認をします。

変数の確認

cat << ETX

        AWS_DEFAULT_PROFILE: (0.1) ${AWS_DEFAULT_PROFILE}
        AWS_DEFAULT_REGION:  (0.2) ${AWS_DEFAULT_REGION}
        DIR_CONF:            (0.3) ${DIR_CONF}
        IAM_ROLE_ARN:        (0.4) ${IAM_ROLE_ARN}
        LAMBDA_FUNC_ARN:     (0.5) ${LAMBDA_FUNC_ARN}

ETX

結果(例):

  AWS_DEFAULT_PROFILE: (0.1) stepfunctionsas_full-prjZ-mbp13
  AWS_DEFAULT_REGION:  (0.2) ap-northeast-1
  DIR_CONF:            (0.3) conf-stepfunctions
  IAM_ROLE_ARN:        (0.4) arn:aws:iam::XXXXXXXXXXXX:role/states-lambda-role
  LAMBDA_FUNC_ARN:     (0.5) arn:aws:lambda:ap-northeast-1:XXXXXXXXXXXX:function:FailFunction

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を
行います。

0.1. プロファイルの指定

プロファイルの一覧を確認します。

コマンド

cat ~/.aws/credentials \
       | grep '\[' \
       | sed 's/\[//g' | sed 's/\]//g'

結果(例):

  iamFull-prjz-mbpr13
  stepfunctionsas_full-prjZ-mbp13

変数の設定

export AWS_DEFAULT_PROFILE='stepfunctionsas_full-prjZ-mbp13'

0.2. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.3. 設定ファイル用ディレクトリの指定

変数の設定

DIR_CONF='conf-stepfunctions'

コマンド

mkdir -p ${DIR_CONF}

0.4. IAMロールの指定

IAMロールを指定します。

変数の設定

IAM_ROLE_NAME='states-lambda-role'

ARNを取得します。

コマンド

IAM_ROLE_ARN=$( \
        aws iam get-role \
          --role-name ${IAM_ROLE_NAME} \
          --query 'Role.Arn' \
          --output text \
) \
        && echo ${IAM_ROLE_ARN}

結果(例):

  arn:aws:iam::XXXXXXXXXXXX:role/states-lambda-role

0.5. Lambda関数の指定

Lambda関数を指定します。

変数の設定

LAMBDA_FUNC_NAME='FailFunction'

ARNを取得します。

コマンド

LAMBDA_FUNC_ARN=$( \
        aws lambda get-function \
          --function-name ${LAMBDA_FUNC_NAME} \
          --query 'Configuration.FunctionArn' \
          --output text \
) \
        && echo ${LAMBDA_FUNC_ARN}

結果(例):

  arn:aws:lambda:ap-northeast-1:XXXXXXXXXXXX:function:FailFunction

1. 事前作業
   ===========

1.1. ステートマシン名の決定

変数の設定

STEPF_STATEM_NAME='RetryStateMachine'

同名のステートマシンが存在しないことを確認します。

コマンド

aws stepfunctions list-state-machines \
        --query "stateMachines[?name == \`${STEPF_STATEM_NAME}\`]"

結果(例):

  []

1.2. ステートマシン定義ファイルの作成

変数の設定

FILE_INPUT="${STEPF_STATEM_NAME}.json" \
        && echo ${FILE_INPUT}

コマンド

cat << EOF > ${FILE_INPUT}
{
         "Comment": "A Catch example of the Amazon States Language using an AWS Lambda Function",
         "StartAt": "CreateAccount",
         "States": {
            "CreateAccount": {
               "Type": "Task",
               "Resource": "${LAMBDA_FUNC_ARN}",
               "Catch": [ {
                  "ErrorEquals": ["AccountAlreadyExistsError"],
                  "Next": "CustomErrorFallback"
               }, {
                  "ErrorEquals": ["States.TaskFailed"],
                  "Next": "ReservedTypeFallback"
               }, {
                  "ErrorEquals": ["States.ALL"],
                  "Next": "CatchAllFallback"
               } ],
              "End": true
            },
            "CustomErrorFallback": {
               "Type": "Pass",
               "Result": "This is a fallback from a custom Lambda function exception",
               "End": true
            },
            "ReservedTypeFallback": {
               "Type": "Pass",
               "Result": "This is a fallback from a reserved error code",
               "End": true
            },
            "CatchAllFallback": {
               "Type": "Pass",
               "Result": "This is a fallback from any error code",
               "End": true
            }
         }
}
EOF

cat ${FILE_INPUT}

JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。

コマンド

jsonlint -q ${FILE_INPUT}

エラーが出力されなければOKです。

1. ステートマシンの作成
   =======================

変数の確認

cat << ETX

        STEPF_STATEM_NAME: ${STEPF_STATEM_NAME}
        FILE_INPUT:        ${FILE_INPUT}
        IAM_ROLE_ARN:      ${IAM_ROLE_ARN}

ETX

コマンド

aws stepfunctions create-state-machine \
        --name ${STEPF_STATEM_NAME} \
        --definition file://${FILE_INPUT} \
        --role-arn ${IAM_ROLE_ARN}

結果(例):

      {
        "creationDate": 1489740033.593,
        "stateMachineArn": "arn:aws:states:ap-northeast-1:XXXXXXXXXXXX:stateMachine:RetryStateMachine"
      }

1. 事後作業
   ===========

3.1. ARNの取得

コマンド

STEPF_STATEM_ARN=$( \
        aws stepfunctions list-state-machines \
          --query "stateMachines[?name == \`${STEPF_STATEM_NAME}\`]".stateMachineArn \
          --output text \
) \
        && echo ${STEPF_STATEM_ARN}

結果(例):

  arn:aws:states:ap-northeast-1:XXXXXXXXXXXX:stateMachine:RetryStateMachine

3.2. ステートマシンのステータス確認

コマンド

STEPF_STATEM_STATUS=$( \
        aws stepfunctions describe-state-machine \
          --state-machine-arn ${STEPF_STATEM_ARN} \
          --query "status" \
          --output text \
) \
        && echo ${STEPF_STATEM_STATUS}

結果(例):

  ACTIVE

3.3. ステートマシンの確認

コマンド

aws stepfunctions describe-state-machine \
        --state-machine-arn ${STEPF_STATEM_ARN}

結果(例):

  (yet)

完了