awssolutionsconstructsawslambdaeventbridge

README

aws-lambda-eventbridge 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.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_lambda_eventbridge
Typescript	@aws-solutions-constructs/aws-lambda-eventbridge
Java	software.amazon.awsconstructs.services.lambdaeventbridge

This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon EventBridge.

Here is a minimal deployable pattern definition in Typescript:

import { LambdaToEventbridge, LambdaToEventbridgeProps } from "@aws-solutions-constructs/aws-lambda-eventbridge";

new LambdaToEventbridge(this, 'LambdaToEventbridgePattern', {
    lambdaFunctionProps: {
        runtime: lambda.Runtime.NODEJS_14_X,
        handler: 'index.handler',
        code: lambda.Code.fromAsset(`${__dirname}/lambda`)
    }
});

Initializer

new LambdaToEventbridge(scope: Construct, id: string, props: LambdaToEventbridgeProps);

Parameters

• scope Construct
• id string
• props LambdaToEventbridgeProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	An optional, existing Lambda function to be used instead of the default function. Providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?	lambda.FunctionProps	Optional user-provided properties to override the default properties for the Lambda function.
existingEventBusInterface?	events.IEventBus	Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.
eventBusProps?	events.EventBusProps	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.
existingVpc?	ec2.IVpc	An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon EventBridge. If an existing VPC is provided, the deployVpc property cannot be true. This uses ec2.IVpc to allow clients to supply VPCs that exist outside the stack using the ec2.Vpc.fromLookup() method.
vpcProps?	ec2.VpcProps	Optional user-provided properties to override the default properties for the new VPC. enableDnsHostnames, enableDnsSupport, natGateways and subnetConfiguration are set by the pattern, so any values for those properties supplied here will be overrriden. If deployVpc is not true then this property will be ignored.
deployVpc?	boolean	Whether to create a new VPC based on vpcProps into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern: One isolated subnet in each Availability Zone used by the CDK program enableDnsHostnames and enableDnsSupport will both be set to true If this property is true then existingVpc cannot be specified. Defaults to false.
eventBusEnvironmentVariableName?	string	Optional Name for the EventBus's name environment variable set for the Lambda function.

Pattern Properties

Name	Type	Description
lambdaFunction	lambda.Function	Returns an instance of the Lambda function created by the pattern.
eventBus?	events.IEventBus	Returns the instance of events.IEventBus used by the construct
vpc?	ec2.IVpc	Returns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

AWS Lambda Function

• Configure limited privilege access IAM role for Lambda function.
• Enable reusing connections with Keep-Alive for NodeJs Lambda function.
• Allow the function to put events to EventBus (custom EventBus can be used by specifying existingEventBusInterface or eventBusProps property).
• Enable X-Ray Tracing
• Set Environment Variables
  • EVENTBUS_NAME
  • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

Architecture

---

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

Documentation

Overview

CDK constructs for defining an interaction between an AWS Lambda function and an Amazon EventBridge.

Index

• func LambdaToEventbridge_IsConstruct(x interface{}) *bool
• func NewLambdaToEventbridge_Override(l LambdaToEventbridge, scope constructs.Construct, id *string, ...)
• type LambdaToEventbridge
  • func NewLambdaToEventbridge(scope constructs.Construct, id *string, props *LambdaToEventbridgeProps) LambdaToEventbridge
• type LambdaToEventbridgeProps

Functions

func LambdaToEventbridge_IsConstruct

func LambdaToEventbridge_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewLambdaToEventbridge_Override

func NewLambdaToEventbridge_Override(l LambdaToEventbridge, scope constructs.Construct, id *string, props *LambdaToEventbridgeProps)

Types

type LambdaToEventbridge

type LambdaToEventbridge interface {
	constructs.Construct
	EventBus() awsevents.IEventBus
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	Vpc() awsec2.IVpc
	ToString() *string
}

func NewLambdaToEventbridge

func NewLambdaToEventbridge(scope constructs.Construct, id *string, props *LambdaToEventbridgeProps) LambdaToEventbridge

type LambdaToEventbridgeProps

type LambdaToEventbridgeProps struct {
	// Whether to deploy a new VPC.
	DeployVpc *bool `json:"deployVpc"`
	// Optional Name for the EventBus's name environment variable set for the Lambda function.
	EventBusEnvironmentVariableName *string `json:"eventBusEnvironmentVariableName"`
	// A new custom EventBus is created with provided props.
	EventBusProps *awsevents.EventBusProps `json:"eventBusProps"`
	// Existing instance of a custom EventBus.
	ExistingEventBusInterface awsevents.IEventBus `json:"existingEventBusInterface"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
	ExistingVpc awsec2.IVpc `json:"existingVpc"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// Properties to override default properties if deployVpc is true.
	VpcProps *awsec2.VpcProps `json:"vpcProps"`
}