aws-solutions-constructs.aws-apigateway-lambda

v2.74.0

CDK constructs for defining an interaction between an API Gateway and a Lambda function. For more information about how to use this package see README

Latest version published 13 days ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

84 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

lambda
39

Popularity

Recognized

GitHub Stars: 1.24K
Forks: 247
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package aws-solutions-constructs.aws-apigateway-lambda, we found that it has been starred 1,235 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 22, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 51
Open PR: 5
Last Release: 13 days ago
Last Commit: 14 days ago

Further analysis of the maintenance status of aws-solutions-constructs.aws-apigateway-lambda based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that aws-solutions-constructs.aws-apigateway-lambda demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 40
Funding: No

With more than 10 contributors for the aws-solutions-constructs.aws-apigateway-lambda repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ~=3.8

Age: 4 years
Latest Release: 13 days ago
Dependencies: 0 Direct
Versions: 234
Maintainers: 1
Wheels: OS Independent

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:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
import * as lambda from 'aws-cdk-lib/aws-lambda';

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

Python

from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
from aws_cdk import (
    aws_lambda as _lambda,
    Stack
)
from constructs import Construct

ApiGatewayToLambda(self, 'ApiGatewayToLambdaPattern',
            lambda_function_props=_lambda.FunctionProps(
                runtime=_lambda.Runtime.PYTHON_3_9,
                handler='index.handler',
                code=_lambda.Code.from_asset('lambda')
            )
            )

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awsconstructs.services.apigatewaylambda.*;

new ApiGatewayToLambda(this, "ApiGatewayToLambdaPattern", new ApiGatewayToLambdaProps.Builder()
        .lambdaFunctionProps(new FunctionProps.Builder()
                .runtime(Runtime.NODEJS_16_X)
                .code(Code.fromAsset("lambda"))
                .handler("index.handler")
                .build())
        .build());

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

Architecture Diagram

FAQs

What is aws-solutions-constructs.aws-apigateway-lambda?

CDK constructs for defining an interaction between an API Gateway and a Lambda function. Visit Snyk Advisor to see a full health score report for aws-solutions-constructs.aws-apigateway-lambda, including popularity, security, maintenance & community analysis.

Is aws-solutions-constructs.aws-apigateway-lambda popular?

The python package aws-solutions-constructs.aws-apigateway-lambda receives a total of 4,132 weekly downloads. As such, aws-solutions-constructs.aws-apigateway-lambda popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is aws-solutions-constructs.aws-apigateway-lambda well maintained?

We found that aws-solutions-constructs.aws-apigateway-lambda demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is aws-solutions-constructs.aws-apigateway-lambda safe to use?

The python package aws-solutions-constructs.aws-apigateway-lambda was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 1 November-2024, at 06:58 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP