Skip to main content

CDK Constructs for deploying AWS Events Rule that inveokes AWS Lambda

Project description

aws-events-rule-lambda module

---

Stability: Deprecated

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-eventbridge-lambda.


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_events_rule_lambda
Typescript Logo Typescript @aws-solutions-constructs/aws-events-rule-lambda
Java Logo 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

Architecture Diagram


© Copyright 2022 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

File details

Details for the file aws-solutions-constructs.aws-events-rule-lambda-1.181.1.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-constructs.aws-events-rule-lambda-1.181.1.tar.gz
Algorithm Hash digest
SHA256 4ec415d88bbc7bd873a85b2dcffeaec9423391d5d15649b7868d38e4fe9af738
MD5 f36ef7af54495cc13bdc740c6b87100a
BLAKE2b-256 907e1ea010f5693248dee98cec5ddb1c6ad8793ecc27e11288b9865a68452880

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_events_rule_lambda-1.181.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_events_rule_lambda-1.181.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3c7b98b2844bd65969e7eb3c33302eae979f9a6ac1542e0c6a2617c736404c0
MD5 a0b557b9ef16b0172da844ca0ed68f4a
BLAKE2b-256 043f37d5e1f885d7e133ef0003801cf942ef9ebc23cfdbd79e84467d51dea023

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page