CDK Constructs for deploying AWS Events Rule that inveokes AWS Lambda
Project description
aws-eventbridge-lambda module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_eventbridge_lambda |
Typescript | @aws-solutions-constructs/aws-eventbridge-lambda |
Java | software.amazon.awsconstructs.services.eventbridgelambda |
This AWS Solutions Construct implements an AWS EventBridge rule and an AWS Lambda function.
Here is a minimal deployable pattern definition in Typescript:
const { EventbridgeToLambdaProps, EventbridgeToLambda } from '@aws-solutions-constructs/aws-eventbridge-lambda';
const props: EventbridgeToLambdaProps = {
lambdaFunctionProps: {
code: lambda.Code.fromAsset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler'
},
eventRuleProps: {
schedule: events.Schedule.rate(Duration.minutes(5))
}
};
new EventbridgeToLambda(this, 'test-eventbridge-lambda', props);
Initializer
new EventbridgeToLambda(scope: Construct, id: string, props: EventbridgeToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
EventbridgeToLambdaProps
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. |
existingEventBusInterface? | events.IEventBus |
Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error. |
eventBusProps? | events.EventBusProps |
Optional user-provided properties to override the default properties when creating a custom EventBus. Setting this value to {} will create a custom EventBus using all default properties. If neither this nor existingEventBusInterface is provided the construct will use the default EventBus. Providing both this and existingEventBusInterface results an error. |
eventRuleProps | events.RuleProps |
User provided eventRuleProps to override the defaults |
Pattern Properties
Name | Type | Description |
---|---|---|
eventBus? | events.IEventBus |
Returns the instance of events.IEventBus used by the construct |
eventsRule | events.Rule |
Returns an instance of events.Rule created by the construct |
lambdaFunction | lambda.Function |
Returns an instance of lambda.Function created by the construct |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
Amazon EventBridge Rule
- Grant least privilege permissions to EventBridge rule to trigger the Lambda Function
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
- AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
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
Close
Hashes for aws-solutions-constructs.aws-eventbridge-lambda-2.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a519ed7144340d2263c04edadaefd5799d93a5bd321886fe72f3c8fc1f3a584b |
|
MD5 | f2a6f1773cc1aa708037f8eec4925b8f |
|
BLAKE2b-256 | 9dedd65478bca0aee23e85a5f9eeab0add764f7ab1e3c7c6924e6aeae245b0cb |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_lambda-2.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9f7c4f047958abff6404d1d99072df1791280c20dae4d20fb3d6a13263d848a |
|
MD5 | ddd2b3ee57b8283ba7de18731cd82017 |
|
BLAKE2b-256 | d906c1ce57ee58c68b7e3573af985b9687b6b9a2ee51ed2d966b383c6299d6f0 |