aws-solutions-constructs.aws-apigateway-lambda 2.85.1__tar.gz → 2.85.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. aws_solutions_constructs_aws_apigateway_lambda-2.85.3/PKG-INFO +28 -0
  2. aws_solutions_constructs_aws_apigateway_lambda-2.85.3/README.md +1 -0
  3. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/setup.py +3 -3
  4. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs/aws_apigateway_lambda/__init__.py +1 -132
  5. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs/aws_apigateway_lambda/_jsii/__init__.py +2 -2
  6. aws_solutions_constructs_aws_apigateway_lambda-2.85.3/src/aws_solutions_constructs/aws_apigateway_lambda/_jsii/aws-apigateway-lambda@2.85.3.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_apigateway_lambda-2.85.3/src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/PKG-INFO +28 -0
  8. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/SOURCES.txt +1 -1
  9. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/requires.txt +1 -1
  10. aws_solutions_constructs_aws_apigateway_lambda-2.85.1/PKG-INFO +0 -159
  11. aws_solutions_constructs_aws_apigateway_lambda-2.85.1/README.md +0 -132
  12. aws_solutions_constructs_aws_apigateway_lambda-2.85.1/src/aws_solutions_constructs/aws_apigateway_lambda/_jsii/aws-apigateway-lambda@2.85.1.jsii.tgz +0 -0
  13. aws_solutions_constructs_aws_apigateway_lambda-2.85.1/src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/PKG-INFO +0 -159
  14. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/LICENSE +0 -0
  15. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/MANIFEST.in +0 -0
  16. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/pyproject.toml +0 -0
  17. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/setup.cfg +0 -0
  18. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs/aws_apigateway_lambda/py.typed +0 -0
  19. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/dependency_links.txt +0 -0
  20. {aws_solutions_constructs_aws_apigateway_lambda-2.85.1 → aws_solutions_constructs_aws_apigateway_lambda-2.85.3}/src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/top_level.txt +0 -0
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-apigateway-lambda
3
+ Version: 2.85.3
4
+ Summary: CDK constructs for defining an interaction between an API Gateway and a Lambda function.
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.3
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-apigateway-lambda/README.adoc)
@@ -0,0 +1 @@
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-apigateway-lambda/README.adoc)
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "aws-solutions-constructs.aws-apigateway-lambda",
8
- "version": "2.85.1",
8
+ "version": "2.85.3",
9
9
  "description": "CDK constructs for defining an interaction between an API Gateway and a Lambda function.",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/awslabs/aws-solutions-constructs.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "aws_solutions_constructs.aws_apigateway_lambda._jsii": [
29
- "aws-apigateway-lambda@2.85.1.jsii.tgz"
29
+ "aws-apigateway-lambda@2.85.3.jsii.tgz"
30
30
  ],
31
31
  "aws_solutions_constructs.aws_apigateway_lambda": [
32
32
  "py.typed"
@@ -35,7 +35,7 @@ kwargs = json.loads(
35
35
  "python_requires": "~=3.9",
36
36
  "install_requires": [
37
37
  "aws-cdk-lib>=2.193.0, <3.0.0",
38
- "aws-solutions-constructs.core==2.85.1",
38
+ "aws-solutions-constructs.core==2.85.3",
39
39
  "constructs>=10.0.0, <11.0.0",
40
40
  "jsii>=1.111.0, <2.0.0",
41
41
  "publication>=0.0.3",
@@ -1,136 +1,5 @@
1
1
  r'''
2
- # aws-apigateway-lambda module
3
-
4
- <!--BEGIN STABILITY BANNER-->---
5
-
6
-
7
- ![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
8
-
9
- ---
10
- <!--END STABILITY BANNER-->
11
-
12
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
13
- |:-------------|:-------------|
14
-
15
- <div style="height:8px"></div>
16
-
17
- | **Language** | **Package** |
18
- |:-------------|-----------------|
19
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigateway_lambda`|
20
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigateway-lambda`|
21
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.apigatewaylambda`|
22
-
23
- ## Overview
24
-
25
- This AWS Solutions Construct implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.
26
-
27
- Here is a minimal deployable pattern definition:
28
-
29
- Typescript
30
-
31
- ```python
32
- import { Construct } from 'constructs';
33
- import { Stack, StackProps } from 'aws-cdk-lib';
34
- import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
35
- import * as lambda from 'aws-cdk-lib/aws-lambda';
36
-
37
- new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', {
38
- lambdaFunctionProps: {
39
- runtime: lambda.Runtime.NODEJS_20_X,
40
- handler: 'index.handler',
41
- code: lambda.Code.fromAsset(`lambda`)
42
- }
43
- });
44
- ```
45
-
46
- Python
47
-
48
- ```python
49
- from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
50
- from aws_cdk import (
51
- aws_lambda as _lambda,
52
- Stack
53
- )
54
- from constructs import Construct
55
-
56
- ApiGatewayToLambda(self, 'ApiGatewayToLambdaPattern',
57
- lambda_function_props=_lambda.FunctionProps(
58
- runtime=_lambda.Runtime.PYTHON_3_11,
59
- handler='index.handler',
60
- code=_lambda.Code.from_asset('lambda')
61
- )
62
- )
63
-
64
- ```
65
-
66
- Java
67
-
68
- ```java
69
- import software.constructs.Construct;
70
-
71
- import software.amazon.awscdk.Stack;
72
- import software.amazon.awscdk.StackProps;
73
- import software.amazon.awscdk.services.lambda.*;
74
- import software.amazon.awscdk.services.lambda.Runtime;
75
- import software.amazon.awsconstructs.services.apigatewaylambda.*;
76
-
77
- new ApiGatewayToLambda(this, "ApiGatewayToLambdaPattern", new ApiGatewayToLambdaProps.Builder()
78
- .lambdaFunctionProps(new FunctionProps.Builder()
79
- .runtime(Runtime.NODEJS_20_X)
80
- .code(Code.fromAsset("lambda"))
81
- .handler("index.handler")
82
- .build())
83
- .build());
84
- ```
85
-
86
- ## Pattern Construct Props
87
-
88
- | **Name** | **Type** | **Description** |
89
- |:-------------|:----------------|-----------------|
90
- |existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.|
91
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
92
- |apiGatewayProps?|[`api.LambdaRestApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Optional user-provided props to override the default props for the API.|
93
- |createUsagePlan?|boolean|Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)|
94
- |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
95
-
96
- ## Pattern Properties
97
-
98
- | **Name** | **Type** | **Description** |
99
- |:-------------|:----------------|-----------------|
100
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|
101
- |apiGateway|[`api.LambdaRestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
102
- |apiGatewayCloudWatchRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.|
103
- |apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|
104
-
105
- ## Default settings
106
-
107
- Out of the box implementation of the Construct without any override will set the following defaults:
108
-
109
- ### Amazon API Gateway
110
-
111
- * Deploy an edge-optimized API endpoint
112
- * Enable CloudWatch logging for API Gateway
113
- * Configure least privilege access IAM role for API Gateway
114
- * Set the default authorizationType for all API methods to IAM
115
- * Enable X-Ray Tracing
116
-
117
- ### AWS Lambda Function
118
-
119
- * Configure limited privilege access IAM role for Lambda function
120
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
121
- * Enable X-Ray Tracing
122
- * Set Environment Variables
123
-
124
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
125
-
126
- ## Architecture
127
-
128
- ![Architecture Diagram](architecture.png)
129
-
130
- ---
131
-
132
-
133
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-apigateway-lambda/README.adoc)
134
3
  '''
135
4
  from pkgutil import extend_path
136
5
  __path__ = extend_path(__path__, __name__)
@@ -34,9 +34,9 @@ import constructs._jsii
34
34
 
35
35
  __jsii_assembly__ = jsii.JSIIAssembly.load(
36
36
  "@aws-solutions-constructs/aws-apigateway-lambda",
37
- "2.85.1",
37
+ "2.85.3",
38
38
  __name__[0:-6],
39
- "aws-apigateway-lambda@2.85.1.jsii.tgz",
39
+ "aws-apigateway-lambda@2.85.3.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-apigateway-lambda
3
+ Version: 2.85.3
4
+ Summary: CDK constructs for defining an interaction between an API Gateway and a Lambda function.
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.3
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-apigateway-lambda/README.adoc)
@@ -11,4 +11,4 @@ src/aws_solutions_constructs.aws_apigateway_lambda.egg-info/top_level.txt
11
11
  src/aws_solutions_constructs/aws_apigateway_lambda/__init__.py
12
12
  src/aws_solutions_constructs/aws_apigateway_lambda/py.typed
13
13
  src/aws_solutions_constructs/aws_apigateway_lambda/_jsii/__init__.py
14
- src/aws_solutions_constructs/aws_apigateway_lambda/_jsii/aws-apigateway-lambda@2.85.1.jsii.tgz
14
+ src/aws_solutions_constructs/aws_apigateway_lambda/_jsii/aws-apigateway-lambda@2.85.3.jsii.tgz
@@ -1,5 +1,5 @@
1
1
  aws-cdk-lib<3.0.0,>=2.193.0
2
- aws-solutions-constructs.core==2.85.1
2
+ aws-solutions-constructs.core==2.85.3
3
3
  constructs<11.0.0,>=10.0.0
4
4
  jsii<2.0.0,>=1.111.0
5
5
  publication>=0.0.3
@@ -1,159 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-apigateway-lambda
3
- Version: 2.85.1
4
- Summary: CDK constructs for defining an interaction between an API Gateway and a Lambda function.
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.1
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-apigateway-lambda module
29
-
30
- <!--BEGIN STABILITY BANNER-->---
31
-
32
-
33
- ![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
34
-
35
- ---
36
- <!--END STABILITY BANNER-->
37
-
38
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
39
- |:-------------|:-------------|
40
-
41
- <div style="height:8px"></div>
42
-
43
- | **Language** | **Package** |
44
- |:-------------|-----------------|
45
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigateway_lambda`|
46
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigateway-lambda`|
47
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.apigatewaylambda`|
48
-
49
- ## Overview
50
-
51
- This AWS Solutions Construct implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.
52
-
53
- Here is a minimal deployable pattern definition:
54
-
55
- Typescript
56
-
57
- ```python
58
- import { Construct } from 'constructs';
59
- import { Stack, StackProps } from 'aws-cdk-lib';
60
- import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
61
- import * as lambda from 'aws-cdk-lib/aws-lambda';
62
-
63
- new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', {
64
- lambdaFunctionProps: {
65
- runtime: lambda.Runtime.NODEJS_20_X,
66
- handler: 'index.handler',
67
- code: lambda.Code.fromAsset(`lambda`)
68
- }
69
- });
70
- ```
71
-
72
- Python
73
-
74
- ```python
75
- from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
76
- from aws_cdk import (
77
- aws_lambda as _lambda,
78
- Stack
79
- )
80
- from constructs import Construct
81
-
82
- ApiGatewayToLambda(self, 'ApiGatewayToLambdaPattern',
83
- lambda_function_props=_lambda.FunctionProps(
84
- runtime=_lambda.Runtime.PYTHON_3_11,
85
- handler='index.handler',
86
- code=_lambda.Code.from_asset('lambda')
87
- )
88
- )
89
-
90
- ```
91
-
92
- Java
93
-
94
- ```java
95
- import software.constructs.Construct;
96
-
97
- import software.amazon.awscdk.Stack;
98
- import software.amazon.awscdk.StackProps;
99
- import software.amazon.awscdk.services.lambda.*;
100
- import software.amazon.awscdk.services.lambda.Runtime;
101
- import software.amazon.awsconstructs.services.apigatewaylambda.*;
102
-
103
- new ApiGatewayToLambda(this, "ApiGatewayToLambdaPattern", new ApiGatewayToLambdaProps.Builder()
104
- .lambdaFunctionProps(new FunctionProps.Builder()
105
- .runtime(Runtime.NODEJS_20_X)
106
- .code(Code.fromAsset("lambda"))
107
- .handler("index.handler")
108
- .build())
109
- .build());
110
- ```
111
-
112
- ## Pattern Construct Props
113
-
114
- | **Name** | **Type** | **Description** |
115
- |:-------------|:----------------|-----------------|
116
- |existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.|
117
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
118
- |apiGatewayProps?|[`api.LambdaRestApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Optional user-provided props to override the default props for the API.|
119
- |createUsagePlan?|boolean|Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)|
120
- |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
121
-
122
- ## Pattern Properties
123
-
124
- | **Name** | **Type** | **Description** |
125
- |:-------------|:----------------|-----------------|
126
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|
127
- |apiGateway|[`api.LambdaRestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
128
- |apiGatewayCloudWatchRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.|
129
- |apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|
130
-
131
- ## Default settings
132
-
133
- Out of the box implementation of the Construct without any override will set the following defaults:
134
-
135
- ### Amazon API Gateway
136
-
137
- * Deploy an edge-optimized API endpoint
138
- * Enable CloudWatch logging for API Gateway
139
- * Configure least privilege access IAM role for API Gateway
140
- * Set the default authorizationType for all API methods to IAM
141
- * Enable X-Ray Tracing
142
-
143
- ### AWS Lambda Function
144
-
145
- * Configure limited privilege access IAM role for Lambda function
146
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
147
- * Enable X-Ray Tracing
148
- * Set Environment Variables
149
-
150
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
151
-
152
- ## Architecture
153
-
154
- ![Architecture Diagram](architecture.png)
155
-
156
- ---
157
-
158
-
159
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -1,132 +0,0 @@
1
- # aws-apigateway-lambda module
2
-
3
- <!--BEGIN STABILITY BANNER-->---
4
-
5
-
6
- ![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
7
-
8
- ---
9
- <!--END STABILITY BANNER-->
10
-
11
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
12
- |:-------------|:-------------|
13
-
14
- <div style="height:8px"></div>
15
-
16
- | **Language** | **Package** |
17
- |:-------------|-----------------|
18
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigateway_lambda`|
19
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigateway-lambda`|
20
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.apigatewaylambda`|
21
-
22
- ## Overview
23
-
24
- This AWS Solutions Construct implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.
25
-
26
- Here is a minimal deployable pattern definition:
27
-
28
- Typescript
29
-
30
- ```python
31
- import { Construct } from 'constructs';
32
- import { Stack, StackProps } from 'aws-cdk-lib';
33
- import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
34
- import * as lambda from 'aws-cdk-lib/aws-lambda';
35
-
36
- new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', {
37
- lambdaFunctionProps: {
38
- runtime: lambda.Runtime.NODEJS_20_X,
39
- handler: 'index.handler',
40
- code: lambda.Code.fromAsset(`lambda`)
41
- }
42
- });
43
- ```
44
-
45
- Python
46
-
47
- ```python
48
- from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
49
- from aws_cdk import (
50
- aws_lambda as _lambda,
51
- Stack
52
- )
53
- from constructs import Construct
54
-
55
- ApiGatewayToLambda(self, 'ApiGatewayToLambdaPattern',
56
- lambda_function_props=_lambda.FunctionProps(
57
- runtime=_lambda.Runtime.PYTHON_3_11,
58
- handler='index.handler',
59
- code=_lambda.Code.from_asset('lambda')
60
- )
61
- )
62
-
63
- ```
64
-
65
- Java
66
-
67
- ```java
68
- import software.constructs.Construct;
69
-
70
- import software.amazon.awscdk.Stack;
71
- import software.amazon.awscdk.StackProps;
72
- import software.amazon.awscdk.services.lambda.*;
73
- import software.amazon.awscdk.services.lambda.Runtime;
74
- import software.amazon.awsconstructs.services.apigatewaylambda.*;
75
-
76
- new ApiGatewayToLambda(this, "ApiGatewayToLambdaPattern", new ApiGatewayToLambdaProps.Builder()
77
- .lambdaFunctionProps(new FunctionProps.Builder()
78
- .runtime(Runtime.NODEJS_20_X)
79
- .code(Code.fromAsset("lambda"))
80
- .handler("index.handler")
81
- .build())
82
- .build());
83
- ```
84
-
85
- ## Pattern Construct Props
86
-
87
- | **Name** | **Type** | **Description** |
88
- |:-------------|:----------------|-----------------|
89
- |existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.|
90
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
91
- |apiGatewayProps?|[`api.LambdaRestApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Optional user-provided props to override the default props for the API.|
92
- |createUsagePlan?|boolean|Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)|
93
- |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
94
-
95
- ## Pattern Properties
96
-
97
- | **Name** | **Type** | **Description** |
98
- |:-------------|:----------------|-----------------|
99
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|
100
- |apiGateway|[`api.LambdaRestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
101
- |apiGatewayCloudWatchRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.|
102
- |apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|
103
-
104
- ## Default settings
105
-
106
- Out of the box implementation of the Construct without any override will set the following defaults:
107
-
108
- ### Amazon API Gateway
109
-
110
- * Deploy an edge-optimized API endpoint
111
- * Enable CloudWatch logging for API Gateway
112
- * Configure least privilege access IAM role for API Gateway
113
- * Set the default authorizationType for all API methods to IAM
114
- * Enable X-Ray Tracing
115
-
116
- ### AWS Lambda Function
117
-
118
- * Configure limited privilege access IAM role for Lambda function
119
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
120
- * Enable X-Ray Tracing
121
- * Set Environment Variables
122
-
123
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
124
-
125
- ## Architecture
126
-
127
- ![Architecture Diagram](architecture.png)
128
-
129
- ---
130
-
131
-
132
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -1,159 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-apigateway-lambda
3
- Version: 2.85.1
4
- Summary: CDK constructs for defining an interaction between an API Gateway and a Lambda function.
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.1
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-apigateway-lambda module
29
-
30
- <!--BEGIN STABILITY BANNER-->---
31
-
32
-
33
- ![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
34
-
35
- ---
36
- <!--END STABILITY BANNER-->
37
-
38
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
39
- |:-------------|:-------------|
40
-
41
- <div style="height:8px"></div>
42
-
43
- | **Language** | **Package** |
44
- |:-------------|-----------------|
45
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigateway_lambda`|
46
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigateway-lambda`|
47
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.apigatewaylambda`|
48
-
49
- ## Overview
50
-
51
- This AWS Solutions Construct implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.
52
-
53
- Here is a minimal deployable pattern definition:
54
-
55
- Typescript
56
-
57
- ```python
58
- import { Construct } from 'constructs';
59
- import { Stack, StackProps } from 'aws-cdk-lib';
60
- import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
61
- import * as lambda from 'aws-cdk-lib/aws-lambda';
62
-
63
- new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', {
64
- lambdaFunctionProps: {
65
- runtime: lambda.Runtime.NODEJS_20_X,
66
- handler: 'index.handler',
67
- code: lambda.Code.fromAsset(`lambda`)
68
- }
69
- });
70
- ```
71
-
72
- Python
73
-
74
- ```python
75
- from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
76
- from aws_cdk import (
77
- aws_lambda as _lambda,
78
- Stack
79
- )
80
- from constructs import Construct
81
-
82
- ApiGatewayToLambda(self, 'ApiGatewayToLambdaPattern',
83
- lambda_function_props=_lambda.FunctionProps(
84
- runtime=_lambda.Runtime.PYTHON_3_11,
85
- handler='index.handler',
86
- code=_lambda.Code.from_asset('lambda')
87
- )
88
- )
89
-
90
- ```
91
-
92
- Java
93
-
94
- ```java
95
- import software.constructs.Construct;
96
-
97
- import software.amazon.awscdk.Stack;
98
- import software.amazon.awscdk.StackProps;
99
- import software.amazon.awscdk.services.lambda.*;
100
- import software.amazon.awscdk.services.lambda.Runtime;
101
- import software.amazon.awsconstructs.services.apigatewaylambda.*;
102
-
103
- new ApiGatewayToLambda(this, "ApiGatewayToLambdaPattern", new ApiGatewayToLambdaProps.Builder()
104
- .lambdaFunctionProps(new FunctionProps.Builder()
105
- .runtime(Runtime.NODEJS_20_X)
106
- .code(Code.fromAsset("lambda"))
107
- .handler("index.handler")
108
- .build())
109
- .build());
110
- ```
111
-
112
- ## Pattern Construct Props
113
-
114
- | **Name** | **Type** | **Description** |
115
- |:-------------|:----------------|-----------------|
116
- |existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.|
117
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
118
- |apiGatewayProps?|[`api.LambdaRestApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Optional user-provided props to override the default props for the API.|
119
- |createUsagePlan?|boolean|Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)|
120
- |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
121
-
122
- ## Pattern Properties
123
-
124
- | **Name** | **Type** | **Description** |
125
- |:-------------|:----------------|-----------------|
126
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|
127
- |apiGateway|[`api.LambdaRestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.LambdaRestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
128
- |apiGatewayCloudWatchRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.|
129
- |apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|
130
-
131
- ## Default settings
132
-
133
- Out of the box implementation of the Construct without any override will set the following defaults:
134
-
135
- ### Amazon API Gateway
136
-
137
- * Deploy an edge-optimized API endpoint
138
- * Enable CloudWatch logging for API Gateway
139
- * Configure least privilege access IAM role for API Gateway
140
- * Set the default authorizationType for all API methods to IAM
141
- * Enable X-Ray Tracing
142
-
143
- ### AWS Lambda Function
144
-
145
- * Configure limited privilege access IAM role for Lambda function
146
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
147
- * Enable X-Ray Tracing
148
- * Set Environment Variables
149
-
150
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
151
-
152
- ## Architecture
153
-
154
- ![Architecture Diagram](architecture.png)
155
-
156
- ---
157
-
158
-
159
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.