Package: aws-solutions-constructs.aws-alb-lambda
aws-alb-lambda 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_alb_lambdaTypescript@aws-solutions-constructs/aws-alb-lambdaJavasoftware.amazon.awsconstructs.services.alblambdaOverviewThis AWS Solutions Construct implements an an Application Load Balancer to an AWS Lambda functionHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{AlbToLambda,AlbToLambdaProps}from'@aws-solutions-constructs/aws-alb-lambda';import*asacmfrom'aws-cdk-lib/aws-certificatemanager';import*aslambdafrom'aws-cdk-lib/aws-lambda';//Obtainapre-existingcertificatefromyouraccountconstcertificate=acm.Certificate.fromCertificateArn(this,'existing-cert',"arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012");constconstructProps:AlbToLambdaProps={lambdaFunctionProps:{code:lambda.Code.fromAsset(`lambda`),runtime:lambda.Runtime.NODEJS_16_X,handler:'index.handler'},listenerProps:{certificates:[certificate]},publicApi:true};//Note-allalbconstructsturnonELBloggingbydefault,sorequirethatanenvironmentincludingaccount//andregionbeprovidedwhencreatingthestack////newMyStack(app,'id',{env:{account:'123456789012',region:'us-east-1'}});newAlbToLambda(this,'new-construct',constructProps);Pythonfromaws_solutions_constructs.aws_alb_lambdaimportAlbToLambda,AlbToLambdaPropsfromaws_cdkimport(aws_certificatemanagerasacm,aws_lambdaas_lambda,aws_elasticloadbalancingv2asalb,Stack)fromconstructsimportConstruct# Obtain a pre-existing certificate from your accountcertificate=acm.Certificate.from_certificate_arn(self,'existing-cert',"arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012")# Note - all alb constructs turn on ELB logging by default, so require that an environment including account# and region be provided when creating the stack## MyStack(app, 'id', env=cdk.Environment(account='123456789012', region='us-east-1'))AlbToLambda(self,'new-construct',lambda_function_props=_lambda.FunctionProps(runtime=_lambda.Runtime.PYTHON_3_7,code=_lambda.Code.from_asset('lambda'),handler='index.handler',),listener_props=alb.BaseApplicationListenerProps(certificates=[certificate]),public_api=True)Javaimportsoftware.constructs.Construct;importjava.util.List;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.elasticloadbalancingv2.*;importsoftware.amazon.awscdk.services.lambda.*;importsoftware.amazon.awscdk.services.lambda.Runtime;importsoftware.amazon.awsconstructs.services.alblambda.*;// Obtain a pre-existing certificate from your accountListenerCertificatelistenerCertificate=ListenerCertificate.fromArn("arn:aws:acm:us-east-1:123456789012:certificate/11112222-3333-1234-1234-123456789012");// Note - all alb constructs turn on ELB logging by default, so require that an environment including account// and region be provided when creating the stack//// new MyStack(app, "id", StackProps.builder()//         .env(Environment.builder()//                 .account("123456789012")//                 .region("us-east-1")//                 .build());newAlbToLambda(this,"AlbToLambdaPattern",newAlbToLambdaProps.Builder().lambdaFunctionProps(newFunctionProps.Builder().runtime(Runtime.NODEJS_16_X).code(Code.fromAsset("lambda")).handler("index.handler").build()).listenerProps(newBaseApplicationListenerProps.Builder().certificates(List.of(listenerCertificate)).build()).publicApi(true).build());Pattern Construct PropsNameTypeDescriptionloadBalancerProps?elasticloadbalancingv2.ApplicationLoadBalancerPropsOptional custom properties for a new loadBalancer. Providing both this and existingLoadBalancer is an error. This cannot specify a VPC, it will use the VPC in existingVpc or the VPC created by the construct.existingLoadBalancerObj?elasticloadbalancingv2.ApplicationLoadBalancerExisting Application Load Balancer to incorporate into the construct architecture. Providing both this and loadBalancerProps is an error. The VPC containing this loadBalancer must match the VPC provided in existingVpc.listenerProps?ApplicationListenerPropsProps to define the listener. Must be provided when adding the listener to an ALB (eg - when creating the alb), may not be provided when adding a second target to an already established listener. When provided, must include either a certificate or protocol: HTTPtargetProps?ApplicationTargetGroupPropsOptional custom properties for a new target group. While this is a standard attribute of props for ALB constructs, there are few pertinent properties for a Lambda target.ruleProps?AddRulePropsRules for directing traffic to the target being created. May not be specified for the first listener added to an ALB, and must be specified for the second target added to a listener. Add a second target by instantiating this construct a second time and providing the existingAlb from the first instantiation.vpcProps?ec2.VpcPropsOptional custom properties for a VPC the construct will create. This VPC will be used by the new ALB and any Private Hosted Zone the construct creates (that's why loadBalancerProps and privateHostedZoneProps can't include a VPC). Providing both this and existingVpc is an error.existingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this andlambdaFunctionPropswill cause an error.lambdaFunctionProps?lambda.FunctionPropsOptional user provided props to override the default props for the Lambda function.existingVpc?ec2.IVpcAn existing VPC in which to deploy the construct. Providing both this and vpcProps is an error. If the client provides an existing load balancer and/or existing Private Hosted Zone, those constructs must exist in this VPC.logAlbAccessLogs?booleanWhether to turn on Access Logs for the Application Load Balancer. Uses an S3 bucket with associated storage costs.Enabling Access Logging is a best practice. default - truealbLoggingBucketProps?s3.BucketPropsOptional properties to customize the bucket used to store the ALB Access Logs. Supplying this and setting logAccessLogs to false is an error. @default - nonepublicApibooleanWhether the construct is deploying a private or public API. This has implications for the VPC and ALB.Pattern PropertiesNameTypeDescriptionvpcec2.IVpcThe VPC used by the construct (whether created by the construct or providedb by the client)loadBalancerelasticloadbalancingv2.ApplicationLoadBalancerThe Load Balancer used by the construct (whether created by the construct or provided by the client)lambdaFunctionlambda.FunctionReturns an instance of the Lambda function used in the pattern.listenerelb.ApplicationListenerThe listener used by this pattern.Default settingsOut of the box implementation of the Construct without any override will set the following defaults:Application Load BalancerCreates or configures an Application Load Balancer with:Required listenersNew target group with routing rules if appropriateAWS Lambda FunctionConfigure limited privilege access IAM role for Lambda functionEnable reusing connections with Keep-Alive for NodeJs Lambda functionEnable X-Ray TracingSet Environment VariablesAWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.