aws-events-rule-lambda - AWS Solutions Constructs

aws-events-rule-lambda

Language Package
Python aws_solutions_constructs.aws_events_rule_lambda
Typescript @aws-solutions-constructs/aws-events-rule-lambda
Java software.amazon.awsconstructs.services.eventsrulelambda

Overview

This AWS Solutions Construct implements an AWS Events rule and an AWS Lambda function.

Here is a minimal deployable pattern definition:

Typescript
// aws-events-rule-lambda has been deprecated for CDK V2 in favor of aws-eventbridge-lambda. // This sample uses the CDK V1 syntax import * as cdk from '@aws-cdk/core'; import * as lambda from '@aws-cdk/aws-lambda'; import * as events from '@aws-cdk/aws-events'; import { EventsRuleToLambdaProps, EventsRuleToLambda } from '@aws-solutions-constructs/aws-events-rule-lambda'; const constructProps: EventsRuleToLambdaProps = { lambdaFunctionProps: { code: lambda.Code.fromAsset(`lambda`), runtime: lambda.Runtime.NODEJS_14_X, handler: 'index.handler' }, eventRuleProps: { schedule: events.Schedule.rate(cdk.Duration.minutes(5)) } }; new EventsRuleToLambda(this, 'test-events-rule-lambda', constructProps);
Python
# aws-events-rule-lambda has been deprecated for CDK V2 in favor of aws-eventbridge-lambda. # This sample uses the CDK V1 syntax from aws_solutions_constructs.aws_events_rule_lambda import EventsRuleToLambdaProps, EventsRuleToLambda from aws_cdk import ( aws_lambda as _lambda, aws_events as events, core ) EventsRuleToLambda(self, 'test_events_rule_lambda', lambda_function_props=_lambda.FunctionProps( code=_lambda.Code.from_asset('lambda'), runtime=_lambda.Runtime.PYTHON_3_9, handler='index.handler' ), event_rule_props=events.RuleProps( schedule=events.Schedule.rate(core.Duration.minutes(5)) ))
Java
// aws-events-rule-lambda has been deprecated for CDK V2 in favor of aws-eventbridge-lambda. // This sample uses the CDK V1 syntax import software.constructs.Construct; import software.amazon.awscdk.core.*; import software.amazon.awscdk.services.events.*; import software.amazon.awscdk.services.lambda.*; import software.amazon.awscdk.services.lambda.Runtime; import software.amazon.awsconstructs.services.eventsrulelambda.*; new EventsRuleToLambda(this, "test-events-rule-lambda", new EventsRuleToLambdaProps.Builder() .lambdaFunctionProps(new FunctionProps.Builder() .runtime(Runtime.NODEJS_14_X) .code(Code.fromAsset("lambda")) .handler("index.handler") .build()) .eventRuleProps(new RuleProps.Builder() .schedule(Schedule.rate(Duration.minutes(5))) .build()) .build());

Pattern Construct Props

Name Type Description
existingLambdaObj? lambda.Function Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
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.
lambdaFunctionProps? lambda.FunctionProps User provided props to override the default props for the Lambda function.
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 CloudWatch Events Rule

  • Grant least privilege permissions to CloudWatch Events 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

GitHub

To view the code for this pattern, create/view issues and pull requests, and more:
@aws-solutions-constructs/aws-events-rule-lambda