cdk-serverless 2.14.2 → 2.14.4
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.
- package/README.md +16 -13
- package/docs/constructs/index.html +14 -12
- package/docs/lambda/index.html +14 -12
- package/docs/projen/index.html +14 -12
- package/package.json +11 -14
package/README.md
CHANGED
|
@@ -2,24 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://badge.fury.io/js/cdk-serverless)
|
|
4
4
|
|
|
5
|
-
CDK Serverless is a
|
|
5
|
+
CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Video introduction: https://www.youtube.com/watch?v=xhNJ0cXG3O8
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
- AWS CDK L3-construct for RestApi and GraphQlApi
|
|
11
|
-
- Zero-config for Lambda functions and VTL templates
|
|
12
|
-
- Live update to Lambda function code using cdk-watch
|
|
13
|
-
- Automatic DynamoDB SingleTable infrastructure
|
|
14
|
-
- Automatic monitoring added for Lambda functions and APIs
|
|
15
|
-
- Full features of CDK usable to implement your special use cases
|
|
16
|
-
- Fully typed auto-completion for routes, resolvers, etc.
|
|
9
|
+
### Features
|
|
17
10
|
|
|
18
|
-
|
|
11
|
+
* Projen helper classes for easy project configuration
|
|
12
|
+
* AWS CDK L3-constructs for RestApi, GraphQlApi, and more
|
|
13
|
+
* Zero-config Lambda function and VTL template generation
|
|
14
|
+
* Automatic DynamoDB single-table infrastructure setup
|
|
15
|
+
* Built-in monitoring for Lambda functions and APIs
|
|
16
|
+
* Full compatibility with CDK for custom implementations
|
|
17
|
+
* Type-safe auto-completion for routes, resolvers, etc.
|
|
18
|
+
* Support for Cognito authentication and authorization
|
|
19
|
+
* Automated generation of CloudFormation outputs for testing
|
|
19
20
|
|
|
20
21
|
## Quick Start
|
|
21
22
|
|
|
22
|
-
To
|
|
23
|
+
To begin a new project with CDK Serverless:
|
|
24
|
+
|
|
25
|
+
Create a new CDK TypeScript app using projen:
|
|
23
26
|
|
|
24
27
|
```bash
|
|
25
28
|
$ npx projen new awscdk-app-ts
|
|
@@ -30,7 +33,7 @@ Adding CDK Serverless is a two step process:
|
|
|
30
33
|
1. Add 'cdk-serverless' as a dependency to your project
|
|
31
34
|
2. Run `npx projen` to install it
|
|
32
35
|
|
|
33
|
-
Now you can use the project type `ServerlessProject` for your
|
|
36
|
+
Now you can use the project type `ServerlessProject` for your app.
|
|
34
37
|
|
|
35
38
|
### Adding projen constructs
|
|
36
39
|
|
|
@@ -13,19 +13,21 @@
|
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<h2>cdk-serverless</h2></div>
|
|
15
15
|
<div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="#md:cdk-serverless">CDK Serverless</a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
|
|
16
|
-
<p>CDK Serverless is a
|
|
16
|
+
<p>CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.</p>
|
|
17
|
+
<p>Video introduction: <a href="https://www.youtube.com/watch?v=xhNJ0cXG3O8">https://www.youtube.com/watch?v=xhNJ0cXG3O8</a></p>
|
|
17
18
|
<a id="md:features" class="tsd-anchor"></a><h3><a href="#md:features">Features</a></h3><ul>
|
|
18
|
-
<li>Projen helper classes
|
|
19
|
-
<li>AWS CDK L3-
|
|
20
|
-
<li>Zero-config
|
|
21
|
-
<li>
|
|
22
|
-
<li>
|
|
23
|
-
<li>
|
|
24
|
-
<li>
|
|
25
|
-
<li>
|
|
19
|
+
<li>Projen helper classes for easy project configuration</li>
|
|
20
|
+
<li>AWS CDK L3-constructs for RestApi, GraphQlApi, and more</li>
|
|
21
|
+
<li>Zero-config Lambda function and VTL template generation</li>
|
|
22
|
+
<li>Automatic DynamoDB single-table infrastructure setup</li>
|
|
23
|
+
<li>Built-in monitoring for Lambda functions and APIs</li>
|
|
24
|
+
<li>Full compatibility with CDK for custom implementations</li>
|
|
25
|
+
<li>Type-safe auto-completion for routes, resolvers, etc.</li>
|
|
26
|
+
<li>Support for Cognito authentication and authorization</li>
|
|
27
|
+
<li>Automated generation of CloudFormation outputs for testing</li>
|
|
26
28
|
</ul>
|
|
27
|
-
<
|
|
28
|
-
<
|
|
29
|
+
<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#md:quick-start">Quick Start</a></h2><p>To begin a new project with CDK Serverless:</p>
|
|
30
|
+
<p>Create a new CDK TypeScript app using projen:</p>
|
|
29
31
|
<pre><code class="language-bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npx</span><span class="hl-1"> </span><span class="hl-2">projen</span><span class="hl-1"> </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-2">awscdk-app-ts</span>
|
|
30
32
|
</code><button>Copy</button></pre>
|
|
31
33
|
<p>Adding CDK Serverless is a two step process:</p>
|
|
@@ -33,7 +35,7 @@
|
|
|
33
35
|
<li>Add 'cdk-serverless' as a dependency to your project</li>
|
|
34
36
|
<li>Run <code>npx projen</code> to install it</li>
|
|
35
37
|
</ol>
|
|
36
|
-
<p>Now you can use the project type <code>ServerlessProject</code> for your
|
|
38
|
+
<p>Now you can use the project type <code>ServerlessProject</code> for your app.</p>
|
|
37
39
|
<a id="md:adding-projen-constructs" class="tsd-anchor"></a><h3><a href="#md:adding-projen-constructs">Adding projen constructs</a></h3><p>First you need to add the desired construct to your projen configuration: (e.g. RestApi)</p>
|
|
38
40
|
<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">RestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'cdk-serverless/projen'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RestApi</span><span class="hl-1">(</span><span class="hl-4">project</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">apiName:</span><span class="hl-1"> </span><span class="hl-2">'TestApi'</span><span class="hl-1">, </span><span class="hl-6">// logical name of your API</span><br/><span class="hl-1"> </span><span class="hl-4">definitionFile:</span><span class="hl-1"> </span><span class="hl-2">'testapi.yaml'</span><span class="hl-1">, </span><span class="hl-6">// path to your OpenAPI spec</span><br/><span class="hl-1">});</span>
|
|
39
41
|
</code><button>Copy</button></pre>
|
package/docs/lambda/index.html
CHANGED
|
@@ -13,19 +13,21 @@
|
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<h2>cdk-serverless</h2></div>
|
|
15
15
|
<div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="#md:cdk-serverless">CDK Serverless</a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
|
|
16
|
-
<p>CDK Serverless is a
|
|
16
|
+
<p>CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.</p>
|
|
17
|
+
<p>Video introduction: <a href="https://www.youtube.com/watch?v=xhNJ0cXG3O8">https://www.youtube.com/watch?v=xhNJ0cXG3O8</a></p>
|
|
17
18
|
<a id="md:features" class="tsd-anchor"></a><h3><a href="#md:features">Features</a></h3><ul>
|
|
18
|
-
<li>Projen helper classes
|
|
19
|
-
<li>AWS CDK L3-
|
|
20
|
-
<li>Zero-config
|
|
21
|
-
<li>
|
|
22
|
-
<li>
|
|
23
|
-
<li>
|
|
24
|
-
<li>
|
|
25
|
-
<li>
|
|
19
|
+
<li>Projen helper classes for easy project configuration</li>
|
|
20
|
+
<li>AWS CDK L3-constructs for RestApi, GraphQlApi, and more</li>
|
|
21
|
+
<li>Zero-config Lambda function and VTL template generation</li>
|
|
22
|
+
<li>Automatic DynamoDB single-table infrastructure setup</li>
|
|
23
|
+
<li>Built-in monitoring for Lambda functions and APIs</li>
|
|
24
|
+
<li>Full compatibility with CDK for custom implementations</li>
|
|
25
|
+
<li>Type-safe auto-completion for routes, resolvers, etc.</li>
|
|
26
|
+
<li>Support for Cognito authentication and authorization</li>
|
|
27
|
+
<li>Automated generation of CloudFormation outputs for testing</li>
|
|
26
28
|
</ul>
|
|
27
|
-
<
|
|
28
|
-
<
|
|
29
|
+
<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#md:quick-start">Quick Start</a></h2><p>To begin a new project with CDK Serverless:</p>
|
|
30
|
+
<p>Create a new CDK TypeScript app using projen:</p>
|
|
29
31
|
<pre><code class="language-bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npx</span><span class="hl-1"> </span><span class="hl-2">projen</span><span class="hl-1"> </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-2">awscdk-app-ts</span>
|
|
30
32
|
</code><button>Copy</button></pre>
|
|
31
33
|
<p>Adding CDK Serverless is a two step process:</p>
|
|
@@ -33,7 +35,7 @@
|
|
|
33
35
|
<li>Add 'cdk-serverless' as a dependency to your project</li>
|
|
34
36
|
<li>Run <code>npx projen</code> to install it</li>
|
|
35
37
|
</ol>
|
|
36
|
-
<p>Now you can use the project type <code>ServerlessProject</code> for your
|
|
38
|
+
<p>Now you can use the project type <code>ServerlessProject</code> for your app.</p>
|
|
37
39
|
<a id="md:adding-projen-constructs" class="tsd-anchor"></a><h3><a href="#md:adding-projen-constructs">Adding projen constructs</a></h3><p>First you need to add the desired construct to your projen configuration: (e.g. RestApi)</p>
|
|
38
40
|
<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">RestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'cdk-serverless/projen'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RestApi</span><span class="hl-1">(</span><span class="hl-4">project</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">apiName:</span><span class="hl-1"> </span><span class="hl-2">'TestApi'</span><span class="hl-1">, </span><span class="hl-6">// logical name of your API</span><br/><span class="hl-1"> </span><span class="hl-4">definitionFile:</span><span class="hl-1"> </span><span class="hl-2">'testapi.yaml'</span><span class="hl-1">, </span><span class="hl-6">// path to your OpenAPI spec</span><br/><span class="hl-1">});</span>
|
|
39
41
|
</code><button>Copy</button></pre>
|
package/docs/projen/index.html
CHANGED
|
@@ -13,19 +13,21 @@
|
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<h2>cdk-serverless</h2></div>
|
|
15
15
|
<div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="#md:cdk-serverless">CDK Serverless</a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
|
|
16
|
-
<p>CDK Serverless is a
|
|
16
|
+
<p>CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.</p>
|
|
17
|
+
<p>Video introduction: <a href="https://www.youtube.com/watch?v=xhNJ0cXG3O8">https://www.youtube.com/watch?v=xhNJ0cXG3O8</a></p>
|
|
17
18
|
<a id="md:features" class="tsd-anchor"></a><h3><a href="#md:features">Features</a></h3><ul>
|
|
18
|
-
<li>Projen helper classes
|
|
19
|
-
<li>AWS CDK L3-
|
|
20
|
-
<li>Zero-config
|
|
21
|
-
<li>
|
|
22
|
-
<li>
|
|
23
|
-
<li>
|
|
24
|
-
<li>
|
|
25
|
-
<li>
|
|
19
|
+
<li>Projen helper classes for easy project configuration</li>
|
|
20
|
+
<li>AWS CDK L3-constructs for RestApi, GraphQlApi, and more</li>
|
|
21
|
+
<li>Zero-config Lambda function and VTL template generation</li>
|
|
22
|
+
<li>Automatic DynamoDB single-table infrastructure setup</li>
|
|
23
|
+
<li>Built-in monitoring for Lambda functions and APIs</li>
|
|
24
|
+
<li>Full compatibility with CDK for custom implementations</li>
|
|
25
|
+
<li>Type-safe auto-completion for routes, resolvers, etc.</li>
|
|
26
|
+
<li>Support for Cognito authentication and authorization</li>
|
|
27
|
+
<li>Automated generation of CloudFormation outputs for testing</li>
|
|
26
28
|
</ul>
|
|
27
|
-
<
|
|
28
|
-
<
|
|
29
|
+
<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#md:quick-start">Quick Start</a></h2><p>To begin a new project with CDK Serverless:</p>
|
|
30
|
+
<p>Create a new CDK TypeScript app using projen:</p>
|
|
29
31
|
<pre><code class="language-bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npx</span><span class="hl-1"> </span><span class="hl-2">projen</span><span class="hl-1"> </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-2">awscdk-app-ts</span>
|
|
30
32
|
</code><button>Copy</button></pre>
|
|
31
33
|
<p>Adding CDK Serverless is a two step process:</p>
|
|
@@ -33,7 +35,7 @@
|
|
|
33
35
|
<li>Add 'cdk-serverless' as a dependency to your project</li>
|
|
34
36
|
<li>Run <code>npx projen</code> to install it</li>
|
|
35
37
|
</ol>
|
|
36
|
-
<p>Now you can use the project type <code>ServerlessProject</code> for your
|
|
38
|
+
<p>Now you can use the project type <code>ServerlessProject</code> for your app.</p>
|
|
37
39
|
<a id="md:adding-projen-constructs" class="tsd-anchor"></a><h3><a href="#md:adding-projen-constructs">Adding projen constructs</a></h3><p>First you need to add the desired construct to your projen configuration: (e.g. RestApi)</p>
|
|
38
40
|
<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">RestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'cdk-serverless/projen'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RestApi</span><span class="hl-1">(</span><span class="hl-4">project</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">apiName:</span><span class="hl-1"> </span><span class="hl-2">'TestApi'</span><span class="hl-1">, </span><span class="hl-6">// logical name of your API</span><br/><span class="hl-1"> </span><span class="hl-4">definitionFile:</span><span class="hl-1"> </span><span class="hl-2">'testapi.yaml'</span><span class="hl-1">, </span><span class="hl-6">// path to your OpenAPI spec</span><br/><span class="hl-1">});</span>
|
|
39
41
|
</code><button>Copy</button></pre>
|
package/package.json
CHANGED
|
@@ -33,19 +33,19 @@
|
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@aws-cdk/aws-cognito-identitypool-alpha": "2.120.0-alpha.0",
|
|
36
|
-
"@aws-sdk/client-cognito-identity-provider": "3.
|
|
37
|
-
"@aws-sdk/client-dynamodb": "3.
|
|
38
|
-
"@aws-sdk/client-s3": "3.
|
|
39
|
-
"@aws-sdk/lib-dynamodb": "3.
|
|
36
|
+
"@aws-sdk/client-cognito-identity-provider": "3.637.0",
|
|
37
|
+
"@aws-sdk/client-dynamodb": "3.637.0",
|
|
38
|
+
"@aws-sdk/client-s3": "3.637.0",
|
|
39
|
+
"@aws-sdk/lib-dynamodb": "3.637.0",
|
|
40
40
|
"@hapi/boom": "^10.0.1",
|
|
41
|
-
"@taimos/projen": "0.0.
|
|
41
|
+
"@taimos/projen": "0.0.213",
|
|
42
42
|
"@types/aws-lambda": "^8.10.143",
|
|
43
43
|
"@types/jest": "^29.5.12",
|
|
44
44
|
"@types/js-yaml": "^4.0.9",
|
|
45
45
|
"@types/jsonwebtoken": "^9.0.6",
|
|
46
46
|
"@types/jwk-to-pem": "^2.0.3",
|
|
47
47
|
"@types/lambda-log": "^2.2.1",
|
|
48
|
-
"@types/node": "^
|
|
48
|
+
"@types/node": "^18",
|
|
49
49
|
"@types/uuid": "^9.0.8",
|
|
50
50
|
"@typescript-eslint/eslint-plugin": "^7",
|
|
51
51
|
"@typescript-eslint/parser": "^7",
|
|
@@ -58,9 +58,9 @@
|
|
|
58
58
|
"jest": "^29.7.0",
|
|
59
59
|
"jest-junit": "^15",
|
|
60
60
|
"openapi-typescript": "6.7.6",
|
|
61
|
-
"projen": "^0.85.
|
|
61
|
+
"projen": "^0.85.2",
|
|
62
62
|
"standard-version": "^9",
|
|
63
|
-
"ts-jest": "^29.2.
|
|
63
|
+
"ts-jest": "^29.2.5",
|
|
64
64
|
"ts-node": "^10.9.2",
|
|
65
65
|
"typedoc": "0.25.0",
|
|
66
66
|
"typescript": "^4.9.5"
|
|
@@ -76,14 +76,14 @@
|
|
|
76
76
|
"openapi-typescript": "^6.7.6"
|
|
77
77
|
},
|
|
78
78
|
"dependencies": {
|
|
79
|
-
"axios": "^1.7.
|
|
79
|
+
"axios": "^1.7.5",
|
|
80
80
|
"constructs": "^10.3.0",
|
|
81
81
|
"date-fns": "^2.30.0",
|
|
82
82
|
"js-yaml": "^4.1.0",
|
|
83
83
|
"jsonwebtoken": "^9.0.2",
|
|
84
84
|
"jwk-to-pem": "^2.0.6",
|
|
85
85
|
"lambda-log": "^3.1.0",
|
|
86
|
-
"projen": "^0.85.
|
|
86
|
+
"projen": "^0.85.2",
|
|
87
87
|
"uuid": "^9.0.1"
|
|
88
88
|
},
|
|
89
89
|
"keywords": [
|
|
@@ -93,15 +93,12 @@
|
|
|
93
93
|
"lambda",
|
|
94
94
|
"serverless"
|
|
95
95
|
],
|
|
96
|
-
"engines": {
|
|
97
|
-
"node": ">= v16.14.1"
|
|
98
|
-
},
|
|
99
96
|
"main": "lib/index.js",
|
|
100
97
|
"license": "Apache-2.0",
|
|
101
98
|
"publishConfig": {
|
|
102
99
|
"access": "public"
|
|
103
100
|
},
|
|
104
|
-
"version": "2.14.
|
|
101
|
+
"version": "2.14.4",
|
|
105
102
|
"jest": {
|
|
106
103
|
"coverageProvider": "v8",
|
|
107
104
|
"testMatch": [
|