aws-solutions-constructs.aws-events-rule-lambda 1.101.0

CDK Constructs for deploying AWS Events Rule that inveokes AWS Lambda

aws-events-rule-lambda 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_events_rule_lambda
Typescript	@aws-solutions-constructs/aws-events-rule-lambda
Java	software.amazon.awsconstructs.services.eventsrulelambda

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

Here is a minimal deployable pattern definition in Typescript:

const { EventsRuleToLambdaProps, EventsRuleToLambda } from '@aws-solutions-constructs/aws-events-rule-lambda';

const props: EventsRuleToLambdaProps = {
    lambdaFunctionProps: {
        code: lambda.Code.fromAsset(`${__dirname}/lambda`),
        runtime: lambda.Runtime.NODEJS_12_X,
        handler: 'index.handler'
    },
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5))
    }
};

new EventsRuleToLambda(this, 'test-events-rule-lambda', props);

Initializer

new EventsRuleToLambda(scope: Construct, id: string, props: EventsRuleToLambdaProps);

Parameters

• scope Construct
• id string
• props EventsRuleToLambdaProps

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.
eventRuleProps	events.RuleProps	User provided eventRuleProps to override the defaults

Pattern Properties

Name	Type	Description
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

---

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