CDK constructs for defining an interaction between an AWS Lambda function and an AWS Step Function.
Project description
aws-lambda-step-function 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_step_function |
Typescript | @aws-solutions-constructs/aws-lambda-step-function |
Java | software.amazon.awsconstructs.services.lambdastepfunction |
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 https://github.com/aws/jsii/issues/826
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",
lambda_function_props=FunctionProps(
runtime=lambda_.Runtime.NODEJS_12_X,
handler="index.handler",
code=lambda_.Code.from_asset(f"{__dirname}/lambda")
),
state_machine_props=StateMachineProps(
definition=start_state
)
)
Initializer
new LambdaToStepFunction(scope: Construct, id: string, props: LambdaToStepFunctionProps);
Parameters
- 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
© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-solutions-constructs.aws-lambda-step-function-1.92.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd75b37a7d9c2662acca788d71eb49d6d30c2035c0a582c0043ef3d0a9f72b0e |
|
MD5 | 7e0fe9837a9b042ec8fc26cb0e748365 |
|
BLAKE2b-256 | 123805eb1ddbe29da01705a404e33396b97534ce2f22cd2300898b98107fc257 |
Hashes for aws_solutions_constructs.aws_lambda_step_function-1.92.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85d69a87083b5f180964ddb3594d44d226705e383927506c149cd120a2467a72 |
|
MD5 | 15729e32be871017b7f094ff7ccdcb55 |
|
BLAKE2b-256 | 5b9a694464db5a03bcb9c9aff9d6efd317606b7b547cdafe76f31e61a5f46b32 |