cdk-serverless 2.1.0 → 2.2.0
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
|
@@ -28,28 +28,28 @@
|
|
|
28
28
|
<div class="tsd-accordion-details">
|
|
29
29
|
<section class="tsd-index-section">
|
|
30
30
|
<h3 class="tsd-index-heading">Constructors</h3>
|
|
31
|
-
<div class="tsd-index-list"><a href="Workflow.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
31
|
+
<div class="tsd-index-list"><a href="Workflow.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></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>constructor</span></a>
|
|
32
32
|
</div></section>
|
|
33
33
|
<section class="tsd-index-section">
|
|
34
34
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
35
|
-
<div class="tsd-index-list"><a href="Workflow.html#options" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
36
|
-
<a href="Workflow.html#project" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
35
|
+
<div class="tsd-index-list"><a href="Workflow.html#options" class="tsd-index-link tsd-is-protected"><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>options</span></a>
|
|
36
|
+
<a href="Workflow.html#project" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project</span></a>
|
|
37
37
|
</div></section>
|
|
38
38
|
<section class="tsd-index-section">
|
|
39
39
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
40
|
-
<div class="tsd-index-list"><a href="Workflow.html#createConstructFile" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
41
|
-
<a href="Workflow.html#postSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
42
|
-
<a href="Workflow.html#preSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
43
|
-
<a href="Workflow.html#renderDefinitionSubstitution" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
44
|
-
<a href="Workflow.html#renderStateConfigDefinition" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
45
|
-
<a href="Workflow.html#synthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
40
|
+
<div class="tsd-index-list"><a href="Workflow.html#createConstructFile" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Construct<wbr/>File</span></a>
|
|
41
|
+
<a href="Workflow.html#postSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a>
|
|
42
|
+
<a href="Workflow.html#preSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a>
|
|
43
|
+
<a href="Workflow.html#renderDefinitionSubstitution" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Definition<wbr/>Substitution</span></a>
|
|
44
|
+
<a href="Workflow.html#renderStateConfigDefinition" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span></a>
|
|
45
|
+
<a href="Workflow.html#synthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synthesize</span></a>
|
|
46
46
|
</div></section></div></details></section></section>
|
|
47
47
|
<section class="tsd-panel-group tsd-member-group">
|
|
48
48
|
<h2>Constructors</h2>
|
|
49
49
|
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
50
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
50
|
+
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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>
|
|
51
51
|
<ul class="tsd-signatures">
|
|
52
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Workflow"><span class="tsd-kind-constructor-signature">new <wbr/>Workflow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">app</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><a href="#constructor.new_Workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
52
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Workflow"><span class="tsd-kind-constructor-signature">new <wbr/>Workflow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">app</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><a href="#constructor.new_Workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
53
53
|
<li class="tsd-description">
|
|
54
54
|
<div class="tsd-parameters">
|
|
55
55
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -63,18 +63,18 @@
|
|
|
63
63
|
<section class="tsd-panel-group tsd-member-group">
|
|
64
64
|
<h2>Properties</h2>
|
|
65
65
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="options" class="tsd-anchor"></a>
|
|
66
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
66
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
67
67
|
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkflowOptions.html" class="tsd-signature-type tsd-kind-interface">WorkflowOptions</a></div></section>
|
|
68
68
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="project" class="tsd-anchor"></a>
|
|
69
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project</span><a href="#project" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
69
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project</span><a href="#project" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
70
70
|
<div class="tsd-signature"><span class="tsd-kind-property">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Project</span></div><aside class="tsd-sources">
|
|
71
71
|
<p>Inherited from pj.Component.project</p></aside></section></section>
|
|
72
72
|
<section class="tsd-panel-group tsd-member-group">
|
|
73
73
|
<h2>Methods</h2>
|
|
74
74
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="createConstructFile" class="tsd-anchor"></a>
|
|
75
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>Construct<wbr/>File</span><a href="#createConstructFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
75
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>Construct<wbr/>File</span><a href="#createConstructFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
76
76
|
<ul class="tsd-signatures tsd-is-protected">
|
|
77
|
-
<li class="tsd-signature tsd-anchor-link" id="createConstructFile.createConstructFile-1"><span class="tsd-kind-call-signature">create<wbr/>Construct<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fileName</span>, <span class="tsd-kind-parameter">matchedVariables</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#createConstructFile.createConstructFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
77
|
+
<li class="tsd-signature tsd-anchor-link" id="createConstructFile.createConstructFile-1"><span class="tsd-kind-call-signature">create<wbr/>Construct<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fileName</span>, <span class="tsd-kind-parameter">matchedVariables</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#createConstructFile.createConstructFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
78
78
|
<li class="tsd-description">
|
|
79
79
|
<div class="tsd-parameters">
|
|
80
80
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -85,27 +85,29 @@
|
|
|
85
85
|
<h5><span class="tsd-kind-parameter">matchedVariables</span>: <span class="tsd-signature-type ">VariableDefinition</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
86
86
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
|
|
87
87
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postSynthesize" class="tsd-anchor"></a>
|
|
88
|
-
<h3 class="tsd-anchor-link"><span>post<wbr/>Synthesize</span><a href="#postSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
88
|
+
<h3 class="tsd-anchor-link"><span>post<wbr/>Synthesize</span><a href="#postSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></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="postSynthesize.postSynthesize-1"><span class="tsd-kind-call-signature">post<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#postSynthesize.postSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
90
|
+
<li class="tsd-signature tsd-anchor-link" id="postSynthesize.postSynthesize-1"><span class="tsd-kind-call-signature">post<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#postSynthesize.postSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
91
91
|
<li class="tsd-description">
|
|
92
92
|
<div class="tsd-comment tsd-typography"><p>Called after synthesis. Order is <em>not</em> guaranteed.</p>
|
|
93
93
|
</div>
|
|
94
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
94
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
95
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
95
96
|
<p>Inherited from pj.Component.postSynthesize</p></aside></li></ul></section>
|
|
96
97
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="preSynthesize" class="tsd-anchor"></a>
|
|
97
|
-
<h3 class="tsd-anchor-link"><span>pre<wbr/>Synthesize</span><a href="#preSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
98
|
+
<h3 class="tsd-anchor-link"><span>pre<wbr/>Synthesize</span><a href="#preSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
98
99
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
99
|
-
<li class="tsd-signature tsd-anchor-link" id="preSynthesize.preSynthesize-1"><span class="tsd-kind-call-signature">pre<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#preSynthesize.preSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
100
|
+
<li class="tsd-signature tsd-anchor-link" id="preSynthesize.preSynthesize-1"><span class="tsd-kind-call-signature">pre<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#preSynthesize.preSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
100
101
|
<li class="tsd-description">
|
|
101
102
|
<div class="tsd-comment tsd-typography"><p>Called before synthesis.</p>
|
|
102
103
|
</div>
|
|
103
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
104
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
105
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
104
106
|
<p>Inherited from pj.Component.preSynthesize</p></aside></li></ul></section>
|
|
105
107
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="renderDefinitionSubstitution" class="tsd-anchor"></a>
|
|
106
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>render<wbr/>Definition<wbr/>Substitution</span><a href="#renderDefinitionSubstitution" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
108
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>render<wbr/>Definition<wbr/>Substitution</span><a href="#renderDefinitionSubstitution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
107
109
|
<ul class="tsd-signatures tsd-is-protected">
|
|
108
|
-
<li class="tsd-signature tsd-anchor-link" id="renderDefinitionSubstitution.renderDefinitionSubstitution-1"><span class="tsd-kind-call-signature">render<wbr/>Definition<wbr/>Substitution</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">def</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#renderDefinitionSubstitution.renderDefinitionSubstitution-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
110
|
+
<li class="tsd-signature tsd-anchor-link" id="renderDefinitionSubstitution.renderDefinitionSubstitution-1"><span class="tsd-kind-call-signature">render<wbr/>Definition<wbr/>Substitution</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">def</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#renderDefinitionSubstitution.renderDefinitionSubstitution-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
109
111
|
<li class="tsd-description">
|
|
110
112
|
<div class="tsd-parameters">
|
|
111
113
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -114,9 +116,9 @@
|
|
|
114
116
|
<h5><span class="tsd-kind-parameter">def</span>: <span class="tsd-signature-type ">VariableDefinition</span></h5></li></ul></div>
|
|
115
117
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section>
|
|
116
118
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="renderStateConfigDefinition" class="tsd-anchor"></a>
|
|
117
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>render<wbr/>State<wbr/>Config<wbr/>Definition</span><a href="#renderStateConfigDefinition" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
119
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>render<wbr/>State<wbr/>Config<wbr/>Definition</span><a href="#renderStateConfigDefinition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
118
120
|
<ul class="tsd-signatures tsd-is-protected">
|
|
119
|
-
<li class="tsd-signature tsd-anchor-link" id="renderStateConfigDefinition.renderStateConfigDefinition-1"><span class="tsd-kind-call-signature">render<wbr/>State<wbr/>Config<wbr/>Definition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">def</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#renderStateConfigDefinition.renderStateConfigDefinition-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
121
|
+
<li class="tsd-signature tsd-anchor-link" id="renderStateConfigDefinition.renderStateConfigDefinition-1"><span class="tsd-kind-call-signature">render<wbr/>State<wbr/>Config<wbr/>Definition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">def</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#renderStateConfigDefinition.renderStateConfigDefinition-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
120
122
|
<li class="tsd-description">
|
|
121
123
|
<div class="tsd-parameters">
|
|
122
124
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -125,19 +127,20 @@
|
|
|
125
127
|
<h5><span class="tsd-kind-parameter">def</span>: <span class="tsd-signature-type ">VariableDefinition</span></h5></li></ul></div>
|
|
126
128
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section>
|
|
127
129
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="synthesize" class="tsd-anchor"></a>
|
|
128
|
-
<h3 class="tsd-anchor-link"><span>synthesize</span><a href="#synthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
130
|
+
<h3 class="tsd-anchor-link"><span>synthesize</span><a href="#synthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
129
131
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
130
|
-
<li class="tsd-signature tsd-anchor-link" id="synthesize.synthesize-1"><span class="tsd-kind-call-signature">synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#synthesize.synthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
132
|
+
<li class="tsd-signature tsd-anchor-link" id="synthesize.synthesize-1"><span class="tsd-kind-call-signature">synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#synthesize.synthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
131
133
|
<li class="tsd-description">
|
|
132
134
|
<div class="tsd-comment tsd-typography"><p>Synthesizes files to the project output directory.</p>
|
|
133
135
|
</div>
|
|
134
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
136
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
137
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
135
138
|
<p>Inherited from pj.Component.synthesize</p></aside></li></ul></section></section></div>
|
|
136
139
|
<div class="col-sidebar">
|
|
137
140
|
<div class="page-menu">
|
|
138
141
|
<div class="tsd-navigation settings">
|
|
139
142
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
140
|
-
<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>
|
|
143
|
+
<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>
|
|
141
144
|
<div class="tsd-accordion-details">
|
|
142
145
|
<div class="tsd-filter-visibility">
|
|
143
146
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -149,30 +152,32 @@
|
|
|
149
152
|
<div class="tsd-theme-toggle">
|
|
150
153
|
<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>
|
|
151
154
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
152
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
155
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
153
156
|
<div class="tsd-accordion-details">
|
|
154
157
|
<ul>
|
|
155
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon"
|
|
156
|
-
<li><a href="#options" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
157
|
-
<li><a href="#project" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
158
|
-
<li><a href="#createConstructFile" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
159
|
-
<li><a href="#postSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
160
|
-
<li><a href="#preSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
161
|
-
<li><a href="#renderDefinitionSubstitution" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
162
|
-
<li><a href="#renderStateConfigDefinition" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
163
|
-
<li><a href="#synthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
158
|
+
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
|
159
|
+
<li><a href="#options" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>options</span></a></li>
|
|
160
|
+
<li><a href="#project" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project</span></a></li>
|
|
161
|
+
<li><a href="#createConstructFile" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Construct<wbr/>File</span></a></li>
|
|
162
|
+
<li><a href="#postSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a></li>
|
|
163
|
+
<li><a href="#preSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a></li>
|
|
164
|
+
<li><a href="#renderDefinitionSubstitution" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Definition<wbr/>Substitution</span></a></li>
|
|
165
|
+
<li><a href="#renderStateConfigDefinition" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span></a></li>
|
|
166
|
+
<li><a href="#synthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synthesize</span></a></li></ul></div></details></div>
|
|
164
167
|
<div class="site-menu">
|
|
165
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
168
|
+
<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>
|
|
166
169
|
<ul class="tsd-small-nested-navigation">
|
|
167
|
-
<li><a href="Datastore.html"><svg class="tsd-kind-icon"
|
|
168
|
-
<li><a href="
|
|
169
|
-
<li><a href="
|
|
170
|
-
<li><a href="
|
|
171
|
-
<li><a href="
|
|
172
|
-
<li><a href="../interfaces/
|
|
173
|
-
<li><a href="../interfaces/
|
|
174
|
-
<li><a href="../interfaces/
|
|
175
|
-
<li><a href="../
|
|
170
|
+
<li><a href="Datastore.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>Datastore</span></a></li>
|
|
171
|
+
<li><a href="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>
|
|
172
|
+
<li><a href="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>
|
|
173
|
+
<li><a href="ServerlessProject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
174
|
+
<li><a href="Workflow.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
175
|
+
<li><a href="../interfaces/DatastoreOptions.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>Datastore<wbr/>Options</span></a></li>
|
|
176
|
+
<li><a href="../interfaces/GraphQlApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Options</span></a></li>
|
|
177
|
+
<li><a href="../interfaces/RestApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Options</span></a></li>
|
|
178
|
+
<li><a href="../interfaces/ServerlessProjectOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Serverless<wbr/>Project<wbr/>Options</span></a></li>
|
|
179
|
+
<li><a href="../interfaces/WorkflowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Options</span></a></li>
|
|
180
|
+
<li><a href="../variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>PACKAGE_<wbr/>NAME</span></a></li></ul></nav></div></div></div>
|
|
176
181
|
<div class="tsd-generator">
|
|
177
182
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
178
183
|
<div class="overlay"></div></body></html>
|
package/docs/projen/index.html
CHANGED
|
@@ -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,17 +96,19 @@
|
|
|
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/Datastore.html"><svg class="tsd-kind-icon"
|
|
102
|
-
<li><a href="classes/
|
|
103
|
-
<li><a href="classes/
|
|
104
|
-
<li><a href="classes/
|
|
105
|
-
<li><a href="
|
|
106
|
-
<li><a href="interfaces/
|
|
107
|
-
<li><a href="interfaces/
|
|
108
|
-
<li><a href="interfaces/
|
|
109
|
-
<li><a href="
|
|
101
|
+
<li><a href="classes/Datastore.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>Datastore</span></a></li>
|
|
102
|
+
<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>
|
|
103
|
+
<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>
|
|
104
|
+
<li><a href="classes/ServerlessProject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
105
|
+
<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>
|
|
106
|
+
<li><a href="interfaces/DatastoreOptions.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>Datastore<wbr/>Options</span></a></li>
|
|
107
|
+
<li><a href="interfaces/GraphQlApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Options</span></a></li>
|
|
108
|
+
<li><a href="interfaces/RestApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Options</span></a></li>
|
|
109
|
+
<li><a href="interfaces/ServerlessProjectOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Serverless<wbr/>Project<wbr/>Options</span></a></li>
|
|
110
|
+
<li><a href="interfaces/WorkflowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Options</span></a></li>
|
|
111
|
+
<li><a href="variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>PACKAGE_<wbr/>NAME</span></a></li></ul></nav></div></div></div>
|
|
110
112
|
<div class="tsd-generator">
|
|
111
113
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
112
114
|
<div class="overlay"></div></body></html>
|
|
@@ -26,22 +26,22 @@
|
|
|
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="DatastoreOptions.html#definitionFile" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
30
|
-
<a href="DatastoreOptions.html#modelName" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
29
|
+
<div class="tsd-index-list"><a href="DatastoreOptions.html#definitionFile" 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>definition<wbr/>File</span></a>
|
|
30
|
+
<a href="DatastoreOptions.html#modelName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model<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="definitionFile" class="tsd-anchor"></a>
|
|
35
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>definition<wbr/>File</span><a href="#definitionFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
35
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>definition<wbr/>File</span><a href="#definitionFile" 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">definition<wbr/>File</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
|
|
37
37
|
<section class="tsd-panel tsd-member"><a id="modelName" class="tsd-anchor"></a>
|
|
38
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>model<wbr/>Name</span><a href="#modelName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
38
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>model<wbr/>Name</span><a href="#modelName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
39
39
|
<div class="tsd-signature"><span class="tsd-kind-property">model<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section></section></div>
|
|
40
40
|
<div class="col-sidebar">
|
|
41
41
|
<div class="page-menu">
|
|
42
42
|
<div class="tsd-navigation settings">
|
|
43
43
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
44
|
-
<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>
|
|
44
|
+
<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>
|
|
45
45
|
<div class="tsd-accordion-details">
|
|
46
46
|
<div class="tsd-filter-visibility">
|
|
47
47
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -53,23 +53,25 @@
|
|
|
53
53
|
<div class="tsd-theme-toggle">
|
|
54
54
|
<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>
|
|
55
55
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
56
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
56
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
57
57
|
<div class="tsd-accordion-details">
|
|
58
58
|
<ul>
|
|
59
|
-
<li><a href="#definitionFile" class=""><svg class="tsd-kind-icon"
|
|
60
|
-
<li><a href="#modelName" class=""><svg class="tsd-kind-icon"
|
|
59
|
+
<li><a href="#definitionFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File</span></a></li>
|
|
60
|
+
<li><a href="#modelName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>model<wbr/>Name</span></a></li></ul></div></details></div>
|
|
61
61
|
<div class="site-menu">
|
|
62
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
62
|
+
<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>
|
|
63
63
|
<ul class="tsd-small-nested-navigation">
|
|
64
|
-
<li><a href="../classes/Datastore.html"><svg class="tsd-kind-icon"
|
|
65
|
-
<li><a href="../classes/
|
|
66
|
-
<li><a href="../classes/
|
|
67
|
-
<li><a href="../classes/
|
|
68
|
-
<li><a href="
|
|
69
|
-
<li><a href="
|
|
70
|
-
<li><a href="
|
|
71
|
-
<li><a href="
|
|
72
|
-
<li><a href="
|
|
64
|
+
<li><a href="../classes/Datastore.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>Datastore</span></a></li>
|
|
65
|
+
<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>
|
|
66
|
+
<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>
|
|
67
|
+
<li><a href="../classes/ServerlessProject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
68
|
+
<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>
|
|
69
|
+
<li><a href="DatastoreOptions.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>Datastore<wbr/>Options</span></a></li>
|
|
70
|
+
<li><a href="GraphQlApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Options</span></a></li>
|
|
71
|
+
<li><a href="RestApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Options</span></a></li>
|
|
72
|
+
<li><a href="ServerlessProjectOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Serverless<wbr/>Project<wbr/>Options</span></a></li>
|
|
73
|
+
<li><a href="WorkflowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Options</span></a></li>
|
|
74
|
+
<li><a href="../variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>PACKAGE_<wbr/>NAME</span></a></li></ul></nav></div></div></div>
|
|
73
75
|
<div class="tsd-generator">
|
|
74
76
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
75
77
|
<div class="overlay"></div></body></html>
|