aws-lambda-stepfunctions module

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:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	`aws_solutions_constructs.aws_lambda_stepfunctions`
Typescript	`@aws-solutions-constructs/aws-lambda-stepfunctions`
Java	`software.amazon.awsconstructs.services.lambdastepfunctions`

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

Here is a minimal deployable pattern definition in Typescript:

import { LambdaToStepfunctions } from '@aws-solutions-constructs/aws-lambda-stepfunctions';
import * as stepfunctions from '@aws-cdk/aws-stepfunctions';

const startState = new stepfunctions.Pass(stack, 'StartState');

new LambdaToStepfunctions(this, 'LambdaToStepfunctionsPattern', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_12_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`${__dirname}/lambda`)
    },
    stateMachineProps: {
      definition: startState
    }
});

Initializer

new LambdaToStepfunctions(scope: Construct, id: string, props: LambdaToStepfunctionsProps);

Parameters

scope Construct
id string
props LambdaToStepfunctionsProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	`lambda.Function`	Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
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.ILogGroup`	Returns an instance of the ILogGroup 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 Functions

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

Architecture

Architecture Diagram