awssolutionsconstructsawsapigatewaylambda

README

aws-apigateway-lambda module

---

---

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

Language	Package
Python	aws_solutions_constructs.aws_apigateway_lambda
Typescript	@aws-solutions-constructs/aws-apigateway-lambda
Java	software.amazon.awsconstructs.services.apigatewaylambda

Overview

This AWS Solutions Construct implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.

Here is a minimal deployable pattern definition in Typescript:

import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';

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

Initializer

new ApiGatewayToLambda(scope: Construct, id: string, props: ApiGatewayToLambdaProps);

Parameters

• scope Construct
• id string
• props ApiGatewayToLambdaProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?	lambda.FunctionProps	User provided props to override the default props for the Lambda function.
apiGatewayProps?	api.LambdaRestApiProps	Optional user-provided props to override the default props for the API.
logGroupProps?	logs.LogGroupProps	User provided props to override the default props for for the CloudWatchLogs LogGroup.

Pattern Properties

Name	Type	Description
lambdaFunction	lambda.Function	Returns an instance of the Lambda function created by the pattern.
apiGateway	api.LambdaRestApi	Returns an instance of the API Gateway REST API created by the pattern.
apiGatewayCloudWatchRole?	iam.Role	Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.
apiGatewayLogGroup	logs.LogGroup	Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.

Default settings

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

Amazon API Gateway

• Deploy an edge-optimized API endpoint
• Enable CloudWatch logging for API Gateway
• Configure least privilege access IAM role for API Gateway
• Set the default authorizationType for all API methods to IAM
• Enable X-Ray Tracing

AWS Lambda Function

• Configure limited privilege access IAM role for Lambda function
• Enable reusing connections with Keep-Alive for NodeJs Lambda function
• Enable X-Ray Tracing
• Set Environment Variables
  • 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 API Gateway and a Lambda function.

Index

• func ApiGatewayToLambda_IsConstruct(x interface{}) *bool
• func NewApiGatewayToLambda_Override(a ApiGatewayToLambda, scope constructs.Construct, id *string, ...)
• type ApiGatewayToLambda
  • func NewApiGatewayToLambda(scope constructs.Construct, id *string, props *ApiGatewayToLambdaProps) ApiGatewayToLambda
• type ApiGatewayToLambdaProps

Functions

func ApiGatewayToLambda_IsConstruct

func ApiGatewayToLambda_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 NewApiGatewayToLambda_Override

func NewApiGatewayToLambda_Override(a ApiGatewayToLambda, scope constructs.Construct, id *string, props *ApiGatewayToLambdaProps)

Types

type ApiGatewayToLambda

type ApiGatewayToLambda interface {
	constructs.Construct
	ApiGateway() awsapigateway.RestApi
	ApiGatewayCloudWatchRole() awsiam.Role
	ApiGatewayLogGroup() awslogs.LogGroup
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	ToString() *string
}

func NewApiGatewayToLambda

func NewApiGatewayToLambda(scope constructs.Construct, id *string, props *ApiGatewayToLambdaProps) ApiGatewayToLambda

type ApiGatewayToLambdaProps

type ApiGatewayToLambdaProps struct {
	// Optional user-provided props to override the default props for the API.
	ApiGatewayProps interface{} `json:"apiGatewayProps"`
	// Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// User provided props to override the default props for the CloudWatchLogs LogGroup.
	LogGroupProps *awslogs.LogGroupProps `json:"logGroupProps"`
}

The properties for the ApiGatewayToLambda class.