Package: aws-solutions-constructs.aws-lambda-eventbridge
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 theSemantic Versioningmodel.
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/LanguagePackagePythonaws_solutions_constructs.aws_lambda_eventbridgeTypescript@aws-solutions-constructs/aws-lambda-eventbridgeJavasoftware.amazon.awsconstructs.services.lambdaeventbridgeOverviewThis AWS Solutions Construct implements an AWS Lambda function connected to an Amazon EventBridge.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps,Aws}from'aws-cdk-lib';import{LambdaToEventbridge,LambdaToEventbridgeProps}from"@aws-solutions-constructs/aws-lambda-eventbridge";import*aslambdafrom'aws-cdk-lib/aws-lambda';newLambdaToEventbridge(this,'LambdaToEventbridgePattern',{lambdaFunctionProps:{runtime:lambda.Runtime.NODEJS_16_X,handler:'index.handler',code:lambda.Code.fromAsset(`lambda`)}});Pythonfromaws_solutions_constructs.aws_lambda_eventbridgeimportLambdaToEventbridgefromaws_cdkimport(aws_lambdaas_lambda,Stack)fromconstructsimportConstructLambdaToEventbridge(self,'LambdaToEventbridgePattern',lambda_function_props=_lambda.FunctionProps(code=_lambda.Code.from_asset('lambda'),runtime=_lambda.Runtime.PYTHON_3_9,handler='index.handler'))Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.lambda.*;importsoftware.amazon.awscdk.services.lambda.Runtime;importsoftware.amazon.awsconstructs.services.lambdaeventbridge.*;newLambdaToEventbridge(this,"LambdaToEventbridgePattern",newLambdaToEventbridgeProps.Builder().lambdaFunctionProps(newFunctionProps.Builder().runtime(Runtime.NODEJS_16_X).code(Code.fromAsset("lambda")).handler("index.handler").build()).build());Pattern Construct PropsNameTypeDescriptionexistingLambdaObj?lambda.FunctionAn optional, existing Lambda function to be used instead of the default function. Providing both this andlambdaFunctionPropswill cause an error.lambdaFunctionProps?lambda.FunctionPropsOptional user-provided properties to override the default properties for the Lambda function.existingEventBusInterface?events.IEventBusOptional user-provided custom EventBus for construct to use. Providing both this andeventBusPropsresults an error.eventBusProps?events.EventBusPropsOptional 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 norexistingEventBusInterfaceis provided the construct will use thedefaultEventBus. Providing both this andexistingEventBusInterfaceresults an error.existingVpc?ec2.IVpcAn 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, thedeployVpcproperty cannot betrue. This usesec2.IVpcto allow clients to supply VPCs that exist outside the stack using theec2.Vpc.fromLookup()method.vpcProps?ec2.VpcPropsOptional user-provided properties to override the default properties for the new VPC.enableDnsHostnames,enableDnsSupport,natGatewaysandsubnetConfigurationare set by the pattern, so any values for those properties supplied here will be overridden. IfdeployVpcis nottruethen this property will be ignored.deployVpc?booleanWhether to create a new VPC based onvpcPropsinto 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 programenableDnsHostnamesandenableDnsSupportwill both be set to trueIf this property istruethenexistingVpccannot be specified. Defaults tofalse.eventBusEnvironmentVariableName?stringOptional Name for the Lambda function environment variable set to the name of the Event bus. Default: EVENTBUS_NAMEPattern PropertiesNameTypeDescriptionlambdaFunctionlambda.FunctionReturns an instance of the Lambda function created by the pattern.eventBus?events.IEventBusReturns the instance of events.IEventBus used by the constructvpc?ec2.IVpcReturns 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 settingsOut of the box implementation of the Construct without any override will set the following defaults:AWS Lambda FunctionConfigure 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 specifyingexistingEventBusInterfaceoreventBusPropsproperty).Enable X-Ray TracingSet Environment VariablesEVENTBUS_NAMEAWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.