Skip to main content

CDK constructs for defining an interaction between an AWS Lambda function and an AWS Step Function.

Project description

aws-lambda-step-function module


Stability: Experimental

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

Reference Documentation:
Language Package
Python Logo Python aws_solutions_constructs.aws_lambda_step_function
Typescript Logo Typescript @aws-solutions-constructs/aws-lambda-step-function
Java Logo Java

This AWS Solutions Construct implements an AWS Lambda function connected to an AWS Step Function.

Here is a minimal deployable pattern definition in Typescript:

# Example automatically generated without compilation. See
from aws_solutions_constructs.aws_lambda_step_function import LambdaToStepFunction
import aws_cdk.aws_stepfunctions as stepfunctions

start_state = stepfunctions.Pass(stack, "StartState")

LambdaToStepFunction(self, "LambdaToStepFunctionPattern",


new LambdaToStepFunction(scope: Construct, id: string, props: LambdaToStepFunctionProps);


Pattern Construct Props

Name Type Description
existingLambdaObj? lambda.Function Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
lambdaFunctionProps? lambda.FunctionProps User provided props to override the default props for the Lambda function.
stateMachineProps sfn.StateMachineProps User provided props for the sfn.StateMachine.
createCloudWatchAlarms boolean Whether to create recommended CloudWatch alarms
logGroupProps? logs.LogGroupProps User provided props to override the default props for for the CloudWatchLogs LogGroup.
stateMachineEnvironmentVariableName? string Optional Name for the Step Functions state machine environment variable set for the producer Lambda function.

Pattern Properties

Name Type Description
lambdaFunction lambda.Function Returns an instance of the Lambda function created by the pattern.
stateMachine sfn.StateMachine Returns an instance of StateMachine created by the construct.
stateMachineLogGroup logs.LogGroup Returns an instance of the LogGroup created by the construct for StateMachine
cloudwatchAlarms? cloudwatch.Alarm[] Returns a list of alarms created by the construct.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

AWS Lambda Function

  • Configure limited privilege access IAM role for Lambda function

  • Enable reusing connections with Keep-Alive for NodeJs Lambda function

  • Enable X-Ray Tracing

  • Set Environment Variables

    • (default) STATE_MACHINE_ARN
    • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

AWS Step Function

  • Enable CloudWatch logging for API Gateway
  • Deploy best practices CloudWatch Alarms for the Step Function


Architecture Diagram

© Copyright 2021, Inc. or its affiliates. All Rights Reserved.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for, version 1.98.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_constructs.aws_lambda_step_function-1.98.0-py3-none-any.whl (90.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size (91.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page