Class LambdaScheduler

A construct that creates a scheduler to invoke a Lambda function at specified intervals.

This construct uses AWS EventBridge to trigger a Lambda function at a regular interval specified by the duration property. The duration must be greater than 1 minute.

This is useful for use cases where a Lambda function needs to be invoked periodically at intervals greater than one minute.

Example

import { Stack, Duration } from 'aws-cdk-lib';
import { lambda } from '@reuters-graphics/structs';

export class MyLambdaStack extends Stack {
  constructor(scope: Construct, id: string, props: LambdaStackProps) {
    super(scope, id, props);

    const myLambda = new lambda.NodeJSLambda(this, 'my-lambda', {
      entry: './src/index.ts',
      handler: 'handle',
    });

    const schedule = new lambda.schedulers.LambdaScheduler(
      this,
      'my-lambda-schedule',
      {
        duration: Duration.minutes(5),
        lambdaFunction: myLambda.lambda,
        enabled: true,
      }
    );

    schedule.eventsRule; // EventBridge rule
  }
};

Hierarchy

  • Construct
    • LambdaScheduler

Constructors

constructor

Properties

eventsRule node

Methods

isConstruct toString

Constructors

constructor

  • new LambdaScheduler(scope, id, props): LambdaScheduler

  • Constructs a new instance of the LambdaScheduler.

    Parameters

    • scope: Construct

      The scope in which this construct is defined.

    • id: string

      The scoped construct ID.

    • props: LambdaSchedulerOptions

      The properties to configure the scheduler.

    Returns LambdaScheduler

    Throws

    Will throw an error if the duration is not greater than 1 minute.

Properties

ReadonlyeventsRule

eventsRule: Rule

The EventBridge rule that triggers the Lambda function at the specified interval.

Readonlynode

node: Node

The tree node.

Methods

StaticisConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods