本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
选择性检查点示例(快速工作流)
此示例项目演示了如何通过运行执行选择性检查点的模拟电子商务工作流来组合标准和快速工作流。部署此示例项目将创建标准工作流状态机、嵌套的快速工作流状态机、 Amazon Lambda 函数、Amazon Simple Queue Service (Amazon SQS) 队列和 Amazon Simple Notification Service (Amazon SNS) 主题。
有关快速工作流、嵌套工作流和 Step Functions 服务集成的更多信息,请参阅以下内容:
第 1 步:创建状态机并预置资源
-
打开 Step Functions 控制台
,然后选择创建状态机。 -
在搜索框中键入
Selective checkpointing example
,然后从返回的搜索结果中选择选择性检查点示例。 -
选择下一步以继续。
-
Step Functions 列出了您选择的示例项目中 Amazon Web Services 使用的。它还显示了示例项目的工作流图。将此项目部署到您的, Amazon Web Services 账户 或者将其用作构建您自己的项目的起点。根据您想继续的方式,选择运行演示或构建依据。
该示例项目部署了以下资源:
-
一个 Amazon Lambda 函数
-
一个 Amazon SQS 队列
-
一个 Amazon SNS 主题
-
标准类型的 Amazon Step Functions 状态机
-
一个快速类型的 Step Functions 状态机
-
相关 Amazon Identity and Access Management (IAM) 角色
下图显示了选择性检查点示例示例项目的工作流图:
-
-
选择使用模板继续进行选择。
-
请执行以下操作之一:
-
如果您选择构建依据,Step Functions 将为您选择的示例项目创建工作流原型。Step Functions 不会部署工作流定义中列出的资源。
在 Workflow Studio 的设计模式下,从状态浏览器中拖放状态,继续构建工作流原型。或者切换到代码模式,该模式提供了一个类似于 VS Code 的集成代码编辑器,用于在 Step Functions 控制台中更新状态机的 Amazon States Language(ASL)定义。有关使用 Workflow Studio 构建状态机的更多信息,请参阅使用 Workflow Studio。
重要
请记住,在运行工作流之前,为示例项目中使用的资源更新占位符 Amazon 资源名称 (ARN)。
-
如果您选择了 “运行演示”,Step Functions 将创建一个只读示例项目,该项目使用 Amazon CloudFormation 模板将该模板中列出的 Amazon 资源部署到您的 Amazon Web Services 账户。
提示
要查看示例项目的状态机定义,请选择代码。
准备就绪后,选择部署并运行以部署示例项目并创建资源。
创建这些资源和相关 IAM 权限可能需要长达 10 分钟的时间。在部署资源时,您可以打开 CloudFormation 堆栈 ID 链接以查看正在配置哪些资源。
创建示例项目中的所有资源后,您可以在状态机页面上看到新的示例项目。
重要
CloudFormation 模板中使用的每项服务都可能收取标准费用。
-
部署示例项目的资源后,执行以下操作。
第 2 步:运行状态机
-
在状态机页面上,选择您的示例项目。
-
在示例项目页面上,选择启动执行。
-
在启动执行对话框中,执行以下操作:
-
(可选)要识别您的执行,您可以在名称框中为其指定一个名称。默认情况下,Step Functions 会自动生成一个唯一的执行名称。
注意
Step Functions 允许您为状态机、执行和活动创建名称,以及包含非 ASCII 字符的标签。这些非 ASCII 名称不适用于亚马逊。 CloudWatch为确保您可以跟踪 CloudWatch 指标,请选择仅使用 ASCII 字符的名称。
-
(可选)在输入框中,以 JSON 格式输入输入值以便运行工作流。
如果您选择运行演示,则无需提供任何执行输入。
注意
如果您部署的演示项目包含预先填充的执行输入数据,请使用该输入来运行状态机。
-
选择启动执行。
-
Step Functions 控制台会将您引导到一个以您的执行 ID 为标题的页面。该页面被称为执行详细信息页面。在此页面上,您可以随着执行的进展或者在执行完成后查看执行结果。
要查看执行结果,请在图表视图上选择各个状态,然后在步骤详细信息窗格中选择各个选项卡,分别查看每个状态的详细信息,包括输入、输出和定义。有关可在执行详细信息页面上查看的执行信息的详细信息,请参阅“执行详细信息”页面 – 界面概述。
-
-
转到您的CloudWatch 日志日志组
并检查日志。日志组的名称将类似于示例 ExpressLogGroup-wj alrxutnFemi。
父级(标准工作流)的示例状态机代码
此示例项目中的状态机与 Amazon SQS、Amazon SNS 和 Step Functions 快速工作流集成。
浏览此示例状态机,了解 Step Functions 如何处理来自 Amazon SQS 和 Amazon SNS 的输入,然后使用嵌套的快速工作流状态机更新后端系统。
有关 Amazon Step Functions 如何控制其他 Amazon 服务的更多信息,请参阅与其他服务 Amazon Step Functions 一起使用。
{
"Comment": "An example of combining standard and express workflows to run a mock e-commerce workflow that does selective checkpointing.",
"StartAt": "Approve Order Request",
"States": {
"Approve Order Request": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sqs:sendMessage.waitForTaskToken",
"Parameters": {
"QueueUrl": "<SQS_QUEUE_URL>",
"MessageBody": {
"MessageTitle": "Order Request received. Pausing workflow to wait for manual approval. ",
"TaskToken.$": "$$.Task.Token"
}
},
"Next": "Notify Order Success",
"Catch": [
{
"ErrorEquals": [
"States.ALL"
],
"Next": "Notify Order Failure"
}
]
},
"Notify Order Success": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sns:publish",
"Parameters": {
"Message": "Order has been approved. Resuming workflow.",
"TopicArn": "<SNS_ARN>"
},
"Next": "Process Payment"
},
"Notify Order Failure": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sns:publish",
"Parameters": {
"Message": "Order not approved. Order failed.",
"TopicArn": "<SNS_ARN>"
},
"End": true
},
"Process Payment": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sqs:sendMessage.waitForTaskToken",
"Parameters": {
"QueueUrl": "<SQS_QUEUE_URL>",
"MessageBody": {
"MessageTitle": "Payment sent to third-party for processing. Pausing workflow to wait for response.",
"TaskToken.$": "$$.Task.Token"
}
},
"Next": "Notify Payment Success",
"Catch": [
{
"ErrorEquals": [
"States.ALL"
],
"Next": "Notify Payment Failure"
}
]
},
"Notify Payment Success": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sns:publish",
"Parameters": {
"Message": "Payment processing succeeded. Resuming workflow.",
"TopicArn": "<SNS_ARN>"
},
"Next": "Workflow to Update Backend Systems"
},
"Notify Payment Failure": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sns:publish",
"Parameters": {
"Message": "Payment processing failed.",
"TopicArn": "<SNS_ARN>"
},
"End": true
},
"Workflow to Update Backend Systems": {
"Comment": "Starting an execution of an Express workflow to handle backend updates. Express workflows are fast and cost-effective for steps where checkpointing isn't required.",
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::states:startExecution.sync",
"Parameters": {
"StateMachineArn": "<UPDATE_DATABASE_EXPRESS_STATE_MACHINE_ARN>",
"Input": {
"AWS_STEP_FUNCTIONS_STARTED_BY_EXECUTION_ID.$": "$$.Execution.Id"
}
},
"Next": "Ship the Package"
},
"Ship the Package": {
"Type": "Task",
"Resource": "arn:<PARTITION>:states:::sns:publish",
"Parameters": {
"Message": "Order and payment received, database is updated and the package is ready to ship.",
"TopicArn": "<SNS_ARN>"
},
"End": true
}
}
}
父状态机的示例 IAM 角色
示例项目生成的这些示例 Amazon Identity and Access Management (IAM) 策略包括执行状态机和相关资源所需的最低权限。我们建议在您的 IAM 策略中仅包含这些必需的权限。
Amazon SNS 策略:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"sns:Publish"
],
"Resource": "arn:aws:sns:us-east-1:123456789012:Checkpoint-SNSTopic-wJalrXUtnFEMI",
"Effect": "Allow"
}
]
}
Amazon SQS 策略:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"sqs:SendMessage"
],
"Resource": "arn:aws:sqs:us-east-1:123456789012:Checkpoint-SQSQueue-je7MtGbClwBF",
"Effect": "Allow"
}
]
}
状态执行策略:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"states:StartExecution",
"states:DescribeExecution",
"states:StopExecution"
],
"Resource": "*",
"Effect": "Allow"
},
{
"Action": [
"events:PutTargets",
"events:PutRule",
"events:DescribeRule"
],
"Resource": "arn:aws:events:us-east-1:123456789012:rule/StepFunctionsGetEventsForStepFunctionsExecutionRule",
"Effect": "Allow"
}
]
}
嵌套状态机(快速工作流)的示例状态机代码
此示例项目中的状态机在父状态机调用时更新后端信息。
浏览此示例状态机,了解 Step Functions 如何更新模拟电子商务后端系统的不同组件。
有关 Amazon Step Functions 如何控制其他 Amazon 服务的更多信息,请参阅与其他服务 Amazon Step Functions 一起使用。
{
"StartAt": "Update Order History",
"States": {
"Update Order History": {
"Type": "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"Parameters": {
"FunctionName": "Checkpoint-UpdateDatabaseLambdaFunction-wJalrXUtnFEMI",
"Payload": {
"Message": "Update order history."
}
},
"Next": "Update Data Warehouse"
},
"Update Data Warehouse": {
"Type" : "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"Parameters": {
"FunctionName": "Checkpoint-UpdateDatabaseLambdaFunction-wJalrXUtnFEMI",
"Payload": {
"Message": "Update data warehouse."
}
},
"Next": "Update Customer Profile"
},
"Update Customer Profile": {
"Type": "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"Parameters": {
"FunctionName": "Checkpoint-UpdateDatabaseLambdaFunction-wJalrXUtnFEMI",
"Payload": {
"Message": "Update customer profile."
}
},
"Next": "Update Inventory"
},
"Update Inventory": {
"Type": "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"Parameters": {
"FunctionName": "Checkpoint-UpdateDatabaseLambdaFunction-wJalrXUtnFEMI",
"Payload": {
"Message": "Update inventory."
}
},
"End": true
}
}
}
子状态的示例 IAM 角色
示例项目生成的此示例 Amazon Identity and Access Management (IAM) 策略包括执行状态机和相关资源所需的最低权限。我们建议在您的 IAM 策略中仅包含这些必需的权限。
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"lambda:InvokeFunction"
],
"Resource": [
"arn:aws:lambda:us-east-1:123456789012:function:Example-UpdateDatabaseLambdaFunction-wJalrXUtnFEMI"
],
"Effect": "Allow"
}
]
}
以下策略可确保有足够的 CloudWatch 日志权限。
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"logs:CreateLogDelivery",
"logs:GetLogDelivery",
"logs:UpdateLogDelivery",
"logs:DeleteLogDelivery",
"logs:ListLogDeliveries",
"logs:PutResourcePolicy",
"logs:DescribeResourcePolicies",
"logs:DescribeLogGroups"
],
"Resource": [
"*"
],
"Effect": "Allow"
}
]
}
有关在将 Step Functions 与其他 Amazon 服务一起使用时如何配置 IAM 的信息,请参阅集成服务的 IAM 策略。