cdk-serverless 2.1.0 → 2.2.1
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/.gitattributes +1 -0
- package/docs/constructs/assets/highlight.css +14 -14
- package/docs/constructs/assets/main.js +3 -3
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +6 -4
- package/docs/constructs/classes/AssetCdn.html +62 -55
- package/docs/constructs/classes/BaseApi.html +54 -46
- package/docs/constructs/classes/CognitoAuthentication.html +64 -56
- package/docs/constructs/classes/GraphQlApi.html +384 -0
- package/docs/constructs/classes/LambdaFunction.html +433 -367
- package/docs/constructs/classes/RestApi.html +110 -97
- package/docs/constructs/classes/SingleTableDatastore.html +56 -49
- package/docs/constructs/classes/Workflow.html +62 -55
- package/docs/constructs/index.html +26 -23
- package/docs/constructs/interfaces/AssetCdnProps.html +35 -30
- package/docs/constructs/interfaces/BaseApiProps.html +73 -61
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +61 -48
- package/docs/constructs/interfaces/GraphQlApiProps.html +205 -0
- package/docs/constructs/interfaces/ICognitoAuthentication.html +30 -26
- package/docs/constructs/interfaces/IJwtAuthentication.html +40 -34
- package/docs/constructs/interfaces/LambdaFunctionProps.html +97 -80
- package/docs/constructs/interfaces/LambdaTracingOptions.html +31 -27
- package/docs/constructs/interfaces/RestApiProps.html +108 -92
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +44 -38
- package/docs/constructs/interfaces/SingleTableDesign.html +46 -39
- package/docs/constructs/interfaces/VtlResolverOptions.html +102 -0
- package/docs/constructs/interfaces/WorkflowProps.html +40 -37
- package/docs/constructs/modules.html +46 -40
- package/docs/constructs/types/LambdaOptions.html +24 -21
- package/docs/lambda/assets/highlight.css +11 -4
- package/docs/lambda/assets/main.js +3 -3
- package/docs/lambda/assets/style.css +6 -4
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +113 -120
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +108 -116
- package/docs/lambda/classes/auth.JwtAuthorizer.html +108 -116
- package/docs/lambda/classes/errors.BadRequestError.html +43 -67
- package/docs/lambda/classes/errors.ForbiddenError.html +43 -67
- package/docs/lambda/classes/errors.HttpError.html +43 -67
- package/docs/lambda/classes/errors.NotFoundError.html +43 -67
- package/docs/lambda/classes/errors.UnauthenticatedError.html +43 -67
- package/docs/lambda/functions/api.createAppSyncHandler.html +23 -39
- package/docs/lambda/functions/api.createHttpHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +21 -38
- package/docs/lambda/index.html +7 -41
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +33 -50
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +36 -53
- package/docs/lambda/interfaces/api.HttpResponseContext.html +30 -47
- package/docs/lambda/interfaces/api.Operation.html +24 -41
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +27 -44
- package/docs/lambda/modules/api.html +31 -49
- package/docs/lambda/modules/auth.html +19 -43
- package/docs/lambda/modules/errors.html +15 -41
- package/docs/lambda/modules.html +8 -42
- package/docs/lambda/types/api.APIGatewayv1Handler.html +20 -37
- package/docs/lambda/types/api.AppSyncHandler.html +20 -37
- package/docs/lambda/types/api.HttpHandler.html +20 -37
- package/docs/projen/assets/highlight.css +25 -18
- package/docs/projen/assets/main.js +3 -3
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +6 -4
- package/docs/projen/classes/Datastore.html +54 -49
- package/docs/projen/classes/GraphQlApi.html +155 -0
- package/docs/projen/classes/RestApi.html +54 -49
- package/docs/projen/classes/ServerlessProject.html +590 -461
- package/docs/projen/classes/Workflow.html +54 -49
- package/docs/projen/index.html +15 -13
- package/docs/projen/interfaces/DatastoreOptions.html +20 -18
- package/docs/projen/interfaces/GraphQlApiOptions.html +77 -0
- package/docs/projen/interfaces/RestApiOptions.html +20 -18
- package/docs/projen/interfaces/ServerlessProjectOptions.html +979 -808
- package/docs/projen/interfaces/WorkflowOptions.html +20 -18
- package/docs/projen/modules.html +24 -20
- package/docs/projen/variables/PACKAGE_NAME.html +13 -11
- package/lib/constructs/graphql.d.ts +52 -0
- package/lib/constructs/graphql.js +310 -0
- package/lib/constructs/index.d.ts +1 -0
- package/lib/constructs/index.js +2 -1
- package/lib/projen/core.js +1 -2
- package/lib/projen/datastore.js +3 -4
- package/lib/projen/graphql.d.ts +10 -0
- package/lib/projen/graphql.js +90 -0
- package/lib/projen/index.d.ts +1 -0
- package/lib/projen/index.js +2 -2
- package/lib/projen/rest-api.js +3 -1
- package/package.json +8 -8
|
@@ -26,7 +26,7 @@
|
|
|
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
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
|
-
<pre><code class="language-bash"><span class="hl-0"
|
|
29
|
+
<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
30
|
</code><button>Copy</button></pre>
|
|
31
31
|
<p>Adding CDK Serverless is a two step process:</p>
|
|
32
32
|
<ol>
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
<div class="page-menu">
|
|
62
62
|
<div class="tsd-navigation settings">
|
|
63
63
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
64
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
64
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
65
65
|
<div class="tsd-accordion-details">
|
|
66
66
|
<div class="tsd-filter-visibility">
|
|
67
67
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
<div class="tsd-theme-toggle">
|
|
74
74
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
75
75
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
76
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
76
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
77
77
|
<div class="tsd-accordion-details">
|
|
78
78
|
<ul>
|
|
79
79
|
<li>
|
|
@@ -96,27 +96,30 @@
|
|
|
96
96
|
<li><a href="#md:do-you-want-to-contribute-to-the-cdk-serverless-documentation"><span>Do you want to contribute to the CDK <wbr/>Serverless documentation?</span></a></li></ul></li></ul></li>
|
|
97
97
|
<li><a href="#md:authors"><span>Authors</span></a></li></ul></li></ul></li></ul></div></details></div>
|
|
98
98
|
<div class="site-menu">
|
|
99
|
-
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon"
|
|
99
|
+
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
100
100
|
<ul class="tsd-small-nested-navigation">
|
|
101
|
-
<li><a href="classes/AssetCdn.html"><svg class="tsd-kind-icon"
|
|
102
|
-
<li><a href="classes/BaseApi.html"><svg class="tsd-kind-icon"
|
|
103
|
-
<li><a href="classes/CognitoAuthentication.html"><svg class="tsd-kind-icon"
|
|
104
|
-
<li><a href="classes/
|
|
105
|
-
<li><a href="classes/
|
|
106
|
-
<li><a href="classes/
|
|
107
|
-
<li><a href="classes/
|
|
108
|
-
<li><a href="
|
|
109
|
-
<li><a href="interfaces/
|
|
110
|
-
<li><a href="interfaces/
|
|
111
|
-
<li><a href="interfaces/
|
|
112
|
-
<li><a href="interfaces/
|
|
113
|
-
<li><a href="interfaces/
|
|
114
|
-
<li><a href="interfaces/
|
|
115
|
-
<li><a href="interfaces/
|
|
116
|
-
<li><a href="interfaces/
|
|
117
|
-
<li><a href="interfaces/
|
|
118
|
-
<li><a href="interfaces/
|
|
119
|
-
<li><a href="
|
|
101
|
+
<li><a href="classes/AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
|
|
102
|
+
<li><a href="classes/BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
|
|
103
|
+
<li><a href="classes/CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
|
|
104
|
+
<li><a href="classes/GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
105
|
+
<li><a href="classes/LambdaFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
|
|
106
|
+
<li><a href="classes/RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
107
|
+
<li><a href="classes/SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
|
|
108
|
+
<li><a href="classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
109
|
+
<li><a href="interfaces/AssetCdnProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
|
|
110
|
+
<li><a href="interfaces/BaseApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
|
|
111
|
+
<li><a href="interfaces/CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
|
|
112
|
+
<li><a href="interfaces/GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
|
|
113
|
+
<li><a href="interfaces/ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
|
|
114
|
+
<li><a href="interfaces/IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
|
|
115
|
+
<li><a href="interfaces/LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
|
|
116
|
+
<li><a href="interfaces/LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
|
|
117
|
+
<li><a href="interfaces/RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
|
|
118
|
+
<li><a href="interfaces/SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
|
|
119
|
+
<li><a href="interfaces/SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
|
|
120
|
+
<li><a href="interfaces/VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
121
|
+
<li><a href="interfaces/WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
|
|
122
|
+
<li><a href="types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
|
|
120
123
|
<div class="tsd-generator">
|
|
121
124
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
122
125
|
<div class="overlay"></div></body></html>
|
|
@@ -26,26 +26,28 @@
|
|
|
26
26
|
<div class="tsd-accordion-details">
|
|
27
27
|
<section class="tsd-index-section">
|
|
28
28
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
29
|
-
<div class="tsd-index-list"><a href="AssetCdnProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
30
|
-
<a href="AssetCdnProps.html#hostName" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
29
|
+
<div class="tsd-index-list"><a href="AssetCdnProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>domain<wbr/>Name</span></a>
|
|
30
|
+
<a href="AssetCdnProps.html#hostName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>host<wbr/>Name</span></a>
|
|
31
31
|
</div></section></div></details></section></section>
|
|
32
32
|
<section class="tsd-panel-group tsd-member-group">
|
|
33
33
|
<h2>Properties</h2>
|
|
34
34
|
<section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
|
|
35
|
-
<h3 class="tsd-anchor-link"><span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
35
|
+
<h3 class="tsd-anchor-link"><span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
36
36
|
<div class="tsd-signature"><span class="tsd-kind-property">domain<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
37
37
|
<div class="tsd-comment tsd-typography"><p>Domain name of the asset content delivery network (e.g. example.com)</p>
|
|
38
|
-
</div
|
|
38
|
+
</div>
|
|
39
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
39
40
|
<section class="tsd-panel tsd-member"><a id="hostName" class="tsd-anchor"></a>
|
|
40
|
-
<h3 class="tsd-anchor-link"><span>host<wbr/>Name</span><a href="#hostName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
41
|
+
<h3 class="tsd-anchor-link"><span>host<wbr/>Name</span><a href="#hostName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
41
42
|
<div class="tsd-signature"><span class="tsd-kind-property">host<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
42
43
|
<div class="tsd-comment tsd-typography"><p>Hostname of the asset content delivery network (e.g. cdn)</p>
|
|
43
|
-
</div
|
|
44
|
+
</div>
|
|
45
|
+
<div class="tsd-comment tsd-typography"></div></section></section></div>
|
|
44
46
|
<div class="col-sidebar">
|
|
45
47
|
<div class="page-menu">
|
|
46
48
|
<div class="tsd-navigation settings">
|
|
47
49
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
48
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
50
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
49
51
|
<div class="tsd-accordion-details">
|
|
50
52
|
<div class="tsd-filter-visibility">
|
|
51
53
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -57,33 +59,36 @@
|
|
|
57
59
|
<div class="tsd-theme-toggle">
|
|
58
60
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
59
61
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
60
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
62
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
61
63
|
<div class="tsd-accordion-details">
|
|
62
64
|
<ul>
|
|
63
|
-
<li><a href="#domainName" class=""><svg class="tsd-kind-icon"
|
|
64
|
-
<li><a href="#hostName" class=""><svg class="tsd-kind-icon"
|
|
65
|
+
<li><a href="#domainName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
|
|
66
|
+
<li><a href="#hostName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>host<wbr/>Name</span></a></li></ul></div></details></div>
|
|
65
67
|
<div class="site-menu">
|
|
66
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
68
|
+
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
67
69
|
<ul class="tsd-small-nested-navigation">
|
|
68
|
-
<li><a href="../classes/AssetCdn.html"><svg class="tsd-kind-icon"
|
|
69
|
-
<li><a href="../classes/BaseApi.html"><svg class="tsd-kind-icon"
|
|
70
|
-
<li><a href="../classes/CognitoAuthentication.html"><svg class="tsd-kind-icon"
|
|
71
|
-
<li><a href="../classes/
|
|
72
|
-
<li><a href="../classes/
|
|
73
|
-
<li><a href="../classes/
|
|
74
|
-
<li><a href="../classes/
|
|
75
|
-
<li><a href="
|
|
76
|
-
<li><a href="
|
|
77
|
-
<li><a href="
|
|
78
|
-
<li><a href="
|
|
79
|
-
<li><a href="
|
|
80
|
-
<li><a href="
|
|
81
|
-
<li><a href="
|
|
82
|
-
<li><a href="
|
|
83
|
-
<li><a href="
|
|
84
|
-
<li><a href="
|
|
85
|
-
<li><a href="
|
|
86
|
-
<li><a href="
|
|
70
|
+
<li><a href="../classes/AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
|
|
71
|
+
<li><a href="../classes/BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
|
|
72
|
+
<li><a href="../classes/CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
|
|
73
|
+
<li><a href="../classes/GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
74
|
+
<li><a href="../classes/LambdaFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
|
|
75
|
+
<li><a href="../classes/RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
76
|
+
<li><a href="../classes/SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
|
|
77
|
+
<li><a href="../classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
78
|
+
<li><a href="AssetCdnProps.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
|
|
79
|
+
<li><a href="BaseApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
|
|
80
|
+
<li><a href="CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
|
|
81
|
+
<li><a href="GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
|
|
82
|
+
<li><a href="ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
|
|
83
|
+
<li><a href="IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
|
|
84
|
+
<li><a href="LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
|
|
85
|
+
<li><a href="LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
|
|
86
|
+
<li><a href="RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
|
|
87
|
+
<li><a href="SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
|
|
88
|
+
<li><a href="SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
|
|
89
|
+
<li><a href="VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
90
|
+
<li><a href="WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
|
|
91
|
+
<li><a href="../types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
|
|
87
92
|
<div class="tsd-generator">
|
|
88
93
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
89
94
|
<div class="overlay"></div></body></html>
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li><span class="target">BaseApiProps</span>
|
|
22
22
|
<ul class="tsd-hierarchy">
|
|
23
|
+
<li><a href="GraphQlApiProps.html" class="tsd-signature-type tsd-kind-interface">GraphQlApiProps</a></li>
|
|
23
24
|
<li><a href="RestApiProps.html" class="tsd-signature-type tsd-kind-interface">RestApiProps</a></li></ul></li></ul></section>
|
|
24
25
|
<section class="tsd-panel-group tsd-index-group">
|
|
25
26
|
<section class="tsd-panel tsd-index-panel">
|
|
@@ -28,20 +29,20 @@
|
|
|
28
29
|
<div class="tsd-accordion-details">
|
|
29
30
|
<section class="tsd-index-section">
|
|
30
31
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
31
|
-
<div class="tsd-index-list"><a href="BaseApiProps.html#additionalEnv" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
32
|
-
<a href="BaseApiProps.html#apiName" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
33
|
-
<a href="BaseApiProps.html#assetCdn" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
34
|
-
<a href="BaseApiProps.html#authentication" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
35
|
-
<a href="BaseApiProps.html#lambdaOptions" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
36
|
-
<a href="BaseApiProps.html#lambdaTracing" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
37
|
-
<a href="BaseApiProps.html#monitoring" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
38
|
-
<a href="BaseApiProps.html#singleTableDatastore" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
39
|
-
<a href="BaseApiProps.html#stageName" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
32
|
+
<div class="tsd-index-list"><a href="BaseApiProps.html#additionalEnv" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>additional<wbr/>Env?</span></a>
|
|
33
|
+
<a href="BaseApiProps.html#apiName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a>
|
|
34
|
+
<a href="BaseApiProps.html#assetCdn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn?</span></a>
|
|
35
|
+
<a href="BaseApiProps.html#authentication" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication?</span></a>
|
|
36
|
+
<a href="BaseApiProps.html#lambdaOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options?</span></a>
|
|
37
|
+
<a href="BaseApiProps.html#lambdaTracing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing?</span></a>
|
|
38
|
+
<a href="BaseApiProps.html#monitoring" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring?</span></a>
|
|
39
|
+
<a href="BaseApiProps.html#singleTableDatastore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>single<wbr/>Table<wbr/>Datastore?</span></a>
|
|
40
|
+
<a href="BaseApiProps.html#stageName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stage<wbr/>Name</span></a>
|
|
40
41
|
</div></section></div></details></section></section>
|
|
41
42
|
<section class="tsd-panel-group tsd-member-group">
|
|
42
43
|
<h2>Properties</h2>
|
|
43
44
|
<section class="tsd-panel tsd-member"><a id="additionalEnv" class="tsd-anchor"></a>
|
|
44
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>additional<wbr/>Env</span><a href="#additionalEnv" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
45
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>additional<wbr/>Env</span><a href="#additionalEnv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
45
46
|
<div class="tsd-signature"><span class="tsd-kind-property">additional<wbr/>Env</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
46
47
|
<div class="tsd-comment tsd-typography"><p>Additional environment variables of all Lambda functions</p>
|
|
47
48
|
</div>
|
|
@@ -49,65 +50,73 @@
|
|
|
49
50
|
<h4>Type declaration</h4>
|
|
50
51
|
<ul class="tsd-parameters">
|
|
51
52
|
<li class="tsd-parameter-index-signature">
|
|
52
|
-
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div
|
|
53
|
+
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
54
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
53
55
|
<section class="tsd-panel tsd-member"><a id="apiName" class="tsd-anchor"></a>
|
|
54
|
-
<h3 class="tsd-anchor-link"><span>api<wbr/>Name</span><a href="#apiName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
56
|
+
<h3 class="tsd-anchor-link"><span>api<wbr/>Name</span><a href="#apiName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
55
57
|
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
56
58
|
<div class="tsd-comment tsd-typography"><p>Name of the API</p>
|
|
57
|
-
</div
|
|
59
|
+
</div>
|
|
60
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
58
61
|
<section class="tsd-panel tsd-member"><a id="assetCdn" class="tsd-anchor"></a>
|
|
59
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>asset<wbr/>Cdn</span><a href="#assetCdn" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
62
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>asset<wbr/>Cdn</span><a href="#assetCdn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
60
63
|
<div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Cdn</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/AssetCdn.html" class="tsd-signature-type tsd-kind-class">AssetCdn</a></div>
|
|
61
64
|
<div class="tsd-comment tsd-typography"><p>Configure a content delivery network for static assets</p>
|
|
62
|
-
|
|
63
|
-
<
|
|
65
|
+
</div>
|
|
66
|
+
<div class="tsd-comment tsd-typography">
|
|
67
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">none</span>
|
|
64
68
|
</code><button>Copy</button></pre>
|
|
65
69
|
</div></section>
|
|
66
70
|
<section class="tsd-panel tsd-member"><a id="authentication" class="tsd-anchor"></a>
|
|
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
|
|
71
|
+
<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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
68
72
|
<div class="tsd-signature"><span class="tsd-kind-property">authentication</span><span class="tsd-signature-symbol">?:</span> <a href="IJwtAuthentication.html" class="tsd-signature-type tsd-kind-interface">IJwtAuthentication</a><span class="tsd-signature-symbol"> | </span><a href="ICognitoAuthentication.html" class="tsd-signature-type tsd-kind-interface">ICognitoAuthentication</a></div>
|
|
69
73
|
<div class="tsd-comment tsd-typography"><p>Use a Cognito user pool for authorization.
|
|
70
74
|
Alternatively supply a JWT issuer and audience
|
|
71
75
|
to use any other JWT-based authorization service.</p>
|
|
72
|
-
|
|
73
|
-
<
|
|
76
|
+
</div>
|
|
77
|
+
<div class="tsd-comment tsd-typography">
|
|
78
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">none</span>
|
|
74
79
|
</code><button>Copy</button></pre>
|
|
75
80
|
</div></section>
|
|
76
81
|
<section class="tsd-panel tsd-member"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
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
|
|
82
|
+
<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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
78
83
|
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a></div>
|
|
79
84
|
<div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct</p>
|
|
80
|
-
</div
|
|
85
|
+
</div>
|
|
86
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
81
87
|
<section class="tsd-panel tsd-member"><a id="lambdaTracing" class="tsd-anchor"></a>
|
|
82
|
-
<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
|
|
88
|
+
<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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
83
89
|
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Tracing</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaTracingOptions.html" class="tsd-signature-type tsd-kind-interface">LambdaTracingOptions</a></div>
|
|
84
90
|
<div class="tsd-comment tsd-typography"><p>Tracing config for the generated Lambda functions</p>
|
|
85
|
-
</div
|
|
91
|
+
</div>
|
|
92
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
86
93
|
<section class="tsd-panel tsd-member"><a id="monitoring" class="tsd-anchor"></a>
|
|
87
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>monitoring</span><a href="#monitoring" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
94
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>monitoring</span><a href="#monitoring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
88
95
|
<div class="tsd-signature"><span class="tsd-kind-property">monitoring</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
89
96
|
<div class="tsd-comment tsd-typography"><p>Configure CloudWatch Dashboard for the API and the Lambda functions</p>
|
|
90
|
-
|
|
91
|
-
<
|
|
97
|
+
</div>
|
|
98
|
+
<div class="tsd-comment tsd-typography">
|
|
99
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
92
100
|
</code><button>Copy</button></pre>
|
|
93
101
|
</div></section>
|
|
94
102
|
<section class="tsd-panel tsd-member"><a id="singleTableDatastore" class="tsd-anchor"></a>
|
|
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
|
|
103
|
+
<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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
96
104
|
<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
105
|
<div class="tsd-comment tsd-typography">
|
|
98
|
-
<
|
|
106
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">none</span>
|
|
99
107
|
</code><button>Copy</button></pre>
|
|
100
108
|
</div></section>
|
|
101
109
|
<section class="tsd-panel tsd-member"><a id="stageName" class="tsd-anchor"></a>
|
|
102
|
-
<h3 class="tsd-anchor-link"><span>stage<wbr/>Name</span><a href="#stageName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
110
|
+
<h3 class="tsd-anchor-link"><span>stage<wbr/>Name</span><a href="#stageName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
103
111
|
<div class="tsd-signature"><span class="tsd-kind-property">stage<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
112
|
<div class="tsd-comment tsd-typography"><p>Deployment stage (e.g. dev)</p>
|
|
105
|
-
</div
|
|
113
|
+
</div>
|
|
114
|
+
<div class="tsd-comment tsd-typography"></div></section></section></div>
|
|
106
115
|
<div class="col-sidebar">
|
|
107
116
|
<div class="page-menu">
|
|
108
117
|
<div class="tsd-navigation settings">
|
|
109
118
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
110
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
119
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
111
120
|
<div class="tsd-accordion-details">
|
|
112
121
|
<div class="tsd-filter-visibility">
|
|
113
122
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -119,40 +128,43 @@ to use any other JWT-based authorization service.</p>
|
|
|
119
128
|
<div class="tsd-theme-toggle">
|
|
120
129
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
121
130
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
122
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
131
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
123
132
|
<div class="tsd-accordion-details">
|
|
124
133
|
<ul>
|
|
125
|
-
<li><a href="#additionalEnv" class=""><svg class="tsd-kind-icon"
|
|
126
|
-
<li><a href="#apiName" class=""><svg class="tsd-kind-icon"
|
|
127
|
-
<li><a href="#assetCdn" class=""><svg class="tsd-kind-icon"
|
|
128
|
-
<li><a href="#authentication" class=""><svg class="tsd-kind-icon"
|
|
129
|
-
<li><a href="#lambdaOptions" class=""><svg class="tsd-kind-icon"
|
|
130
|
-
<li><a href="#lambdaTracing" class=""><svg class="tsd-kind-icon"
|
|
131
|
-
<li><a href="#monitoring" class=""><svg class="tsd-kind-icon"
|
|
132
|
-
<li><a href="#singleTableDatastore" class=""><svg class="tsd-kind-icon"
|
|
133
|
-
<li><a href="#stageName" class=""><svg class="tsd-kind-icon"
|
|
134
|
+
<li><a href="#additionalEnv" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>additional<wbr/>Env</span></a></li>
|
|
135
|
+
<li><a href="#apiName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a></li>
|
|
136
|
+
<li><a href="#assetCdn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn</span></a></li>
|
|
137
|
+
<li><a href="#authentication" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication</span></a></li>
|
|
138
|
+
<li><a href="#lambdaOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a></li>
|
|
139
|
+
<li><a href="#lambdaTracing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing</span></a></li>
|
|
140
|
+
<li><a href="#monitoring" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring</span></a></li>
|
|
141
|
+
<li><a href="#singleTableDatastore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>single<wbr/>Table<wbr/>Datastore</span></a></li>
|
|
142
|
+
<li><a href="#stageName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stage<wbr/>Name</span></a></li></ul></div></details></div>
|
|
134
143
|
<div class="site-menu">
|
|
135
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
144
|
+
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
136
145
|
<ul class="tsd-small-nested-navigation">
|
|
137
|
-
<li><a href="../classes/AssetCdn.html"><svg class="tsd-kind-icon"
|
|
138
|
-
<li><a href="../classes/BaseApi.html"><svg class="tsd-kind-icon"
|
|
139
|
-
<li><a href="../classes/CognitoAuthentication.html"><svg class="tsd-kind-icon"
|
|
140
|
-
<li><a href="../classes/
|
|
141
|
-
<li><a href="../classes/
|
|
142
|
-
<li><a href="../classes/
|
|
143
|
-
<li><a href="../classes/
|
|
144
|
-
<li><a href="
|
|
145
|
-
<li><a href="
|
|
146
|
-
<li><a href="
|
|
147
|
-
<li><a href="
|
|
148
|
-
<li><a href="
|
|
149
|
-
<li><a href="
|
|
150
|
-
<li><a href="
|
|
151
|
-
<li><a href="
|
|
152
|
-
<li><a href="
|
|
153
|
-
<li><a href="
|
|
154
|
-
<li><a href="
|
|
155
|
-
<li><a href="
|
|
146
|
+
<li><a href="../classes/AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
|
|
147
|
+
<li><a href="../classes/BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
|
|
148
|
+
<li><a href="../classes/CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
|
|
149
|
+
<li><a href="../classes/GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
150
|
+
<li><a href="../classes/LambdaFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
|
|
151
|
+
<li><a href="../classes/RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
152
|
+
<li><a href="../classes/SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
|
|
153
|
+
<li><a href="../classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
154
|
+
<li><a href="AssetCdnProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
|
|
155
|
+
<li><a href="BaseApiProps.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
|
|
156
|
+
<li><a href="CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
|
|
157
|
+
<li><a href="GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
|
|
158
|
+
<li><a href="ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
|
|
159
|
+
<li><a href="IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
|
|
160
|
+
<li><a href="LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
|
|
161
|
+
<li><a href="LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
|
|
162
|
+
<li><a href="RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
|
|
163
|
+
<li><a href="SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
|
|
164
|
+
<li><a href="SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
|
|
165
|
+
<li><a href="VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
166
|
+
<li><a href="WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
|
|
167
|
+
<li><a href="../types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
|
|
156
168
|
<div class="tsd-generator">
|
|
157
169
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
158
170
|
<div class="overlay"></div></body></html>
|