# @aws-solutions-constructs/aws-events-rule-lambda
> CDK Constructs for deploying AWS Events Rule that inveokes AWS Lambda
Latest version **1.146.0** (published 2022-03-02) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install @aws-solutions-constructs/aws-events-rule-lambda
pnpm add @aws-solutions-constructs/aws-events-rule-lambda
yarn add @aws-solutions-constructs/aws-events-rule-lambda
bun add @aws-solutions-constructs/aws-events-rule-lambda
```
## Health
**Score 35/100 (D)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 1.146.0 |
| Published | 2022-03-02 |
| First published | 2020-06-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 192.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1356 |
| Author | Amazon Web Services |
| Maintainers | aws-solutions-constructs-team |
| Keywords | aws, cdk, awscdk, AWS Solutions Constructs, Amazon EventBridge, AWS Lambda |
## Links
- npm: https://www.npmjs.com/package/@aws-solutions-constructs/aws-events-rule-lambda
- Repository: https://github.com/awslabs/aws-solutions-constructs
- Homepage: https://github.com/awslabs/aws-solutions-constructs#readme
- Issues: https://github.com/awslabs/aws-solutions-constructs/issues
- npm.io page: https://npm.io/package/@aws-solutions-constructs/aws-events-rule-lambda
## Dependencies (7)
- [constructs](https://npm.io/package/constructs.md) ^3.2.0
- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) 1.146.0
- [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) 1.146.0
- [@aws-cdk/aws-events](https://npm.io/package/@aws-cdk/aws-events.md) 1.146.0
- [@aws-cdk/aws-lambda](https://npm.io/package/@aws-cdk/aws-lambda.md) 1.146.0
- [@aws-solutions-constructs/core](https://npm.io/package/@aws-solutions-constructs/core.md) 1.146.0
- [@aws-solutions-constructs/aws-eventbridge-lambda](https://npm.io/package/@aws-solutions-constructs/aws-eventbridge-lambda.md) 1.146.0
## Alternatives
- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads
## Recent versions
- 1.146.0 (latest) — 2022-03-02
- 1.181.1 (v1-latest) — 2022-12-02
- 1.181.0 — 2022-12-02
- 1.180.0 — 2022-12-02
- 1.179.0 — 2022-12-02
- 1.178.0 — 2022-12-02
- 1.177.0 — 2022-12-01
- 1.176.0 — 2022-12-01
- 1.175.0 — 2022-12-01
- 1.174.0 — 2022-12-01
- 1.173.0 — 2022-09-18
- 1.172.0 — 2022-09-18
- 1.171.0 — 2022-09-18
- 1.170.1 — 2022-09-18
- 1.170.0 — 2022-09-14
- … 139 more at https://npm.io/package/@aws-solutions-constructs/aws-events-rule-lambda/versions
## README
# aws-events-rule-lambda module
---
> 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|`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:
``` javascript
import { EventsRuleToLambdaProps, EventsRuleToLambda } from '@aws-solutions-constructs/aws-events-rule-lambda';
const props: EventsRuleToLambdaProps = {
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 EventsRuleToLambda(this, 'test-events-rule-lambda', props);
```
## Initializer
``` text
new EventsRuleToLambda(scope: Construct, id: string, props: EventsRuleToLambdaProps);
```
_Parameters_
* scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html)
* id `string`
* props [`EventsRuleToLambdaProps`](#pattern-construct-props)
## Pattern Construct Props
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.|
|existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|
|eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.EventBusProps.html)|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`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
|eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)|User provided eventRuleProps to override the defaults|
## Pattern Properties
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|
|eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.Rule.html)|Returns an instance of events.Rule created by the construct|
|lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|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.
---
_Source: https://npm.io/package/@aws-solutions-constructs/aws-events-rule-lambda · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._