cdk-serverless 2.4.3 → 2.6.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/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/classes/AssetCdn.html +1 -0
- package/docs/constructs/classes/BaseApi.html +24 -3
- package/docs/constructs/classes/CognitoAuthentication.html +1 -0
- package/docs/constructs/classes/GraphQlApi.html +35 -6
- package/docs/constructs/classes/LambdaFunction.html +1 -0
- package/docs/constructs/classes/RestApi.html +25 -0
- package/docs/constructs/classes/SingleTableDatastore.html +1 -0
- package/docs/constructs/classes/Workflow.html +1 -0
- package/docs/constructs/index.html +1 -0
- package/docs/constructs/interfaces/AssetCdnProps.html +1 -0
- package/docs/constructs/interfaces/BaseApiProps.html +36 -0
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +1 -0
- package/docs/constructs/interfaces/GraphQlApiProps.html +25 -8
- package/docs/constructs/interfaces/ICognitoAuthentication.html +1 -0
- package/docs/constructs/interfaces/IJwtAuthentication.html +1 -0
- package/docs/constructs/interfaces/JsResolverOptions.html +106 -0
- package/docs/constructs/interfaces/LambdaFunctionProps.html +1 -0
- package/docs/constructs/interfaces/LambdaTracingOptions.html +1 -0
- package/docs/constructs/interfaces/RestApiProps.html +25 -8
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +1 -0
- package/docs/constructs/interfaces/SingleTableDesign.html +1 -0
- package/docs/constructs/interfaces/VtlResolverOptions.html +1 -0
- package/docs/constructs/interfaces/WorkflowProps.html +1 -0
- package/docs/constructs/modules.html +2 -0
- package/docs/constructs/types/LambdaOptions.html +1 -0
- package/docs/projen/interfaces/ServerlessProjectOptions.html +13 -0
- package/lib/constructs/base-api.d.ts +28 -1
- package/lib/constructs/base-api.js +16 -2
- package/lib/constructs/graphql.d.ts +18 -14
- package/lib/constructs/graphql.js +96 -64
- package/lib/constructs/rest-api.d.ts +0 -12
- package/lib/constructs/rest-api.js +8 -11
- package/package.json +11 -11
|
@@ -39,7 +39,11 @@
|
|
|
39
39
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
40
40
|
<div class="tsd-index-list"><a href="GraphQlApi.html#_functions" class="tsd-index-link tsd-is-private"><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>_functions</span></a>
|
|
41
41
|
<a href="GraphQlApi.html#api" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api</span></a>
|
|
42
|
+
<a href="GraphQlApi.html#apiDomainName" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Domain<wbr/>Name?</span></a>
|
|
43
|
+
<a href="GraphQlApi.html#apiFQDN" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>apiFQDN?</span></a>
|
|
44
|
+
<a href="GraphQlApi.html#apiHostName" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Host<wbr/>Name?</span></a>
|
|
42
45
|
<a href="GraphQlApi.html#cognitoAuth" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cognito<wbr/>Auth</span></a>
|
|
46
|
+
<a href="GraphQlApi.html#hostedZone" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
|
|
43
47
|
<a href="GraphQlApi.html#node" 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>node</span></a>
|
|
44
48
|
<a href="GraphQlApi.html#props" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a>
|
|
45
49
|
<a href="GraphQlApi.html#tableDataSource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>table<wbr/>Data<wbr/>Source?</span></a>
|
|
@@ -97,9 +101,25 @@
|
|
|
97
101
|
<section class="tsd-panel tsd-member"><a id="api" class="tsd-anchor"></a>
|
|
98
102
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api</span><a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
99
103
|
<div class="tsd-signature"><span class="tsd-kind-property">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">GraphqlApi</span></div></section>
|
|
104
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiDomainName" class="tsd-anchor"></a>
|
|
105
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api<wbr/>Domain<wbr/>Name</span><a href="#apiDomainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
106
|
+
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Domain<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
107
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiDomainName">apiDomainName</a></p></aside></section>
|
|
108
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiFQDN" class="tsd-anchor"></a>
|
|
109
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>apiFQDN</span><a href="#apiFQDN" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
110
|
+
<div class="tsd-signature"><span class="tsd-kind-property">apiFQDN</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
111
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiFQDN">apiFQDN</a></p></aside></section>
|
|
112
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiHostName" class="tsd-anchor"></a>
|
|
113
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api<wbr/>Host<wbr/>Name</span><a href="#apiHostName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
114
|
+
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Host<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
115
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiHostName">apiHostName</a></p></aside></section>
|
|
100
116
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="cognitoAuth" class="tsd-anchor"></a>
|
|
101
117
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>cognito<wbr/>Auth</span><a href="#cognitoAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
102
118
|
<div class="tsd-signature"><span class="tsd-kind-property">cognito<wbr/>Auth</span><span class="tsd-signature-symbol">:</span> <a href="CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></div></section>
|
|
119
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="hostedZone" class="tsd-anchor"></a>
|
|
120
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
121
|
+
<div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div><aside class="tsd-sources">
|
|
122
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#hostedZone">hostedZone</a></p></aside></section>
|
|
103
123
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
104
124
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
105
125
|
<div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div>
|
|
@@ -120,7 +140,7 @@
|
|
|
120
140
|
<section class="tsd-panel tsd-member"><a id="addDynamoDbJSResolver" class="tsd-anchor"></a>
|
|
121
141
|
<h3 class="tsd-anchor-link"><span>add<wbr/>Dynamo<wbr/>DbJSResolver</span><a href="#addDynamoDbJSResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
122
142
|
<ul class="tsd-signatures">
|
|
123
|
-
<li class="tsd-signature tsd-anchor-link" id="addDynamoDbJSResolver.addDynamoDbJSResolver-1"><span class="tsd-kind-call-signature">add<wbr/>Dynamo<wbr/>DbJSResolver</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TYPE</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">typeName</span>, <span class="tsd-kind-parameter">fieldName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDynamoDbJSResolver.addDynamoDbJSResolver-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
143
|
+
<li class="tsd-signature tsd-anchor-link" id="addDynamoDbJSResolver.addDynamoDbJSResolver-1"><span class="tsd-kind-call-signature">add<wbr/>Dynamo<wbr/>DbJSResolver</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TYPE</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">typeName</span>, <span class="tsd-kind-parameter">fieldName</span>, <span class="tsd-kind-parameter">options</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="#addDynamoDbJSResolver.addDynamoDbJSResolver-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
124
144
|
<li class="tsd-description">
|
|
125
145
|
<section class="tsd-panel">
|
|
126
146
|
<h4>Type Parameters</h4>
|
|
@@ -135,7 +155,9 @@
|
|
|
135
155
|
<li>
|
|
136
156
|
<h5><span class="tsd-kind-parameter">typeName</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TYPE</span></h5></li>
|
|
137
157
|
<li>
|
|
138
|
-
<h5><span class="tsd-kind-parameter">fieldName</span>: <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span></h5></li
|
|
158
|
+
<h5><span class="tsd-kind-parameter">fieldName</span>: <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span></h5></li>
|
|
159
|
+
<li>
|
|
160
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/JsResolverOptions.html" class="tsd-signature-type tsd-kind-interface">JsResolverOptions</a></h5></li></ul></div>
|
|
139
161
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
|
|
140
162
|
<section class="tsd-panel tsd-member"><a id="addDynamoDbVtlResolver" class="tsd-anchor"></a>
|
|
141
163
|
<h3 class="tsd-anchor-link"><span>add<wbr/>Dynamo<wbr/>Db<wbr/>Vtl<wbr/>Resolver</span><a href="#addDynamoDbVtlResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
@@ -162,7 +184,7 @@
|
|
|
162
184
|
<section class="tsd-panel tsd-member"><a id="addJSResolver" class="tsd-anchor"></a>
|
|
163
185
|
<h3 class="tsd-anchor-link"><span>addJSResolver</span><a href="#addJSResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
164
186
|
<ul class="tsd-signatures">
|
|
165
|
-
<li class="tsd-signature tsd-anchor-link" id="addJSResolver.addJSResolver-1"><span class="tsd-kind-call-signature">addJSResolver</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TYPE</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">typeName</span>, <span class="tsd-kind-parameter">fieldName</span>, <span class="tsd-kind-parameter">dataSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addJSResolver.addJSResolver-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
187
|
+
<li class="tsd-signature tsd-anchor-link" id="addJSResolver.addJSResolver-1"><span class="tsd-kind-call-signature">addJSResolver</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TYPE</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">typeName</span>, <span class="tsd-kind-parameter">fieldName</span>, <span class="tsd-kind-parameter">dataSource</span>, <span class="tsd-kind-parameter">options</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="#addJSResolver.addJSResolver-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
166
188
|
<li class="tsd-description">
|
|
167
189
|
<section class="tsd-panel">
|
|
168
190
|
<h4>Type Parameters</h4>
|
|
@@ -179,7 +201,9 @@
|
|
|
179
201
|
<li>
|
|
180
202
|
<h5><span class="tsd-kind-parameter">fieldName</span>: <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type tsd-kind-type-parameter">FIELDTYPE</span></h5></li>
|
|
181
203
|
<li>
|
|
182
|
-
<h5><span class="tsd-kind-parameter">dataSource</span>: <span class="tsd-signature-type ">BaseDataSource</span></h5></li
|
|
204
|
+
<h5><span class="tsd-kind-parameter">dataSource</span>: <span class="tsd-signature-type ">BaseDataSource</span></h5></li>
|
|
205
|
+
<li>
|
|
206
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/JsResolverOptions.html" class="tsd-signature-type tsd-kind-interface">JsResolverOptions</a></h5></li></ul></div>
|
|
183
207
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
|
|
184
208
|
<section class="tsd-panel tsd-member"><a id="addLambdaResolver" class="tsd-anchor"></a>
|
|
185
209
|
<h3 class="tsd-anchor-link"><span>add<wbr/>Lambda<wbr/>Resolver</span><a href="#addLambdaResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
@@ -241,13 +265,13 @@
|
|
|
241
265
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="createJSResolverFile" class="tsd-anchor"></a>
|
|
242
266
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>createJSResolver<wbr/>File</span><a href="#createJSResolverFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
243
267
|
<ul class="tsd-signatures tsd-is-private">
|
|
244
|
-
<li class="tsd-signature tsd-anchor-link" id="createJSResolverFile.createJSResolverFile-1"><span class="tsd-kind-call-signature">createJSResolver<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">
|
|
268
|
+
<li class="tsd-signature tsd-anchor-link" id="createJSResolverFile.createJSResolverFile-1"><span class="tsd-kind-call-signature">createJSResolver<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">typeName</span>, <span class="tsd-kind-parameter">fieldName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#createJSResolverFile.createJSResolverFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
245
269
|
<li class="tsd-description">
|
|
246
270
|
<div class="tsd-parameters">
|
|
247
271
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
248
272
|
<ul class="tsd-parameter-list">
|
|
249
273
|
<li>
|
|
250
|
-
<h5><span class="tsd-kind-parameter">
|
|
274
|
+
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type ">JsResolverConfig</span></h5></li>
|
|
251
275
|
<li>
|
|
252
276
|
<h5><span class="tsd-kind-parameter">typeName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
253
277
|
<li>
|
|
@@ -412,7 +436,11 @@
|
|
|
412
436
|
<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>
|
|
413
437
|
<li><a href="#_functions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_functions</span></a></li>
|
|
414
438
|
<li><a href="#api" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api</span></a></li>
|
|
439
|
+
<li><a href="#apiDomainName" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Domain<wbr/>Name</span></a></li>
|
|
440
|
+
<li><a href="#apiFQDN" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>apiFQDN</span></a></li>
|
|
441
|
+
<li><a href="#apiHostName" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Host<wbr/>Name</span></a></li>
|
|
415
442
|
<li><a href="#cognitoAuth" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cognito<wbr/>Auth</span></a></li>
|
|
443
|
+
<li><a href="#hostedZone" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
|
|
416
444
|
<li><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node</span></a></li>
|
|
417
445
|
<li><a href="#props" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a></li>
|
|
418
446
|
<li><a href="#tableDataSource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>table<wbr/>Data<wbr/>Source</span></a></li>
|
|
@@ -447,6 +475,7 @@
|
|
|
447
475
|
<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>
|
|
448
476
|
<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>
|
|
449
477
|
<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>
|
|
478
|
+
<li><a href="../interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
450
479
|
<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>
|
|
451
480
|
<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>
|
|
452
481
|
<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>
|
|
@@ -1153,6 +1153,7 @@ within this stack.</p>
|
|
|
1153
1153
|
<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>
|
|
1154
1154
|
<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>
|
|
1155
1155
|
<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>
|
|
1156
|
+
<li><a href="../interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
1156
1157
|
<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>
|
|
1157
1158
|
<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>
|
|
1158
1159
|
<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>
|
|
@@ -41,7 +41,11 @@
|
|
|
41
41
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
42
42
|
<div class="tsd-index-list"><a href="RestApi.html#_functions" class="tsd-index-link tsd-is-private"><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>_functions</span></a>
|
|
43
43
|
<a href="RestApi.html#api" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api</span></a>
|
|
44
|
+
<a href="RestApi.html#apiDomainName" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Domain<wbr/>Name?</span></a>
|
|
45
|
+
<a href="RestApi.html#apiFQDN" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>apiFQDN?</span></a>
|
|
46
|
+
<a href="RestApi.html#apiHostName" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Host<wbr/>Name?</span></a>
|
|
44
47
|
<a href="RestApi.html#apiSpec" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Spec</span></a>
|
|
48
|
+
<a href="RestApi.html#hostedZone" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
|
|
45
49
|
<a href="RestApi.html#node" 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>node</span></a>
|
|
46
50
|
<a href="RestApi.html#props" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a>
|
|
47
51
|
</div></section>
|
|
@@ -96,9 +100,25 @@
|
|
|
96
100
|
<section class="tsd-panel tsd-member"><a id="api" class="tsd-anchor"></a>
|
|
97
101
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api</span><a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
98
102
|
<div class="tsd-signature"><span class="tsd-kind-property">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">SpecRestApi</span></div></section>
|
|
103
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiDomainName" class="tsd-anchor"></a>
|
|
104
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api<wbr/>Domain<wbr/>Name</span><a href="#apiDomainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
105
|
+
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Domain<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
106
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiDomainName">apiDomainName</a></p></aside></section>
|
|
107
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiFQDN" class="tsd-anchor"></a>
|
|
108
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>apiFQDN</span><a href="#apiFQDN" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
109
|
+
<div class="tsd-signature"><span class="tsd-kind-property">apiFQDN</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
110
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiFQDN">apiFQDN</a></p></aside></section>
|
|
111
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiHostName" class="tsd-anchor"></a>
|
|
112
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api<wbr/>Host<wbr/>Name</span><a href="#apiHostName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
113
|
+
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Host<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
114
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiHostName">apiHostName</a></p></aside></section>
|
|
99
115
|
<section class="tsd-panel tsd-member"><a id="apiSpec" class="tsd-anchor"></a>
|
|
100
116
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api<wbr/>Spec</span><a href="#apiSpec" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
101
117
|
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Spec</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">OpenAPI3</span></div></section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="hostedZone" class="tsd-anchor"></a>
|
|
119
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
120
|
+
<div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div><aside class="tsd-sources">
|
|
121
|
+
<p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#hostedZone">hostedZone</a></p></aside></section>
|
|
102
122
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
103
123
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
104
124
|
<div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div>
|
|
@@ -307,7 +327,11 @@ THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!</p>
|
|
|
307
327
|
<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>
|
|
308
328
|
<li><a href="#_functions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_functions</span></a></li>
|
|
309
329
|
<li><a href="#api" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api</span></a></li>
|
|
330
|
+
<li><a href="#apiDomainName" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Domain<wbr/>Name</span></a></li>
|
|
331
|
+
<li><a href="#apiFQDN" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>apiFQDN</span></a></li>
|
|
332
|
+
<li><a href="#apiHostName" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Host<wbr/>Name</span></a></li>
|
|
310
333
|
<li><a href="#apiSpec" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Spec</span></a></li>
|
|
334
|
+
<li><a href="#hostedZone" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
|
|
311
335
|
<li><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node</span></a></li>
|
|
312
336
|
<li><a href="#props" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a></li>
|
|
313
337
|
<li><a href="#addCustomRestResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Custom<wbr/>Rest<wbr/>Resource</span></a></li>
|
|
@@ -337,6 +361,7 @@ THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!</p>
|
|
|
337
361
|
<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>
|
|
338
362
|
<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>
|
|
339
363
|
<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>
|
|
364
|
+
<li><a href="../interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
340
365
|
<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>
|
|
341
366
|
<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>
|
|
342
367
|
<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>
|
|
@@ -148,6 +148,7 @@
|
|
|
148
148
|
<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>
|
|
149
149
|
<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>
|
|
150
150
|
<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>
|
|
151
|
+
<li><a href="../interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
151
152
|
<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>
|
|
152
153
|
<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>
|
|
153
154
|
<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>
|
|
@@ -163,6 +163,7 @@
|
|
|
163
163
|
<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>
|
|
164
164
|
<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>
|
|
165
165
|
<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>
|
|
166
|
+
<li><a href="../interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
166
167
|
<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>
|
|
167
168
|
<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>
|
|
168
169
|
<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>
|
|
@@ -112,6 +112,7 @@
|
|
|
112
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
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
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/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
115
116
|
<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
117
|
<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
118
|
<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>
|
|
@@ -81,6 +81,7 @@
|
|
|
81
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
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
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="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
84
85
|
<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
86
|
<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
87
|
<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>
|
|
@@ -30,9 +30,12 @@
|
|
|
30
30
|
<section class="tsd-index-section">
|
|
31
31
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
32
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#apiHostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
|
|
33
34
|
<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
35
|
<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
36
|
<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>
|
|
37
|
+
<a href="BaseApiProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
|
|
38
|
+
<a href="BaseApiProps.html#hostedZone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
|
|
36
39
|
<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
40
|
<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
41
|
<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>
|
|
@@ -52,6 +55,15 @@
|
|
|
52
55
|
<li class="tsd-parameter-index-signature">
|
|
53
56
|
<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
57
|
<div class="tsd-comment tsd-typography"></div></section>
|
|
58
|
+
<section class="tsd-panel tsd-member"><a id="apiHostname" class="tsd-anchor"></a>
|
|
59
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Hostname</span><a href="#apiHostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
60
|
+
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Hostname</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
61
|
+
<div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
|
|
62
|
+
</div>
|
|
63
|
+
<div class="tsd-comment tsd-typography">
|
|
64
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">api</span>
|
|
65
|
+
</code><button>Copy</button></pre>
|
|
66
|
+
</div></section>
|
|
55
67
|
<section class="tsd-panel tsd-member"><a id="apiName" class="tsd-anchor"></a>
|
|
56
68
|
<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>
|
|
57
69
|
<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>
|
|
@@ -78,6 +90,26 @@ to use any other JWT-based authorization service.</p>
|
|
|
78
90
|
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">none</span>
|
|
79
91
|
</code><button>Copy</button></pre>
|
|
80
92
|
</div></section>
|
|
93
|
+
<section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
|
|
94
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
95
|
+
<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>
|
|
96
|
+
<div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. example.com)</p>
|
|
97
|
+
<p>only one of hostedZone and domainName can be specified</p>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tsd-comment tsd-typography">
|
|
100
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
|
|
101
|
+
</code><button>Copy</button></pre>
|
|
102
|
+
</div></section>
|
|
103
|
+
<section class="tsd-panel tsd-member"><a id="hostedZone" class="tsd-anchor"></a>
|
|
104
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
105
|
+
<div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div>
|
|
106
|
+
<div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. example.com)</p>
|
|
107
|
+
<p>only one of hostedZone and domainName can be specified</p>
|
|
108
|
+
</div>
|
|
109
|
+
<div class="tsd-comment tsd-typography">
|
|
110
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
|
|
111
|
+
</code><button>Copy</button></pre>
|
|
112
|
+
</div></section>
|
|
81
113
|
<section class="tsd-panel tsd-member"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
82
114
|
<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>
|
|
83
115
|
<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>
|
|
@@ -132,9 +164,12 @@ to use any other JWT-based authorization service.</p>
|
|
|
132
164
|
<div class="tsd-accordion-details">
|
|
133
165
|
<ul>
|
|
134
166
|
<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>
|
|
167
|
+
<li><a href="#apiHostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
|
|
135
168
|
<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
169
|
<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
170
|
<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>
|
|
171
|
+
<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>
|
|
172
|
+
<li><a href="#hostedZone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
|
|
138
173
|
<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
174
|
<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
175
|
<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>
|
|
@@ -157,6 +192,7 @@ to use any other JWT-based authorization service.</p>
|
|
|
157
192
|
<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
193
|
<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
194
|
<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>
|
|
195
|
+
<li><a href="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
160
196
|
<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
197
|
<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
198
|
<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>
|
|
@@ -167,6 +167,7 @@ Value: group description</p>
|
|
|
167
167
|
<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>
|
|
168
168
|
<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>
|
|
169
169
|
<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>
|
|
170
|
+
<li><a href="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
170
171
|
<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>
|
|
171
172
|
<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>
|
|
172
173
|
<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>
|
|
@@ -29,12 +29,13 @@
|
|
|
29
29
|
<section class="tsd-index-section">
|
|
30
30
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
31
31
|
<div class="tsd-index-list"><a href="GraphQlApiProps.html#additionalEnv" class="tsd-index-link tsd-is-inherited"><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>
|
|
32
|
-
<a href="GraphQlApiProps.html#apiHostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
|
|
32
|
+
<a href="GraphQlApiProps.html#apiHostname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
|
|
33
33
|
<a href="GraphQlApiProps.html#apiName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a>
|
|
34
34
|
<a href="GraphQlApiProps.html#assetCdn" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn?</span></a>
|
|
35
35
|
<a href="GraphQlApiProps.html#authentication" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication?</span></a>
|
|
36
36
|
<a href="GraphQlApiProps.html#definitionFileName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a>
|
|
37
|
-
<a href="GraphQlApiProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
|
|
37
|
+
<a href="GraphQlApiProps.html#domainName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
|
|
38
|
+
<a href="GraphQlApiProps.html#hostedZone" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
|
|
38
39
|
<a href="GraphQlApiProps.html#lambdaOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options?</span></a>
|
|
39
40
|
<a href="GraphQlApiProps.html#lambdaTracing" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing?</span></a>
|
|
40
41
|
<a href="GraphQlApiProps.html#monitoring" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring?</span></a>
|
|
@@ -55,7 +56,7 @@
|
|
|
55
56
|
<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>
|
|
56
57
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
57
58
|
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#additionalEnv">additionalEnv</a></p></aside></section>
|
|
58
|
-
<section class="tsd-panel tsd-member"><a id="apiHostname" class="tsd-anchor"></a>
|
|
59
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiHostname" class="tsd-anchor"></a>
|
|
59
60
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Hostname</span><a href="#apiHostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
60
61
|
<div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Hostname</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
61
62
|
<div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
|
|
@@ -63,7 +64,8 @@
|
|
|
63
64
|
<div class="tsd-comment tsd-typography">
|
|
64
65
|
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">api</span>
|
|
65
66
|
</code><button>Copy</button></pre>
|
|
66
|
-
</div
|
|
67
|
+
</div><aside class="tsd-sources">
|
|
68
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apiHostname">apiHostname</a></p></aside></section>
|
|
67
69
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiName" class="tsd-anchor"></a>
|
|
68
70
|
<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>
|
|
69
71
|
<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>
|
|
@@ -96,15 +98,28 @@ to use any other JWT-based authorization service.</p>
|
|
|
96
98
|
<section class="tsd-panel tsd-member"><a id="definitionFileName" class="tsd-anchor"></a>
|
|
97
99
|
<h3 class="tsd-anchor-link"><span>definition<wbr/>File<wbr/>Name</span><a href="#definitionFileName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
98
100
|
<div class="tsd-signature"><span class="tsd-kind-property">definition<wbr/>File<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
|
|
99
|
-
<section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
|
|
101
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="domainName" class="tsd-anchor"></a>
|
|
100
102
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
101
103
|
<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>
|
|
102
104
|
<div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. example.com)</p>
|
|
105
|
+
<p>only one of hostedZone and domainName can be specified</p>
|
|
103
106
|
</div>
|
|
104
107
|
<div class="tsd-comment tsd-typography">
|
|
105
108
|
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
|
|
106
109
|
</code><button>Copy</button></pre>
|
|
107
|
-
</div
|
|
110
|
+
</div><aside class="tsd-sources">
|
|
111
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#domainName">domainName</a></p></aside></section>
|
|
112
|
+
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hostedZone" class="tsd-anchor"></a>
|
|
113
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
114
|
+
<div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div>
|
|
115
|
+
<div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. example.com)</p>
|
|
116
|
+
<p>only one of hostedZone and domainName can be specified</p>
|
|
117
|
+
</div>
|
|
118
|
+
<div class="tsd-comment tsd-typography">
|
|
119
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
|
|
120
|
+
</code><button>Copy</button></pre>
|
|
121
|
+
</div><aside class="tsd-sources">
|
|
122
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#hostedZone">hostedZone</a></p></aside></section>
|
|
108
123
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
109
124
|
<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>
|
|
110
125
|
<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>
|
|
@@ -164,12 +179,13 @@ to use any other JWT-based authorization service.</p>
|
|
|
164
179
|
<div class="tsd-accordion-details">
|
|
165
180
|
<ul>
|
|
166
181
|
<li><a href="#additionalEnv" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>additional<wbr/>Env</span></a></li>
|
|
167
|
-
<li><a href="#apiHostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
|
|
182
|
+
<li><a href="#apiHostname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
|
|
168
183
|
<li><a href="#apiName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a></li>
|
|
169
184
|
<li><a href="#assetCdn" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn</span></a></li>
|
|
170
185
|
<li><a href="#authentication" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication</span></a></li>
|
|
171
186
|
<li><a href="#definitionFileName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a></li>
|
|
172
|
-
<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>
|
|
187
|
+
<li><a href="#domainName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
|
|
188
|
+
<li><a href="#hostedZone" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
|
|
173
189
|
<li><a href="#lambdaOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a></li>
|
|
174
190
|
<li><a href="#lambdaTracing" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing</span></a></li>
|
|
175
191
|
<li><a href="#monitoring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring</span></a></li>
|
|
@@ -192,6 +208,7 @@ to use any other JWT-based authorization service.</p>
|
|
|
192
208
|
<li><a href="GraphQlApiProps.html" class="current"><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>
|
|
193
209
|
<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>
|
|
194
210
|
<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>
|
|
211
|
+
<li><a href="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
195
212
|
<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>
|
|
196
213
|
<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>
|
|
197
214
|
<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>
|
|
@@ -77,6 +77,7 @@
|
|
|
77
77
|
<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>
|
|
78
78
|
<li><a href="ICognitoAuthentication.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
|
|
79
79
|
<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>
|
|
80
|
+
<li><a href="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
80
81
|
<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>
|
|
81
82
|
<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>
|
|
82
83
|
<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>
|
|
@@ -89,6 +89,7 @@
|
|
|
89
89
|
<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>
|
|
90
90
|
<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>
|
|
91
91
|
<li><a href="IJwtAuthentication.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
|
|
92
|
+
<li><a href="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
92
93
|
<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>
|
|
93
94
|
<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>
|
|
94
95
|
<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>
|