Nerdiest Precious Modules

    @aws-solutions-konstruk/aws-events-rule-lambda
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.1 • Public • Published

    aws-events-rule-lambda module


    Stability: Experimental

    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
    Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_events_rule_lambda
    Typescript Logo{: 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

    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


    © Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

    Keywords

    none

    Install

    npm i @aws-solutions-konstruk/aws-events-rule-lambda

    DownloadsWeekly Downloads

    2

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    148 kB

    Total Files

    14

    Last publish

    Collaborators

    • aws-solutions-konstruk-support