使用在 Step Functions 中 AWS CDK 建立標準工作流程

焦點模式

使用在 Step Functions 中 AWS CDK 建立標準工作流程 - AWS Step Functions

步驟 1：設定您的 AWS CDK 專案步驟 2：使用 AWS CDK建立狀態機器步驟 3：啟動狀態機器執行步驟 4：清除後續步驟

您可以使用 AWS Cloud Development Kit (AWS CDK) Infrastructure as Code (IAC) 架構來建立包含 AWS Lambda函數AWS Step Functions的狀態機器。

您將使用 CDK支援的其中一種語言來定義 AWS 基礎設施。定義基礎設施後，您將將應用程式合成至 AWS CloudFormation 範本，並將其部署至 AWS 您的帳戶。

您將使用此方法定義包含 Lambda 函數的 Step Functions 狀態機器，然後從使用 Step Functions 執行狀態機器 AWS Management Console。

開始本教學課程之前，您必須如 AWS Cloud Development Kit (AWS CDK) 開發人員指南 中的 AWS CDK- 先決條件入門中所述設定AWS CDK開發環境。然後，在 AWS CDK使用下列命令安裝 AWS CLI：


npm install -g aws-cdk

本教學課程會產生與相同的結果使用在 Step Functions 中 AWS CloudFormation 建立工作流程。不過，在本教學課程中， AWS CDK不需要您建立任何IAM角色；會為您AWS CDK執行。AWS CDK 版本也包含一個工作流程狀態成功步驟，說明如何將其他步驟新增至您的狀態機器。

提示

若要部署使用 AWS CDK TypeScript 啟動Step Functions工作流程的範例無伺服器應用程式，請參閱 AWS Step Functions 研討會中的使用部署AWS CDK。

步驟 1：設定您的 AWS CDK 專案

在您的主目錄中，或如果您偏好的話，請執行下列命令來為您的新AWS CDK應用程式建立目錄。

重要
請務必命名目錄 step。AWS CDK 應用程式範本使用目錄的名稱來產生來源檔案和類別的名稱。若使用不同名稱，您的應用程式將與本教學課程不相符。
TypeScript
```
mkdir step && cd step
```
JavaScript
```
mkdir step && cd step
```
Python
```
mkdir step && cd step
```
Java
```
mkdir step && cd step
```
C#
請確定您已安裝 .NET 6.0 版或更新版本。如需詳細資訊，請參閱支援的版本。
```
mkdir step && cd step
```
anchor anchor anchor anchor anchor
mkdir step && cd step
使用 cdk init 命令初始化應用程式。指定所需的範本 ("app") 和程式設計語言，如下列範例所示。
TypeScript
```
cdk init --language typescript
```
JavaScript
```
cdk init --language javascript
```
Python
```
cdk init --language python
```
初始化專案後，請啟用專案的虛擬環境，並安裝 AWS CDK的基準相依性。
```
source .venv/bin/activate
python -m pip install -r requirements.txt
```
Java
```
cdk init --language java
```
C#
```
cdk init --language csharp
```
anchor anchor anchor anchor anchor
cdk init --language typescript

步驟 2：使用 AWS CDK建立狀態機器

首先，我們將介紹定義Lambda函數和Step Functions狀態機器的個別程式碼片段。然後，我們將說明如何將它們放在您的AWS CDK應用程式中。最後，您將了解如何合成和部署這些資源。

建立 Lambda 函數

下列AWS CDK程式碼會定義 Lambda函數，並內嵌提供其原始程式碼。

TypeScript


const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
    code: lambda.Code.fromInline(`
          exports.handler = (event, context, callback) => {
              callback(null, "Hello World!");
          };
      `),
    runtime: lambda.Runtime.NODEJS_18_X,
    handler: "index.handler",
    timeout: cdk.Duration.seconds(3)
});

JavaScript


const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
    code: lambda.Code.fromInline(`
          exports.handler = (event, context, callback) => {
              callback(null, "Hello World!");
          };
      `),
    runtime: lambda.Runtime.NODEJS_18_X,
    handler: "index.handler",
    timeout: cdk.Duration.seconds(3)
});

Python


hello_function = lambda_.Function(
            self, "MyLambdaFunction",
            code=lambda_.Code.from_inline("""
            exports.handler = (event, context, callback) => {
                callback(null, "Hello World!");
                }"""),
                runtime=lambda_.Runtime.NODEJS_18_X,
                handler="index.handler",
                timeout=Duration.seconds(25))

Java


final Function helloFunction = Function.Builder.create(this, "MyLambdaFunction")
        .code(Code.fromInline(
                "exports.handler = (event, context, callback) => { callback(null, 'Hello World!' );}"))
        .runtime(Runtime.NODEJS_18_X)
        .handler("index.handler")
        .timeout(Duration.seconds(25))
        .build();

C#


var helloFunction = new Function(this, "MyLambdaFunction", new FunctionProps
{
    Code = Code.FromInline(@"`
      exports.handler = (event, context, callback) => {
        callback(null, 'Hello World!');
      }"),
    Runtime = Runtime.NODEJS_12_X,
    Handler = "index.handler",
    Timeout = Duration.Seconds(25)
});

anchor anchor anchor anchor anchor


const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
    code: lambda.Code.fromInline(`
          exports.handler = (event, context, callback) => {
              callback(null, "Hello World!");
          };
      `),
    runtime: lambda.Runtime.NODEJS_18_X,
    handler: "index.handler",
    timeout: cdk.Duration.seconds(3)
});

您可以在此簡短的範例程式碼中看到：

函數的邏輯名稱 MyLambdaFunction。
函數的原始程式碼，內嵌為AWS CDK應用程式的原始程式碼中的字串。
其他函數屬性，例如要使用的執行時間 (Node 18.x)、函數的進入點和逾時。

建立狀態機器

我們的狀態機器有兩種狀態：Lambda函數任務和工作流程狀態成功狀態。函數需要我們建立 Step Functions任務工作流程狀態來叫用函數。此任務狀態會用作狀態機器中的第一個步驟。成功狀態會使用任務狀態的 next()方法新增至狀態機器。下列程式碼會先叫用名為的函數MyLambdaTask，然後使用 next()方法來定義名為的成功狀態GreetedWorld。

anchor anchor anchor anchor anchor


const stateMachine = new sfn.StateMachine(this, 'MyStateMachine', {
  definition: new tasks.LambdaInvoke(this, "MyLambdaTask", {
    lambdaFunction: helloFunction
  }).next(new sfn.Succeed(this, "GreetedWorld"))
});

建置和部署AWS CDK應用程式

在您新建立的AWS CDK專案中，編輯包含堆疊定義的檔案，使其看起來像下列範例程式碼。您將辨識先前區段中Lambda函數和Step Functions狀態機器的定義。

更新堆疊，如下列範例所示。

TypeScript

lib/step-stack.ts 使用以下程式碼進行更新。


import * as cdk from 'aws-cdk-lib';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';

export class StepStack extends cdk.Stack {
  constructor(app: cdk.App, id: string) {
    super(app, id);

    const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
      code: lambda.Code.fromInline(`
          exports.handler = (event, context, callback) => {
              callback(null, "Hello World!");
          };
      `),
      runtime: lambda.Runtime.NODEJS_18_X,
      handler: "index.handler",
      timeout: cdk.Duration.seconds(3)
    });

    const stateMachine = new sfn.StateMachine(this, 'MyStateMachine', {
      definition: new tasks.LambdaInvoke(this, "MyLambdaTask", {
        lambdaFunction: helloFunction
      }).next(new sfn.Succeed(this, "GreetedWorld"))
    });
  }
}

JavaScript

lib/step-stack.js 使用以下程式碼進行更新。


import * as cdk from 'aws-cdk-lib';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';

export class StepStack extends cdk.Stack {
  constructor(app, id) {
    super(app, id);

    const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
      code: lambda.Code.fromInline(`
          exports.handler = (event, context, callback) => {
              callback(null, "Hello World!");
          };
      `),
      runtime: lambda.Runtime.NODEJS_18_X,
      handler: "index.handler",
      timeout: cdk.Duration.seconds(3)
    });

    const stateMachine = new sfn.StateMachine(this, 'MyStateMachine', {
      definition: new tasks.LambdaInvoke(this, "MyLambdaTask", {
        lambdaFunction: helloFunction
      }).next(new sfn.Succeed(this, "GreetedWorld"))
    });
  }
}

Python

step/step_stack.py 使用以下程式碼進行更新。


from aws_cdk import (
    Duration,
    Stack,
    aws_stepfunctions as sfn,
    aws_stepfunctions_tasks as tasks,
    aws_lambda as lambda_
)
class StepStack(Stack):

    def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
        super().__init__(scope, construct_id, **kwargs)

        hello_function = lambda_.Function(
            self, "MyLambdaFunction",
            code=lambda_.Code.from_inline("""
            exports.handler = (event, context, callback) => {
                callback(null, "Hello World!");
                }"""),
                runtime=lambda_.Runtime.NODEJS_18_X,
                handler="index.handler",
                timeout=Duration.seconds(25))

        state_machine = sfn.StateMachine(
            self, "MyStateMachine",
            definition=tasks.LambdaInvoke(
            self, "MyLambdaTask",
            lambda_function=hello_function)
            .next(sfn.Succeed(self, "GreetedWorld")))

Java

src/main/java/com.myorg/StepStack.java 使用以下程式碼進行更新。


package com.myorg;

import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.Duration;
import software.amazon.awscdk.services.lambda.Code;
import software.amazon.awscdk.services.lambda.Function;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awscdk.services.stepfunctions.StateMachine;
import software.amazon.awscdk.services.stepfunctions.Succeed;
import software.amazon.awscdk.services.stepfunctions.tasks.LambdaInvoke;

public class StepStack extends Stack {
    public StepStack(final Construct scope, final String id) {
        this(scope, id, null);
    }

    public StepStack(final Construct scope, final String id, final StackProps props) {
        super(scope, id, props);

        final Function helloFunction = Function.Builder.create(this, "MyLambdaFunction")
                .code(Code.fromInline(
                        "exports.handler = (event, context, callback) => { callback(null, 'Hello World!' );}"))
                .runtime(Runtime.NODEJS_18_X)
                .handler("index.handler")
                .timeout(Duration.seconds(25))
                .build();

        final StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine")
                .definition(LambdaInvoke.Builder.create(this, "MyLambdaTask")
                        .lambdaFunction(helloFunction)
                        .build()
                        .next(new Succeed(this, "GreetedWorld")))
                .build();
    }
}

C#

src/Step/StepStack.cs 使用以下程式碼進行更新。


using Amazon.CDK;
using Constructs;
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;

namespace Step
{
    public class StepStack : Stack
    {
        internal StepStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
        {
            var helloFunction = new Function(this, "MyLambdaFunction", new FunctionProps
            {
                Code = Code.FromInline(@"exports.handler = (event, context, callback) => {
                    callback(null, 'Hello World!');
                }"),
                Runtime = Runtime.NODEJS_18_X,
                Handler = "index.handler",
                Timeout = Duration.Seconds(25)
            });

            var stateMachine = new StateMachine(this, "MyStateMachine", new StateMachineProps
            {
                DefinitionBody = DefinitionBody.FromChainable(new LambdaInvoke(this, "MyLambdaTask", new LambdaInvokeProps
                {
                    LambdaFunction = helloFunction
                })
                .Next(new Succeed(this, "GreetedWorld")))
            });
        }
    }
}

anchor anchor anchor anchor anchor

lib/step-stack.ts 使用以下程式碼進行更新。


import * as cdk from 'aws-cdk-lib';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';

export class StepStack extends cdk.Stack {
  constructor(app: cdk.App, id: string) {
    super(app, id);

    const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
      code: lambda.Code.fromInline(`
          exports.handler = (event, context, callback) => {
              callback(null, "Hello World!");
          };
      `),
      runtime: lambda.Runtime.NODEJS_18_X,
      handler: "index.handler",
      timeout: cdk.Duration.seconds(3)
    });

    const stateMachine = new sfn.StateMachine(this, 'MyStateMachine', {
      definition: new tasks.LambdaInvoke(this, "MyLambdaTask", {
        lambdaFunction: helloFunction
      }).next(new sfn.Succeed(this, "GreetedWorld"))
    });
  }
}

儲存來源檔案，然後在應用程式的主目錄中執行 cdk synth命令。

AWS CDK 會執行應用程式並從中合成AWS CloudFormation範本。 AWS CDK 然後顯示範本。
注意
如果您使用 TypeScript 建立AWS CDK專案，執行 cdk synth命令可能會傳回下列錯誤。
```
TSError: ⨯ Unable to compile TypeScript:
bin/step.ts:7:33 - error TS2554: Expected 2 arguments, but got 3.
```
修改 bin/step.ts 檔案，如下列範例所示，以解決此錯誤。
```
#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { StepStack } from '../lib/step-stack';

const app = new cdk.App();
new StepStack(app, 'StepStack');
app.synth();
```
若要將 Lambda 函數和 Step Functions 狀態機器部署到您的帳戶 AWS ，請發出 cdk deploy。系統會要求您核准 AWS CDK 產生的 IAM 政策。

步驟 3：啟動狀態機器執行

建立狀態機器之後，您可以開始執行。

開始狀態機器執行

開啟 Step Functions 主控台，然後選擇您使用建立的狀態機器名稱AWS CDK。
在狀態機器頁面上，選擇開始執行。

隨即顯示開始執行對話方塊。
（選用）輸入自訂執行名稱以覆寫產生的預設值。

非 ASCII 名稱和記錄
Step Functions 接受包含非 ASCII 字元的狀態機器、執行、活動和標籤名稱。由於這類字元不適用於 Amazon CloudWatch，因此我們建議您僅使用 ASCII 字元，以便在 CloudWatch 中追蹤指標。
選擇 Start Execution (開始執行)。

狀態機器的執行開始，並顯示顯示執行中執行的新頁面。
Step Functions 主控台會引導您前往標題為執行 ID 的頁面。此頁面稱為執行詳細資訊頁面。在此頁面上，您可以在執行進行時或完成後檢閱執行結果。

若要檢閱執行結果，請在圖形檢視中選擇個別狀態，然後選擇步驟詳細資訊窗格上的個別索引標籤，分別檢視每個狀態的詳細資訊，包括輸入、輸出和定義。如需您可以在執行詳細資訊頁面上檢視之執行資訊的詳細資訊，請參閱執行詳細資訊概觀。

步驟 4：清除

測試狀態機器後，建議您同時移除狀態機器和相關的 Lambda 函數，以釋放中的資源 AWS 帳戶。在應用程式的主目錄中執行 cdk destroy命令，以移除您的狀態機器。

後續步驟

若要進一步了解如何使用開發 AWS 基礎設施AWS CDK，請參閱 AWS CDK開發人員指南。

如需有關以所選語言編寫 AWS CDK 應用程式的資訊，請參閱：

anchor anchor anchor anchor anchor

在 TypeScript AWS CDK中使用

如需本教學中使用的 AWS 建構程式庫模組的詳細資訊，請參閱下列 AWS CDK API 參考概觀：

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

使用 CloudFormation 建立狀態機器

使用 CDK 建立 Express 工作流程

在本頁面

選取您的 Cookie 偏好設定

自訂 Cookie 偏好設定

必要

效能

功能

廣告

無法儲存 Cookie 偏好設定

使用在 Step Functions 中 AWS CDK 建立標準工作流程

提示

步驟 1：設定您的 AWS CDK 專案

重要

步驟 2：使用 AWS CDK建立狀態機器

建立 Lambda 函數

建立狀態機器

建置和部署AWS CDK應用程式

注意

步驟 3：啟動狀態機器執行

開始狀態機器執行

非 ASCII 名稱和記錄

步驟 4：清除

後續步驟

在本頁面

此頁面是否有幫助？

下一個主題：

上一個主題：

需要協助？

選取您的 Cookie 偏好設定

使用 在 Step Functions 中 AWS CDK 建立標準工作流程

提示

步驟 1：設定您的 AWS CDK 專案

重要

步驟 2：使用 AWS CDK建立狀態機器

建立 Lambda 函數

建立 狀態機器

建置和部署AWS CDK應用程式

注意

步驟 3：啟動狀態機器執行

開始狀態機器執行

非 ASCII 名稱和記錄

步驟 4：清除

後續步驟

在本頁面

此頁面是否有幫助？

下一個主題：

上一個主題：

需要協助？

使用在 Step Functions 中 AWS CDK 建立標準工作流程

建立狀態機器