awssolutionsconstructsawslambdastepfunctions

README

aws-lambda-stepfunctions module

---

---

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_14_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.
existingVpc?	ec2.IVpc	An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon Step Functions. If an existing VPC is provided, the deployVpc property cannot be true. This uses ec2.IVpc to allow clients to supply VPCs that exist outside the stack using the ec2.Vpc.fromLookup() method.
vpcProps?	ec2.VpcProps	Optional user-provided properties to override the default properties for the new VPC. enableDnsHostnames, enableDnsSupport, natGateways and subnetConfiguration are set by the pattern, so any values for those properties supplied here will be overrriden. If deployVpc is not true then this property will be ignored.
deployVpc?	boolean	Whether to create a new VPC based on vpcProps into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern: One isolated subnet in each Availability Zone used by the CDK program enableDnsHostnames and enableDnsSupport will both be set to true If this property is true then existingVpc cannot be specified. Defaults to false.

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.
vpc?	ec2.IVpc	Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.

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

---

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

Documentation

Overview

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

Index

• func LambdaToStepfunctions_IsConstruct(x interface{}) *bool
• func NewLambdaToStepfunctions_Override(l LambdaToStepfunctions, scope constructs.Construct, id *string, ...)
• type LambdaToStepfunctions
  • func NewLambdaToStepfunctions(scope constructs.Construct, id *string, props *LambdaToStepfunctionsProps) LambdaToStepfunctions
• type LambdaToStepfunctionsProps

Functions

func LambdaToStepfunctions_IsConstruct

func LambdaToStepfunctions_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewLambdaToStepfunctions_Override

func NewLambdaToStepfunctions_Override(l LambdaToStepfunctions, scope constructs.Construct, id *string, props *LambdaToStepfunctionsProps)

Types

type LambdaToStepfunctions

type LambdaToStepfunctions interface {
	constructs.Construct
	CloudwatchAlarms() *[]awscloudwatch.Alarm
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	StateMachine() awsstepfunctions.StateMachine
	StateMachineLogGroup() awslogs.ILogGroup
	Vpc() awsec2.IVpc
	ToString() *string
}

func NewLambdaToStepfunctions

func NewLambdaToStepfunctions(scope constructs.Construct, id *string, props *LambdaToStepfunctionsProps) LambdaToStepfunctions

type LambdaToStepfunctionsProps

type LambdaToStepfunctionsProps struct {
	// User provided StateMachineProps to override the defaults.
	StateMachineProps *awsstepfunctions.StateMachineProps `json:"stateMachineProps"`
	// Whether to create recommended CloudWatch alarms.
	CreateCloudWatchAlarms *bool `json:"createCloudWatchAlarms"`
	// Whether to deploy a new VPC.
	DeployVpc *bool `json:"deployVpc"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
	ExistingVpc awsec2.IVpc `json:"existingVpc"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// User provided props to override the default props for the CloudWatchLogs LogGroup.
	LogGroupProps *awslogs.LogGroupProps `json:"logGroupProps"`
	// Optional Name for the Step Functions state machine environment variable set for the producer Lambda function.
	StateMachineEnvironmentVariableName *string `json:"stateMachineEnvironmentVariableName"`
	// Properties to override default properties if deployVpc is true.
	VpcProps *awsec2.VpcProps `json:"vpcProps"`
}