AWS Step Functions

开发人员指南

AWS 文档 » AWS Step Functions » 开发人员指南 » 示例项目 » 管理容器任务（Amazon ECS、Amazon SNS）

管理容器任务（Amazon ECS、Amazon SNS）

此示例项目演示了如何运行 AWS Fargate 任务，然后根据该任务是成功还是失败发送 Amazon SNS 通知。部署此示例项目将创建 Step Functions 状态机、Fargate 集群和 Amazon SNS 主题。

在此项目中，Step Functions 使用状态机同步调用 Fargate 任务。然后它等待任务成功或失败，并发送一个 Amazon SNS 主题，其中包含有关任务是成功还是失败的消息。

要创建管理容器任务状态机并配置所有资源

1. 打开 Step Functions 控制台，然后选择 Create a state machine (创建状态机)。

2. 选择 Sample Projects (示例项目)，然后选择 Manage a container task (管理容器任务)。

   此时将显示状态机 Code (代码) 和 Visual Workflow (可视工作流程)。

   

3. 选择 Next (下一步)。

   此时将显示 Deploy resources (部署资源) 页面，其中列出了将创建的资源。对于本示例项目，资源包括：

   • Fargate 集群

   • Amazon SNS 主题

4. 选择 Deploy Resources (部署资源)。

   注意

   创建这些资源和相关 IAM 权限可能需要长达 10 分钟的时间。当显示 Deploy resources (部署资源) 页面时，您可打开 Stack ID (堆栈 ID) 链接以查看正在预置的资源。

启动新的执行

1. 在 New execution 页面上，输入执行名称 (可选)，然后选择 Start Execution (开始执行)。

2. (可选) 为帮助您标识执行，您可以在 Enter an execution name 框中为执行指定一个 ID。如果未输入 ID，Step Functions 将自动生成一个唯一 ID。

   注意

   Step Functions 允许您创建包含非 ASCII 字符的状态机、执行和活动名称。这些非 ASCII 名称不适用于 Amazon CloudWatch。为确保您可以跟踪 CloudWatch 指标，请选择一个只使用 ASCII 字符的名称。

3. （可选）您可以转到 Step Functions Dashboard (控制面板) 上新创建的状态机，然后选择 New execution (新执行)。

4. 执行完成后，您可以在 Visual workflow (可视工作流) 上选择状态，并浏览 Step details (步骤详细信息) 下的 Input (输入) 和 Output (输出)。

示例状态机代码

此示例项目中的状态机通过将参数直接传递给这些资源来与 AWS Fargate 和 Amazon SNS 集成。浏览此状态机示例，了解 Step Functions 如何使用状态机同步调用 Fargate 任务，等待任务成功或失败，并发送一个包含有关作业是成功还是失败的消息的 Amazon SNS 主题。

有关 AWS Step Functions 如何控制其他 AWS 服务的更多信息，请参阅 AWS 服务集成。

{
  "Comment": "An example of the Amazon States Language for notification on an AWS Fargate task completion",
  "StartAt": "Run Fargate Task",
  "TimeoutSeconds": 3600,
  "States": {
    "Run Fargate Task": {
      "Type": "Task",
      "Resource": "arn:aws:states:::ecs:runTask.sync",
      "Parameters": {
        "LaunchType": "FARGATE",
        "Cluster": "arn:aws:ecs:ap-northeast-1:123456789012:cluster/FargateTaskNotification-ECSCluster-VHLR20IF9IMP",
        "TaskDefinition": "arn:aws:ecs:ap-northeast-1:123456789012:task-definition/FargateTaskNotification-ECSTaskDefinition-13YOJT8Z2LY5Q:1",
        "NetworkConfiguration": {
          "AwsvpcConfiguration": {
            "Subnets": [
              "subnet-07e1ad3abcfce6758",
              "subnet-04782e7f34ae3efdb"
            ],
            "AssignPublicIp": "ENABLED"
          }
        }
      },
      "Next": "Notify Success",
      "Catch": [
          {
            "ErrorEquals": [ "States.ALL" ],
            "Next": "Notify Failure"
          }
      ]
    },
    "Notify Success": {
      "Type": "Task",
      "Resource": "arn:aws:states:::sns:publish",
      "Parameters": {
        "Message": "AWS Fargate Task started by Step Functions succeeded",
        "TopicArn": "arn:aws:sns:ap-northeast-1:123456789012:FargateTaskNotification-SNSTopic-1XYW5YD5V0M7C"
      },
      "End": true
    },
    "Notify Failure": {
      "Type": "Task",
      "Resource": "arn:aws:states:::sns:publish",
      "Parameters": {
        "Message": "AWS Fargate Task started by Step Functions failed",
        "TopicArn": "arn:aws:sns:ap-northeast-1:123456789012:FargateTaskNotification-SNSTopic-1XYW5YD5V0M7C"
      },
      "End": true
    }
  }
}

IAM 示例

示例项目生成的此示例 AWS Identity and Access Management (IAM) 策略包括执行状态机和相关资源所需的最小权限。最佳实践是在您的 IAM 策略仅包含这些必需的权限。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "sns:Publish"
            ],
            "Resource": [
                "arn:aws:sns:ap-northeast-1:123456789012:FargateTaskNotification-SNSTopic-1XYW5YD5V0M7C"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "ecs:RunTask"
            ],
            "Resource": [
                "arn:aws:ecs:ap-northeast-1:123456789012:task-definition/FargateTaskNotification-ECSTaskDefinition-13YOJT8Z2LY5Q:1"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "ecs:StopTask",
                "ecs:DescribeTasks"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
                "arn:aws:events:ap-northeast-1:123456789012:rule/StepFunctionsGetEventsForECSTaskRule"
            ],
            "Effect": "Allow"
        }
    ]
}

有关在将 Step Functions 与其他 AWS 服务一起使用时如何配置 IAM 的信息，请参阅 集成服务的 IAM 策略。

本页内容：

• 启动新的执行
• 示例状态机代码
• IAM 示例