# cdk-scheduled-lambda

> An AWS CDK Construct that sets up a scheduled Lambda function

Latest version **1.0.0** (published 2021-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install cdk-scheduled-lambda
pnpm add cdk-scheduled-lambda
yarn add cdk-scheduled-lambda
bun add cdk-scheduled-lambda
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-04-30 |
| First published | 2021-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Benjamin Lannon |
| Maintainers | lannonbr |
| Keywords | aws-cdk |

## Links

- npm: https://www.npmjs.com/package/cdk-scheduled-lambda
- Repository: https://github.com/lannonbr/aws-cdk-scheduled-lambda
- Homepage: https://github.com/lannonbr/aws-cdk-scheduled-lambda#readme
- Issues: https://github.com/lannonbr/aws-cdk-scheduled-lambda/issues
- npm.io page: https://npm.io/package/cdk-scheduled-lambda

## Dependencies (4)

- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) ^1.100.0
- [@aws-cdk/aws-events](https://npm.io/package/@aws-cdk/aws-events.md) ^1.100.0
- [@aws-cdk/aws-lambda](https://npm.io/package/@aws-cdk/aws-lambda.md) ^1.100.0
- [@aws-cdk/aws-events-targets](https://npm.io/package/@aws-cdk/aws-events-targets.md) ^1.100.0

## Recent versions

- 1.0.0 (latest) — 2021-04-30

## README

# AWS CDK Scheduled Lambda

An AWS CDK Construct that wraps a Lambda function alongside an AWS Events Rule that is set up on a schedule.

## Installation

```shell
npm install cdk-scheduled-lambda
```

## Example:

```js
this.newFn = new ScheduledLambda(this, "new-fn", {
  lambdaProps: {
    // @aws-cdk/aws-lambda Function props
    runtime: Runtime.NODEJS_14_X,
    timeout: Duration.seconds(20),
    // ...
  },
  schedule: "cron(0 * * * ? *)", // Run this script once an hour
});
```

To access the underlying event rule or Lambda, access the `schedule` or `fn` props

---
_Source: https://npm.io/package/cdk-scheduled-lambda · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._