Package: aws-solutions-constructs.aws-lambda-step-function
aws-lambda-step-function module---Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-lambda-stepfunctions.Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_lambda_step_functionTypescript@aws-solutions-constructs/aws-lambda-step-functionJavasoftware.amazon.awsconstructs.services.lambdastepfunctionOverviewThis AWS Solutions Construct implements an AWS Lambda function connected to an AWS Step Function.Here is a minimal deployable pattern definition:Typescript//aws-lambda-step-functionhasbeendeprecatedforCDKV2infavorofaws-lambda-stepfunctions.//ThissampleusestheCDKV1syntaximport*ascdkfrom'@aws-cdk/core';import*asstepfunctionsfrom'@aws-cdk/aws-stepfunctions';import*aslambdafrom'@aws-cdk/aws-lambda';import{LambdaToStepFunction}from'@aws-solutions-constructs/aws-lambda-step-function';conststartState=newstepfunctions.Pass(this,'StartState');newLambdaToStepFunction(this,'LambdaToStepFunctionPattern',{lambdaFunctionProps:{runtime:lambda.Runtime.NODEJS_14_X,handler:'index.handler',code:lambda.Code.fromAsset(`lambda`)},stateMachineProps:{definition:startState}});Python# aws-lambda-step-function has been deprecated for CDK V2 in favor of aws-lambda-stepfunctions.# This sample uses the CDK V1 syntaxfromaws_solutions_constructs.aws_lambda_step_functionimportLambdaToStepFunctionfromaws_cdkimport(aws_lambdaas_lambda,aws_stepfunctionsasstepfunctions,core)start_state=stepfunctions.Pass(self,'start_state')LambdaToStepFunction(self,'test-lambda-stepfunctions-stack',lambda_function_props=_lambda.FunctionProps(code=_lambda.Code.from_asset('lambda'),runtime=_lambda.Runtime.PYTHON_3_9,handler='index.handler'),state_machine_props=stepfunctions.StateMachineProps(definition=start_state))Java// aws-lambda-step-function has been deprecated for CDK V2 in favor of aws-lambda-stepfunctions.// This sample uses the CDK V1 syntaximportsoftware.constructs.Construct;importsoftware.amazon.awscdk.core.*;importsoftware.amazon.awscdk.services.lambda.*;importsoftware.amazon.awscdk.services.lambda.Runtime;importsoftware.amazon.awscdk.services.stepfunctions.*;importsoftware.amazon.awsconstructs.services.lambdastepfunction.*;finalPassstartState=newPass(this,"StartState");newLambdaToStepFunction(this,"test-lambda-stepfunctions-stack",newLambdaToStepFunctionProps.Builder().lambdaFunctionProps(newFunctionProps.Builder().runtime(Runtime.NODEJS_14_X).code(Code.fromAsset("lambda")).handler("index.handler").build()).stateMachineProps(newStateMachineProps.Builder().definition(startState).build()).build());Pattern Construct PropsNameTypeDescriptionexistingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this andlambdaFunctionPropswill cause an error.lambdaFunctionProps?lambda.FunctionPropsUser provided props to override the default props for the Lambda function.stateMachinePropssfn.StateMachinePropsUser provided props for the sfn.StateMachine.createCloudWatchAlarmsbooleanWhether to create recommended CloudWatch alarmslogGroupProps?logs.LogGroupPropsUser provided props to override the default props for for the CloudWatchLogs LogGroup.stateMachineEnvironmentVariableName?stringOptional Name for the Lambda function environment variable set to the ARN of the state machine. Default: STATE_MACHINE_ARNexistingVpc?ec2.IVpcAn 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, thedeployVpcproperty cannot betrue. This usesec2.IVpcto allow clients to supply VPCs that exist outside the stack using theec2.Vpc.fromLookup()method.vpcProps?ec2.VpcPropsOptional user-provided properties to override the default properties for the new VPC.enableDnsHostnames,enableDnsSupport,natGatewaysandsubnetConfigurationare set by the pattern, so any values for those properties supplied here will be overrriden. IfdeployVpcis nottruethen this property will be ignored.deployVpc?booleanWhether to create a new VPC based onvpcPropsinto 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 programenableDnsHostnamesandenableDnsSupportwill both be set to trueIf this property istruethenexistingVpccannot be specified. Defaults tofalse.Pattern PropertiesNameTypeDescriptionlambdaFunctionlambda.FunctionReturns an instance of the Lambda function created by the pattern.stateMachinesfn.StateMachineReturns an instance of StateMachine created by the construct.stateMachineLogGrouplogs.ILogGroupReturns an instance of the ILogGroup created by the construct for StateMachinecloudwatchAlarms?cloudwatch.Alarm[]Returns a list of alarms created by the construct.vpc?ec2.IVpcReturns 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 settingsOut of the box implementation of the Construct without any override will set the following defaults:AWS Lambda FunctionConfigure limited privilege access IAM role for Lambda functionEnable reusing connections with Keep-Alive for NodeJs Lambda functionEnable X-Ray TracingSet Environment Variables(default) STATE_MACHINE_ARNAWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)AWS Step FunctionEnable CloudWatch logging for API GatewayDeploy best practices CloudWatch Alarms for the Step FunctionArchitecture© Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.