@aws-solutions-konstruk/aws-events-rule-lambda NPM

aws-events-rule-lambda module

This is a developer preview (public beta) 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.

API Reference:	http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-events-rule-lambda/

Language	Package
{: style="height:16px;width:16px"} Python	`aws_solutions_konstruk.aws_events_rule_lambda`
{: style="height:16px;width:16px"} Typescript	`@aws-solutions-konstruk/aws-events-rule-lambda`

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

Here is a minimal deployable pattern definition:

const { EventsRuleToLambdaProps, EventsRuleToLambda } = require('@aws-solutions-konstruk/aws-events-rule-lambda');

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

new EventsRuleToLambda(stack, '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
deployLambda	`boolean`	Whether to create a new lambda function or use an existing lambda function
existingLambdaObj?	`lambda.Function`	Existing instance of Lambda Function object
lambdaFunctionProps	`lambda.FunctionProps`	Optional user provided props to override the default props for 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

Architecture

Architecture Diagram

@aws-cdk/aws-lambda @aws-cdk/core @aws-cdk/aws-events @aws-cdk/aws-iam @aws-solutions-konstruk/core constructs

@infinitebrahmanuniverse/nolb-_aws-so @everything-registry/sub-chunk-103

0.8.1

5 years ago

0.8.0

5 years ago