サポート対象 APIs Amazon ECSタスクへのデータの受け渡し IAM ポリシー

Step Functions を使用して Amazon ECSまたは Fargate タスクを実行する

Step Functions を Amazon ECSまたは Fargate と統合してタスクを実行および管理する方法を説明します。Amazon ではECS、タスクは計算の基本単位です。タスクは、コンテナイメージ、CPUメモリ制限、ネットワーク設定、その他のパラメータなど、Docker コンテナの実行方法を指定するタスク定義によって定義されます。このページには、利用可能な Amazon ECSAPIアクションと、Step Functions を使用して Amazon ECSタスクにデータを渡す方法の説明が記載されています。

との統合について学ぶには AWS Step Functions のサービスについては、サービスとの統合「」および「」を参照してくださいStep Functions APIのサービスへのパラメータの受け渡し。

最適化された Amazon ECS/Fargate 統合の主な機能

ジョブの実行 (.sync) 統合パターンがサポートされています。
ecs:runTask は 200 HTTP レスポンスを返すことができますが、次のように空でないFailuresフィールドがあります。
- [リクエストレスポンス]: レスポンスを返し、タスクは失敗しません。これは、最適化なしと同じです。
- [ジョブを実行する]: 空でない Failures フィールドが検出された場合、AmazonECS.Unknown エラーが発生し、タスクは失敗します。

サポートされている Amazon ECS/Fargate APIs

RunTask は、指定されたタスク定義を使用して新しいタスクを開始します。
- リクエストの構文
- サポートされているパラメータ:
- レスポンスの構文

のパラメータ Step Functions はで表されます。 PascalCase

API アクション camelCaseなどのネイティブサービスAPIがにある場合でもstartSyncExecution、などのパラメータをで指定します PascalCaseStateMachineArn。

Amazon ECSタスクへのデータの受け渡し

overrides を使用してコンテナのデフォルトコマンドを上書きし、Amazon ECSタスクに入力を渡すことができます。「ContainerOverride」を参照してください。この例では、 JsonPath を使用して、入力Taskから Task状態に値を渡しています。

以下には、Amazon ECSタスクを実行し、完了するのを待機するTask状態が含まれています。


{
 "StartAt": "Run an ECS Task and wait for it to complete",
 "States": {
   "Run an ECS Task and wait for it to complete": {
     "Type": "Task",
     "Resource": "arn:aws:states:::ecs:runTask.sync",
     "Parameters": {
                "Cluster": "cluster-arn",
                "TaskDefinition": "job-id",
                "Overrides": {
                    "ContainerOverrides": [
                        {
                            "Name": "container-name",
                            "Command.$": "$.commands" 
                        }
                    ]
                }
            },
     "End": true
    }
  }
}

ContainerOverrides の "Command.$": "$.commands" 行は状態の入力からコンテナにコマンドを渡します。

前の例では、実行への入力が次の場合、各コマンドはコンテナのオーバーライドとして渡されます。


{
  "commands": [
    "test command 1",
    "test command 2",
    "test command 3"
  ]
}

以下には、Amazon ECSタスクを実行し、タスクトークンが返されるのを待機する Task 状態が含まれています。「タスクトークンによるコールバックを待つ」を参照してください。


{  
   "StartAt":"Manage ECS task",
   "States":{  
      "Manage ECS task":{  
         "Type":"Task",
         "Resource":"arn:aws:states:::ecs:runTask.waitForTaskToken",
         "Parameters":{  
            "LaunchType":"FARGATE",
            "Cluster":"cluster-arn",
            "TaskDefinition":"job-id",
            "Overrides":{  
               "ContainerOverrides":[  
                  {  
                     "Name":"container-name",
                     "Environment":[  
                        {  
                           "Name":"TASK_TOKEN_ENV_VARIABLE",
                           "Value.$":"$$.Task.Token"
                        }
                     ]
                  }
               ]
            }
         },
         "End":true
      }
   }
}

IAM Amazon ECS/ を呼び出すためのポリシーAWS Fargate

次のサンプルテンプレートは、 AWS Step Functions は、ステートマシン定義のリソースに基づいてIAMポリシーを生成します。詳細については、「Step Functions が統合サービスのIAMポリシーを生成する方法」および「Step Functions でサービス統合パターンを検出する」を参照してください。

TaskId の値は、タスクが送信されるまで不明なため、Step Functions は、権限の高い "Resource": "*" ポリシーを作成します。

注記

"*" IAM ポリシーにかかわらず、Step Functions によって開始された Amazon Elastic Container Service (Amazon ECS) タスクのみを停止できます。

Run a Job (.sync)

静的リソース


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ecs:RunTask"
            ],
            "Resource": [
                "arn:aws:ecs:[[region]]:
[[accountId]]:task-definition/[[taskDefinition]]:[[revisionNumber]]"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "ecs:StopTask",
                "ecs:DescribeTasks"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
               "arn:aws:events:[[region]]:
[[accountId]]:rule/StepFunctionsGetEventsForECSTaskRule"
            ]
        }
    ]
}

動的リソース


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ecs:RunTask",
                "ecs:StopTask",
                "ecs:DescribeTasks"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
               "arn:aws:events:[[region]]:
[[accountId]]:rule/StepFunctionsGetEventsForECSTaskRule"
            ]
        }
    ]
}

Request Response and Callback (.waitForTaskToken)

静的リソース


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ecs:RunTask"
            ],
            "Resource": [
                "arn:aws:ecs:[[region]]:
[[accountId]]:task-definition/[[taskDefinition]]:[[revisionNumber]]"
            ]
        }
    ]
}

動的リソース


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ecs:RunTask"
            ],
            "Resource": "*"
        }
    ]
}

スケジュールされた Amazon ECSタスクでタスク実行ロール、タスクロール、またはタスクロールの上書きを使用する必要がある場合は、各タスク実行ロール、タスクロール、またはタスクロールの上書きのiam:PassRoleアクセス許可を、呼び出し元のエンティティの CloudWatch イベントIAMロールに追加する必要があります。この場合、Step Functions です。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon DynamoDB

Amazon EKS