cdk-serverless 2.0.0 → 2.0.2
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/docs/constructs/assets/main.js +2 -2
- package/docs/constructs/assets/style.css +56 -29
- package/docs/constructs/classes/AssetCdn.html +3 -4
- package/docs/constructs/classes/BaseApi.html +3 -4
- package/docs/constructs/classes/CognitoAuthentication.html +3 -4
- package/docs/constructs/classes/LambdaFunction.html +12 -13
- package/docs/constructs/classes/RestApi.html +9 -10
- package/docs/constructs/classes/SingleTableDatastore.html +3 -4
- package/docs/constructs/classes/Workflow.html +3 -4
- package/docs/constructs/index.html +10 -10
- package/docs/constructs/interfaces/BaseApiProps.html +4 -4
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +2 -2
- package/docs/constructs/interfaces/LambdaFunctionProps.html +2 -2
- package/docs/constructs/interfaces/LambdaTracingOptions.html +1 -1
- package/docs/constructs/interfaces/RestApiProps.html +11 -11
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +1 -1
- package/docs/constructs/interfaces/SingleTableDesign.html +1 -1
- package/docs/lambda/assets/main.js +2 -2
- package/docs/lambda/assets/style.css +56 -29
- package/docs/lambda/functions/api.createAppSyncHandler.html +2 -2
- package/docs/lambda/functions/api.createHttpHandler.html +2 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +2 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +2 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +2 -2
- package/docs/lambda/index.html +10 -10
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +2 -2
- package/docs/lambda/types/api.AppSyncHandler.html +2 -2
- package/docs/lambda/types/api.HttpHandler.html +2 -2
- package/docs/projen/assets/main.js +2 -2
- package/docs/projen/assets/style.css +56 -29
- package/docs/projen/classes/ServerlessProject.html +9 -13
- package/docs/projen/index.html +10 -10
- package/docs/projen/interfaces/ServerlessProjectOptions.html +126 -126
- package/docs/projen/variables/PACKAGE_NAME.html +1 -1
- package/lib/projen/core.d.ts +1 -1
- package/lib/projen/core.js +2 -2
- package/package.json +7 -7
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
<li><a href="../modules.html">cdk-serverless</a></li>
|
|
16
16
|
<li><a href="RestApi.html">RestApi</a></li></ul>
|
|
17
17
|
<h1>Class RestApi<PATHS, OPS></h1></div>
|
|
18
|
-
<section class="tsd-panel
|
|
18
|
+
<section class="tsd-panel">
|
|
19
19
|
<h4>Type Parameters</h4>
|
|
20
|
-
<ul class="tsd-type-
|
|
20
|
+
<ul class="tsd-type-parameter-list">
|
|
21
21
|
<li>
|
|
22
22
|
<h4><span class="tsd-kind-type-parameter">PATHS</span></h4></li>
|
|
23
23
|
<li>
|
|
@@ -64,9 +64,9 @@
|
|
|
64
64
|
<ul class="tsd-signatures">
|
|
65
65
|
<li class="tsd-signature tsd-anchor-link" id="constructor.new_RestApi"><span class="tsd-kind-constructor-signature">new <wbr/>Rest<wbr/>Api</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">PATHS</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">OPS</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RestApi.html" class="tsd-signature-type tsd-kind-class">RestApi</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">PATHS</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">OPS</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_RestApi" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
66
66
|
<li class="tsd-description">
|
|
67
|
-
<section class="tsd-panel
|
|
67
|
+
<section class="tsd-panel">
|
|
68
68
|
<h4>Type Parameters</h4>
|
|
69
|
-
<ul class="tsd-type-
|
|
69
|
+
<ul class="tsd-type-parameter-list">
|
|
70
70
|
<li>
|
|
71
71
|
<h4><span class="tsd-kind-type-parameter">PATHS</span></h4></li>
|
|
72
72
|
<li>
|
|
@@ -133,9 +133,9 @@
|
|
|
133
133
|
<ul class="tsd-signatures">
|
|
134
134
|
<li class="tsd-signature tsd-anchor-link" id="addRestResource.addRestResource-1"><span class="tsd-kind-call-signature">add<wbr/>Rest<wbr/>Resource</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">method</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#addRestResource.addRestResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
135
135
|
<li class="tsd-description">
|
|
136
|
-
<section class="tsd-panel
|
|
136
|
+
<section class="tsd-panel">
|
|
137
137
|
<h4>Type Parameters</h4>
|
|
138
|
-
<ul class="tsd-type-
|
|
138
|
+
<ul class="tsd-type-parameter-list">
|
|
139
139
|
<li>
|
|
140
140
|
<h4><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul></section>
|
|
141
141
|
<div class="tsd-parameters">
|
|
@@ -228,12 +228,10 @@ THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!</p>
|
|
|
228
228
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
229
229
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
230
230
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
231
|
-
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-
|
|
231
|
+
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
232
232
|
<li class="tsd-description">
|
|
233
233
|
<div class="tsd-comment tsd-typography"><p>(deprecated) Checks if <code>x</code> is a construct.</p>
|
|
234
234
|
|
|
235
|
-
<h3>Returns</h3><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
236
|
-
|
|
237
235
|
<h3>Deprecated</h3><p>use <code>x instanceof Construct</code> instead</p>
|
|
238
236
|
</div>
|
|
239
237
|
<div class="tsd-parameters">
|
|
@@ -243,7 +241,8 @@ THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!</p>
|
|
|
243
241
|
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
244
242
|
<div class="tsd-comment tsd-typography"><p>Any object.</p>
|
|
245
243
|
</div></li></ul></div>
|
|
246
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-
|
|
244
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
245
|
+
<aside class="tsd-sources">
|
|
247
246
|
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#isConstruct">isConstruct</a></p></aside></li></ul></section></section></div>
|
|
248
247
|
<div class="col-sidebar">
|
|
249
248
|
<div class="page-menu">
|
|
@@ -87,12 +87,10 @@
|
|
|
87
87
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
88
88
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
89
89
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
90
|
-
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-
|
|
90
|
+
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
91
91
|
<li class="tsd-description">
|
|
92
92
|
<div class="tsd-comment tsd-typography"><p>(deprecated) Checks if <code>x</code> is a construct.</p>
|
|
93
93
|
|
|
94
|
-
<h3>Returns</h3><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
95
|
-
|
|
96
94
|
<h3>Deprecated</h3><p>use <code>x instanceof Construct</code> instead</p>
|
|
97
95
|
</div>
|
|
98
96
|
<div class="tsd-parameters">
|
|
@@ -102,7 +100,8 @@
|
|
|
102
100
|
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
103
101
|
<div class="tsd-comment tsd-typography"><p>Any object.</p>
|
|
104
102
|
</div></li></ul></div>
|
|
105
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-
|
|
103
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
104
|
+
<aside class="tsd-sources">
|
|
106
105
|
<p>Inherited from Construct.isConstruct</p></aside></li></ul></section></section></div>
|
|
107
106
|
<div class="col-sidebar">
|
|
108
107
|
<div class="page-menu">
|
|
@@ -100,12 +100,10 @@
|
|
|
100
100
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
101
101
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
102
102
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
103
|
-
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-
|
|
103
|
+
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
104
104
|
<li class="tsd-description">
|
|
105
105
|
<div class="tsd-comment tsd-typography"><p>(deprecated) Checks if <code>x</code> is a construct.</p>
|
|
106
106
|
|
|
107
|
-
<h3>Returns</h3><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
108
|
-
|
|
109
107
|
<h3>Deprecated</h3><p>use <code>x instanceof Construct</code> instead</p>
|
|
110
108
|
</div>
|
|
111
109
|
<div class="tsd-parameters">
|
|
@@ -115,7 +113,8 @@
|
|
|
115
113
|
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
116
114
|
<div class="tsd-comment tsd-typography"><p>Any object.</p>
|
|
117
115
|
</div></li></ul></div>
|
|
118
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-
|
|
116
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
117
|
+
<aside class="tsd-sources">
|
|
119
118
|
<p>Inherited from constructs.Construct.isConstruct</p></aside></li></ul></section></section></div>
|
|
120
119
|
<div class="col-sidebar">
|
|
121
120
|
<div class="page-menu">
|
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
<div class="col-content">
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<h2>cdk-serverless</h2></div>
|
|
15
|
-
<div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="
|
|
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
16
|
<p>CDK Serverless is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) in serverless architectures. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for serverless applications. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.</p>
|
|
17
|
-
<a id="md:features" class="tsd-anchor"></a><h3><a href="
|
|
17
|
+
<a id="md:features" class="tsd-anchor"></a><h3><a href="#md:features">Features</a></h3><ul>
|
|
18
18
|
<li>Projen helper classes to configure certain use cases easily</li>
|
|
19
19
|
<li>AWS CDK L3-construct for RestApi and GraphQlApi</li>
|
|
20
20
|
<li>Zero-config for Lambda functions and VTL templates</li>
|
|
@@ -25,37 +25,37 @@
|
|
|
25
25
|
<li>Fully typed auto-completion for routes, resolvers, etc.</li>
|
|
26
26
|
</ul>
|
|
27
27
|
<p>Video about the idea behind it: <a href="https://www.youtube.com/watch?v=k5L8U39_16k">https://www.youtube.com/watch?v=k5L8U39_16k</a></p>
|
|
28
|
-
<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="
|
|
28
|
+
<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#md:quick-start">Quick Start</a></h2><p>To start a new project we recommend using projen. To use CDK Serverless you can create any projen CDK Typescript app and then add the appropriate aspect provided by this toolkit.</p>
|
|
29
29
|
<pre><code class="language-bash"><span class="hl-0">$ </span><span class="hl-1">npx</span><span class="hl-0"> </span><span class="hl-1">projen</span><span class="hl-0"> </span><span class="hl-1">new</span><span class="hl-0"> </span><span class="hl-1">awscdk-app-ts</span>
|
|
30
|
-
</code></pre>
|
|
30
|
+
</code><button>Copy</button></pre>
|
|
31
31
|
<p>Adding CDK Serverless is a two step process:</p>
|
|
32
32
|
<ol>
|
|
33
33
|
<li>Add 'cdk-serverless' as a dependency to your project</li>
|
|
34
34
|
<li>Run <code>npx projen</code> to install it</li>
|
|
35
35
|
</ol>
|
|
36
|
-
<a id="md:contribute" class="tsd-anchor"></a><h2><a href="
|
|
36
|
+
<a id="md:contribute" class="tsd-anchor"></a><h2><a href="#md:contribute">Contribute</a></h2><a id="md:how-to-contribute-to-cdk-serverless" class="tsd-anchor"></a><h3><a href="#md:how-to-contribute-to-cdk-serverless">How to contribute to CDK Serverless</a></h3><a id="md:did-you-find-a-bug" class="tsd-anchor"></a><h4><a href="#md:did-you-find-a-bug"><strong>Did you find a bug?</strong></a></h4><ul>
|
|
37
37
|
<li><p><strong>Ensure the bug was not already reported</strong> by searching on GitHub under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
|
|
38
38
|
</li>
|
|
39
39
|
<li><p>If you're unable to find an open issue addressing the problem, <a href="https://github.com/taimos/cdk-serverless/issues/new">open a new one</a>. Be sure to include a <strong>title and clear description</strong>, as much relevant information as possible, and a <strong>code sample</strong> or an <strong>executable test case</strong> demonstrating the expected behavior that is not occurring.</p>
|
|
40
40
|
</li>
|
|
41
41
|
</ul>
|
|
42
|
-
<a id="md:did-you-write-a-patch-that-fixes-a-bug" class="tsd-anchor"></a><h4><a href="
|
|
42
|
+
<a id="md:did-you-write-a-patch-that-fixes-a-bug" class="tsd-anchor"></a><h4><a href="#md:did-you-write-a-patch-that-fixes-a-bug"><strong>Did you write a patch that fixes a bug?</strong></a></h4><ul>
|
|
43
43
|
<li><p>Open a new GitHub pull request with the patch.</p>
|
|
44
44
|
</li>
|
|
45
45
|
<li><p>Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.</p>
|
|
46
46
|
</li>
|
|
47
47
|
</ul>
|
|
48
|
-
<a id="md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" class="tsd-anchor"></a><h4><a href="
|
|
49
|
-
<a id="md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one" class="tsd-anchor"></a><h4><a href="
|
|
48
|
+
<a id="md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" class="tsd-anchor"></a><h4><a href="#md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch"><strong>Did you fix whitespace, format code, or make a purely cosmetic patch?</strong></a></h4><p>Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will normally not be accepted.</p>
|
|
49
|
+
<a id="md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one" class="tsd-anchor"></a><h4><a href="#md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one"><strong>Do you intend to add a new feature or change an existing one?</strong></a></h4><ul>
|
|
50
50
|
<li><p>Suggest your change under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
|
|
51
51
|
</li>
|
|
52
52
|
<li><p>Do not open a pull request on GitHub until you have collected positive feedback about the change.</p>
|
|
53
53
|
</li>
|
|
54
54
|
</ul>
|
|
55
|
-
<a id="md:do-you-want-to-contribute-to-the-cdk-serverless-documentation" class="tsd-anchor"></a><h4><a href="
|
|
55
|
+
<a id="md:do-you-want-to-contribute-to-the-cdk-serverless-documentation" class="tsd-anchor"></a><h4><a href="#md:do-you-want-to-contribute-to-the-cdk-serverless-documentation"><strong>Do you want to contribute to the CDK Serverless documentation?</strong></a></h4><ul>
|
|
56
56
|
<li>Just file a PR with your recommended changes</li>
|
|
57
57
|
</ul>
|
|
58
|
-
<a id="md:authors" class="tsd-anchor"></a><h2><a href="
|
|
58
|
+
<a id="md:authors" class="tsd-anchor"></a><h2><a href="#md:authors">Authors</a></h2><p>Brought to you by <a href="https://taimos.de">Taimos</a></p>
|
|
59
59
|
</div></div>
|
|
60
60
|
<div class="col-sidebar">
|
|
61
61
|
<div class="page-menu">
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
<div class="tsd-comment tsd-typography"><p>Configure a content delivery network for static assets</p>
|
|
62
62
|
|
|
63
63
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">none</span>
|
|
64
|
-
</code></pre>
|
|
64
|
+
</code><button>Copy</button></pre>
|
|
65
65
|
</div></section>
|
|
66
66
|
<section class="tsd-panel tsd-member"><a id="authentication" class="tsd-anchor"></a>
|
|
67
67
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>authentication</span><a href="#authentication" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -71,7 +71,7 @@ Alternatively supply a JWT issuer and audience
|
|
|
71
71
|
to use any other JWT-based authorization service.</p>
|
|
72
72
|
|
|
73
73
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">none</span>
|
|
74
|
-
</code></pre>
|
|
74
|
+
</code><button>Copy</button></pre>
|
|
75
75
|
</div></section>
|
|
76
76
|
<section class="tsd-panel tsd-member"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
77
77
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -89,14 +89,14 @@ to use any other JWT-based authorization service.</p>
|
|
|
89
89
|
<div class="tsd-comment tsd-typography"><p>Configure CloudWatch Dashboard for the API and the Lambda functions</p>
|
|
90
90
|
|
|
91
91
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
92
|
-
</code></pre>
|
|
92
|
+
</code><button>Copy</button></pre>
|
|
93
93
|
</div></section>
|
|
94
94
|
<section class="tsd-panel tsd-member"><a id="singleTableDatastore" class="tsd-anchor"></a>
|
|
95
95
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>single<wbr/>Table<wbr/>Datastore</span><a href="#singleTableDatastore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
96
96
|
<div class="tsd-signature"><span class="tsd-kind-property">single<wbr/>Table<wbr/>Datastore</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/SingleTableDatastore.html" class="tsd-signature-type tsd-kind-class">SingleTableDatastore</a></div>
|
|
97
97
|
<div class="tsd-comment tsd-typography">
|
|
98
98
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">none</span>
|
|
99
|
-
</code></pre>
|
|
99
|
+
</code><button>Copy</button></pre>
|
|
100
100
|
</div></section>
|
|
101
101
|
<section class="tsd-panel tsd-member"><a id="stageName" class="tsd-anchor"></a>
|
|
102
102
|
<h3 class="tsd-anchor-link"><span>stage<wbr/>Name</span><a href="#stageName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -80,7 +80,7 @@ Value: group description</p>
|
|
|
80
80
|
<p>Code has to reside in './src/lambda/cognito.custom-message.ts' with a method 'handler'</p>
|
|
81
81
|
|
|
82
82
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
83
|
-
</code></pre>
|
|
83
|
+
</code><button>Copy</button></pre>
|
|
84
84
|
</div></li>
|
|
85
85
|
<li class="tsd-parameter">
|
|
86
86
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">pre<wbr/>Token<wbr/>Generation</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
@@ -88,7 +88,7 @@ Value: group description</p>
|
|
|
88
88
|
<p>Code has to reside in './src/lambda/cognito.pre-token-generation.ts' with a method 'handler'</p>
|
|
89
89
|
|
|
90
90
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
91
|
-
</code></pre>
|
|
91
|
+
</code><button>Copy</button></pre>
|
|
92
92
|
</div></li></ul></div></section>
|
|
93
93
|
<section class="tsd-panel tsd-member"><a id="userPoolName" class="tsd-anchor"></a>
|
|
94
94
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>user<wbr/>Pool<wbr/>Name</span><a href="#userPoolName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -81,7 +81,7 @@ It is available as process.env.ASSET_DOMAIN_NAME</p>
|
|
|
81
81
|
<div class="tsd-comment tsd-typography"><p>name of the exported handler function</p>
|
|
82
82
|
|
|
83
83
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">handler</span>
|
|
84
|
-
</code></pre>
|
|
84
|
+
</code><button>Copy</button></pre>
|
|
85
85
|
</div></section>
|
|
86
86
|
<section class="tsd-panel tsd-member"><a id="includeSDK" class="tsd-anchor"></a>
|
|
87
87
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>includeSDK</span><a href="#includeSDK" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -89,7 +89,7 @@ It is available as process.env.ASSET_DOMAIN_NAME</p>
|
|
|
89
89
|
<div class="tsd-comment tsd-typography"><p>Should the AWS-SDK be packaged with the Lambda code or excluded</p>
|
|
90
90
|
|
|
91
91
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span><span class="hl-0"> (</span><span class="hl-5">exclude</span><span class="hl-0"> </span><span class="hl-3">SDK</span><span class="hl-0"> </span><span class="hl-5">and</span><span class="hl-0"> </span><span class="hl-5">use</span><span class="hl-0"> </span><span class="hl-5">runtime</span><span class="hl-0"> </span><span class="hl-5">provided</span><span class="hl-0"> </span><span class="hl-5">one</span><span class="hl-0">)</span>
|
|
92
|
-
</code></pre>
|
|
92
|
+
</code><button>Copy</button></pre>
|
|
93
93
|
</div></section>
|
|
94
94
|
<section class="tsd-panel tsd-member"><a id="jwt" class="tsd-anchor"></a>
|
|
95
95
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>jwt</span><a href="#jwt" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
<div class="tsd-comment tsd-typography"><p>Activate tracing with X-Ray</p>
|
|
37
37
|
|
|
38
38
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">lambda</span><span class="hl-0">.</span><span class="hl-5">Tracing</span><span class="hl-0">.</span><span class="hl-3">DISABLED</span>
|
|
39
|
-
</code></pre>
|
|
39
|
+
</code><button>Copy</button></pre>
|
|
40
40
|
</div></section></section></div>
|
|
41
41
|
<div class="col-sidebar">
|
|
42
42
|
<div class="page-menu">
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
<li><a href="../modules.html">cdk-serverless</a></li>
|
|
16
16
|
<li><a href="RestApiProps.html">RestApiProps</a></li></ul>
|
|
17
17
|
<h1>Interface RestApiProps<OPS></h1></div>
|
|
18
|
-
<section class="tsd-panel
|
|
18
|
+
<section class="tsd-panel">
|
|
19
19
|
<h4>Type Parameters</h4>
|
|
20
|
-
<ul class="tsd-type-
|
|
20
|
+
<ul class="tsd-type-parameter-list">
|
|
21
21
|
<li>
|
|
22
22
|
<h4><span class="tsd-kind-type-parameter">OPS</span></h4></li></ul></section>
|
|
23
23
|
<section class="tsd-panel tsd-hierarchy">
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
<div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
|
|
69
69
|
|
|
70
70
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">api</span>
|
|
71
|
-
</code></pre>
|
|
71
|
+
</code><button>Copy</button></pre>
|
|
72
72
|
</div></section>
|
|
73
73
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiName" class="tsd-anchor"></a>
|
|
74
74
|
<h3 class="tsd-anchor-link"><span>api<wbr/>Name</span><a href="#apiName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -82,7 +82,7 @@
|
|
|
82
82
|
<div class="tsd-comment tsd-typography"><p>Configure a content delivery network for static assets</p>
|
|
83
83
|
|
|
84
84
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">none</span>
|
|
85
|
-
</code></pre>
|
|
85
|
+
</code><button>Copy</button></pre>
|
|
86
86
|
</div><aside class="tsd-sources">
|
|
87
87
|
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#assetCdn">assetCdn</a></p></aside></section>
|
|
88
88
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="authentication" class="tsd-anchor"></a>
|
|
@@ -93,7 +93,7 @@ Alternatively supply a JWT issuer and audience
|
|
|
93
93
|
to use any other JWT-based authorization service.</p>
|
|
94
94
|
|
|
95
95
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">none</span>
|
|
96
|
-
</code></pre>
|
|
96
|
+
</code><button>Copy</button></pre>
|
|
97
97
|
</div><aside class="tsd-sources">
|
|
98
98
|
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#authentication">authentication</a></p></aside></section>
|
|
99
99
|
<section class="tsd-panel tsd-member"><a id="autoGenerateRoutes" class="tsd-anchor"></a>
|
|
@@ -102,7 +102,7 @@ to use any other JWT-based authorization service.</p>
|
|
|
102
102
|
<div class="tsd-comment tsd-typography"><p>Generate routes for all endpoints configured in the openapi.yaml file</p>
|
|
103
103
|
|
|
104
104
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
105
|
-
</code></pre>
|
|
105
|
+
</code><button>Copy</button></pre>
|
|
106
106
|
</div></section>
|
|
107
107
|
<section class="tsd-panel tsd-member"><a id="definitionFileName" class="tsd-anchor"></a>
|
|
108
108
|
<h3 class="tsd-anchor-link"><span>definition<wbr/>File<wbr/>Name</span><a href="#definitionFileName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -113,7 +113,7 @@ to use any other JWT-based authorization service.</p>
|
|
|
113
113
|
<div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. example.com)</p>
|
|
114
114
|
|
|
115
115
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-5">No</span><span class="hl-0"> </span><span class="hl-5">custom</span><span class="hl-0"> </span><span class="hl-5">domain</span><span class="hl-0"> </span><span class="hl-5">is</span><span class="hl-0"> </span><span class="hl-5">configured</span>
|
|
116
|
-
</code></pre>
|
|
116
|
+
</code><button>Copy</button></pre>
|
|
117
117
|
</div></section>
|
|
118
118
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
119
119
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -127,7 +127,7 @@ to use any other JWT-based authorization service.</p>
|
|
|
127
127
|
<div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct per operationId</p>
|
|
128
128
|
|
|
129
129
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">-</span>
|
|
130
|
-
</code></pre>
|
|
130
|
+
</code><button>Copy</button></pre>
|
|
131
131
|
</div></section>
|
|
132
132
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="lambdaTracing" class="tsd-anchor"></a>
|
|
133
133
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lambda<wbr/>Tracing</span><a href="#lambdaTracing" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
@@ -141,7 +141,7 @@ to use any other JWT-based authorization service.</p>
|
|
|
141
141
|
<div class="tsd-comment tsd-typography"><p>Configure CloudWatch Dashboard for the API and the Lambda functions</p>
|
|
142
142
|
|
|
143
143
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
144
|
-
</code></pre>
|
|
144
|
+
</code><button>Copy</button></pre>
|
|
145
145
|
</div><aside class="tsd-sources">
|
|
146
146
|
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#monitoring">monitoring</a></p></aside></section>
|
|
147
147
|
<section class="tsd-panel tsd-member"><a id="restApiProps" class="tsd-anchor"></a>
|
|
@@ -150,14 +150,14 @@ to use any other JWT-based authorization service.</p>
|
|
|
150
150
|
<div class="tsd-comment tsd-typography"><p>custom options for the created HttpApi</p>
|
|
151
151
|
|
|
152
152
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">-</span>
|
|
153
|
-
</code></pre>
|
|
153
|
+
</code><button>Copy</button></pre>
|
|
154
154
|
</div></section>
|
|
155
155
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="singleTableDatastore" class="tsd-anchor"></a>
|
|
156
156
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>single<wbr/>Table<wbr/>Datastore</span><a href="#singleTableDatastore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
157
157
|
<div class="tsd-signature"><span class="tsd-kind-property">single<wbr/>Table<wbr/>Datastore</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/SingleTableDatastore.html" class="tsd-signature-type tsd-kind-class">SingleTableDatastore</a></div>
|
|
158
158
|
<div class="tsd-comment tsd-typography">
|
|
159
159
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">none</span>
|
|
160
|
-
</code></pre>
|
|
160
|
+
</code><button>Copy</button></pre>
|
|
161
161
|
</div><aside class="tsd-sources">
|
|
162
162
|
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#singleTableDatastore">singleTableDatastore</a></p></aside></section>
|
|
163
163
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="stageName" class="tsd-anchor"></a>
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
<div class="tsd-comment tsd-typography"><p>Whether server-side encryption with an AWS managed customer master key is enabled.</p>
|
|
44
44
|
|
|
45
45
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-5">server</span><span class="hl-0">-</span><span class="hl-5">side</span><span class="hl-0"> </span><span class="hl-5">encryption</span><span class="hl-0"> </span><span class="hl-5">is</span><span class="hl-0"> </span><span class="hl-5">enabled</span><span class="hl-0"> </span><span class="hl-9">with</span><span class="hl-0"> </span><span class="hl-5">an</span><span class="hl-0"> </span><span class="hl-3">AWS</span><span class="hl-0"> </span><span class="hl-5">owned</span><span class="hl-0"> </span><span class="hl-5">customer</span><span class="hl-0"> </span><span class="hl-5">master</span><span class="hl-0"> </span><span class="hl-5">key</span>
|
|
46
|
-
</code></pre>
|
|
46
|
+
</code><button>Copy</button></pre>
|
|
47
47
|
|
|
48
48
|
<h3>Stability</h3><p>stable</p>
|
|
49
49
|
</div></section>
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
<div class="tsd-comment tsd-typography"><p>The name of TTL attribute.</p>
|
|
62
62
|
|
|
63
63
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">TTL</span><span class="hl-0"> </span><span class="hl-5">is</span><span class="hl-0"> </span><span class="hl-5">disabled</span>
|
|
64
|
-
</code></pre>
|
|
64
|
+
</code><button>Copy</button></pre>
|
|
65
65
|
</div></section></section></div>
|
|
66
66
|
<div class="col-sidebar">
|
|
67
67
|
<div class="page-menu">
|