cdk-serverless 3.3.2 → 3.4.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/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-233633-review.md +98 -0
- package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-234937-review.md +86 -0
- package/.agents/tasks/task-dependency-cve-upgrade/context.json +24 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-001.json +28 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-002.json +33 -0
- package/.agents/tasks/task-dependency-cve-upgrade/task.json +7 -0
- package/docs/constructs/assets/hierarchy.js +1 -1
- package/docs/constructs/assets/highlight.css +1 -1
- package/docs/constructs/assets/main.js +1 -1
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +18 -3
- package/docs/constructs/classes/AssetCdn.html +161 -20
- package/docs/constructs/classes/BaseApi.html +153 -13
- package/docs/constructs/classes/CognitoAuthentication.html +188 -22
- package/docs/constructs/classes/GraphQlApi.html +349 -23
- package/docs/constructs/classes/LambdaFunction.html +1074 -106
- package/docs/constructs/classes/McpAuth.html +152 -16
- package/docs/constructs/classes/McpCognitoAuth.html +152 -16
- package/docs/constructs/classes/RestApi.html +344 -37
- package/docs/constructs/classes/SingleTableDatastore.html +173 -19
- package/docs/constructs/classes/Workflow.html +170 -21
- package/docs/constructs/hierarchy.html +47 -1
- package/docs/constructs/index.html +75 -2
- package/docs/constructs/interfaces/AssetCdnProps.html +61 -5
- package/docs/constructs/interfaces/BaseApiProps.html +141 -20
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +135 -20
- package/docs/constructs/interfaces/GraphQlApiProps.html +185 -22
- package/docs/constructs/interfaces/ICognitoAuthentication.html +57 -3
- package/docs/constructs/interfaces/IJwtAuthentication.html +63 -5
- package/docs/constructs/interfaces/ISingleTableDatastore.html +57 -3
- package/docs/constructs/interfaces/JsResolverOptions.html +66 -6
- package/docs/constructs/interfaces/LambdaFunctionProps.html +126 -18
- package/docs/constructs/interfaces/LambdaTracingOptions.html +57 -4
- package/docs/constructs/interfaces/McpAuthCognitoOptions.html +75 -8
- package/docs/constructs/interfaces/McpAuthFunctions.html +76 -8
- package/docs/constructs/interfaces/McpAuthGenericOptions.html +66 -6
- package/docs/constructs/interfaces/McpAuthOptions.html +107 -15
- package/docs/constructs/interfaces/McpAuthProps.html +123 -18
- package/docs/constructs/interfaces/McpCognitoAuthProps.html +127 -19
- package/docs/constructs/interfaces/RestApiProps.html +237 -37
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +77 -9
- package/docs/constructs/interfaces/SingleTableDesign.html +72 -7
- package/docs/constructs/interfaces/VtlResolverOptions.html +62 -5
- package/docs/constructs/interfaces/WorkflowProps.html +63 -2
- package/docs/constructs/modules.html +44 -1
- package/docs/constructs/types/LambdaOptions.html +31 -1
- package/docs/experiments/appsync-unit-resolver-error-probe.md +201 -0
- package/docs/lambda/assets/hierarchy.js +1 -1
- package/docs/lambda/assets/highlight.css +1 -1
- package/docs/lambda/assets/main.js +1 -1
- package/docs/lambda/assets/navigation.js +1 -1
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +18 -3
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +247 -20
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +246 -20
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +242 -21
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +235 -20
- package/docs/lambda/classes/auth.JwtAuthorizer.html +225 -20
- package/docs/lambda/classes/errors.BadRequestError.html +147 -11
- package/docs/lambda/classes/errors.ForbiddenError.html +147 -11
- package/docs/lambda/classes/errors.HttpError.html +154 -12
- package/docs/lambda/classes/errors.NotFoundError.html +147 -11
- package/docs/lambda/classes/errors.UnauthenticatedError.html +147 -11
- package/docs/lambda/classes/errors.appsync.AppSyncError.html +193 -0
- package/docs/lambda/classes/errors.appsync.ConflictError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ForbiddenError.html +184 -0
- package/docs/lambda/classes/errors.appsync.NotFoundError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ValidationError.html +184 -0
- package/docs/lambda/functions/api.createAppSyncHandler.html +50 -3
- package/docs/lambda/functions/api.createHttpHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +47 -2
- package/docs/lambda/hierarchy.html +59 -1
- package/docs/lambda/index.html +75 -2
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +68 -3
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +67 -3
- package/docs/lambda/interfaces/api.HttpResponseContext.html +61 -3
- package/docs/lambda/interfaces/api.Operation.html +61 -3
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +65 -3
- package/docs/lambda/modules/api.html +45 -1
- package/docs/lambda/modules/auth.html +37 -1
- package/docs/lambda/modules/errors.appsync.html +38 -0
- package/docs/lambda/modules/errors.html +41 -1
- package/docs/lambda/modules.html +36 -1
- package/docs/lambda/types/api.APIGatewayv1Handler.html +34 -2
- package/docs/lambda/types/api.AppSyncHandler.html +51 -2
- package/docs/lambda/types/api.HttpHandler.html +52 -2
- package/docs/projen/assets/highlight.css +5 -12
- package/docs/projen/assets/main.js +1 -1
- package/docs/projen/assets/style.css +18 -3
- package/docs/projen/classes/Datastore.html +254 -18
- package/docs/projen/classes/GraphQlApi.html +238 -18
- package/docs/projen/classes/RestApi.html +325 -40
- package/docs/projen/classes/ServerlessProject.html +1021 -159
- package/docs/projen/classes/Workflow.html +288 -31
- package/docs/projen/hierarchy.html +29 -1
- package/docs/projen/index.html +75 -2
- package/docs/projen/interfaces/DatastoreOptions.html +54 -2
- package/docs/projen/interfaces/GraphQlApiOptions.html +54 -2
- package/docs/projen/interfaces/RestApiOptions.html +54 -2
- package/docs/projen/interfaces/ServerlessProjectOptions.html +2089 -692
- package/docs/projen/interfaces/WorkflowOptions.html +54 -2
- package/docs/projen/modules.html +44 -1
- package/docs/projen/variables/PACKAGE_NAME.html +31 -1
- package/lib/constructs/graphql.d.ts +17 -0
- package/lib/constructs/graphql.js +78 -2
- package/lib/lambda/appsync-errors.d.ts +67 -0
- package/lib/lambda/appsync-errors.js +91 -0
- package/lib/lambda/errors.d.ts +1 -0
- package/lib/lambda/errors.js +36 -2
- package/lib/lambda/handler.js +78 -1
- package/llm.md +31 -0
- package/package.json +26 -24
|
@@ -1,4 +1,30 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GraphQlApiProps | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GraphQlApiProps | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">GraphQlApiProps</a></li></ul>
|
|
12
|
+
<h1>Interface GraphQlApiProps</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GraphQlApiProps</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#additionalenv">additionalEnv</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#apihostname">apiHostname</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#apiname">apiName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#assetcdn">assetCdn</a><span class="tsd-signature-symbol">?:</span> <a href="../classes/AssetCdn.html" class="tsd-signature-type tsd-kind-class">AssetCdn</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authentication">authentication</a><span class="tsd-signature-symbol">?:</span> <a href="IJwtAuthentication.html" class="tsd-signature-type tsd-kind-interface">IJwtAuthentication</a> <span class="tsd-signature-symbol">|</span> <a href="ICognitoAuthentication.html" class="tsd-signature-type tsd-kind-interface">ICognitoAuthentication</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#definitionfilename">definitionFileName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#domainname">domainName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hostedzone">hostedZone</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IHostedZone</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lambdaoptions">lambdaOptions</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lambdatracing">lambdaTracing</a><span class="tsd-signature-symbol">?:</span> <a href="LambdaTracingOptions.html" class="tsd-signature-type tsd-kind-interface">LambdaTracingOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#monitoring">monitoring</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#singletabledatastore">singleTableDatastore</a><span class="tsd-signature-symbol">?:</span> <a href="ISingleTableDatastore.html" class="tsd-signature-type tsd-kind-interface">ISingleTableDatastore</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stagename">stageName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typederrors">typedErrors</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usenestedstacks">useNestedStacks</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="359">
|
|
15
|
+
<h4>Hierarchy (<a href="../hierarchy.html#GraphQlApiProps">View Summary</a>)</h4>
|
|
16
|
+
<ul class="tsd-hierarchy">
|
|
17
|
+
<li class="tsd-hierarchy-item"><a href="BaseApiProps.html" class="tsd-signature-type tsd-kind-interface">BaseApiProps</a>
|
|
18
|
+
<ul class="tsd-hierarchy">
|
|
19
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">GraphQlApiProps</span></li></ul></li></ul></section>
|
|
20
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
21
|
+
<section class="tsd-panel tsd-index-panel">
|
|
22
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
23
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
24
|
+
<div class="tsd-accordion-details">
|
|
25
|
+
<section class="tsd-index-section">
|
|
26
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
27
|
+
<div class="tsd-index-list"><a href="#additionalenv" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional<wbr/>Env?</span></a>
|
|
2
28
|
<a href="#apihostname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
|
|
3
29
|
<a href="#apiname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Name</span></a>
|
|
4
30
|
<a href="#assetcdn" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Cdn?</span></a>
|
|
@@ -11,44 +37,155 @@
|
|
|
11
37
|
<a href="#monitoring" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>monitoring?</span></a>
|
|
12
38
|
<a href="#singletabledatastore" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>single<wbr/>Table<wbr/>Datastore?</span></a>
|
|
13
39
|
<a href="#stagename" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stage<wbr/>Name</span></a>
|
|
40
|
+
<a href="#typederrors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typed<wbr/>Errors?</span></a>
|
|
14
41
|
<a href="#usenestedstacks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Nested<wbr/>Stacks?</span></a>
|
|
15
|
-
</div></section></div></details></section></section
|
|
16
|
-
|
|
17
|
-
|
|
42
|
+
</div></section></div></details></section></section>
|
|
43
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
44
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
45
|
+
<section>
|
|
46
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
47
|
+
<h3 class="tsd-anchor-link" id="additionalenv"><code class="tsd-tag">Optional</code><span>additional<wbr/>Env</span><a href="#additionalenv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
48
|
+
<div class="tsd-signature"><span class="tsd-kind-property">additionalEnv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div>
|
|
49
|
+
<div class="tsd-comment tsd-typography"><p>Additional environment variables of all Lambda functions</p>
|
|
50
|
+
</div><aside class="tsd-sources">
|
|
51
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#additionalenv">additionalEnv</a></p></aside></section>
|
|
52
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
53
|
+
<h3 class="tsd-anchor-link" id="apihostname"><code class="tsd-tag">Optional</code><span>api<wbr/>Hostname</span><a href="#apihostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
54
|
+
<div class="tsd-signature"><span class="tsd-kind-property">apiHostname</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
55
|
+
<div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
|
|
56
|
+
</div>
|
|
57
|
+
<div class="tsd-comment tsd-typography">
|
|
58
|
+
<div class="tsd-tag-default">
|
|
59
|
+
<h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">api</span>
|
|
18
60
|
</code><button type="button">Copy</button></pre>
|
|
19
61
|
|
|
20
|
-
</div></div><aside class="tsd-sources"
|
|
21
|
-
|
|
22
|
-
|
|
62
|
+
</div></div><aside class="tsd-sources">
|
|
63
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apihostname">apiHostname</a></p></aside></section>
|
|
64
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
65
|
+
<h3 class="tsd-anchor-link" id="apiname"><span>api<wbr/>Name</span><a href="#apiname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
66
|
+
<div class="tsd-signature"><span class="tsd-kind-property">apiName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
67
|
+
<div class="tsd-comment tsd-typography"><p>Name of the API</p>
|
|
68
|
+
</div><aside class="tsd-sources">
|
|
69
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apiname">apiName</a></p></aside></section>
|
|
70
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
71
|
+
<h3 class="tsd-anchor-link" id="assetcdn"><code class="tsd-tag">Optional</code><span>asset<wbr/>Cdn</span><a href="#assetcdn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
72
|
+
<div class="tsd-signature"><span class="tsd-kind-property">assetCdn</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/AssetCdn.html" class="tsd-signature-type tsd-kind-class">AssetCdn</a></div>
|
|
73
|
+
<div class="tsd-comment tsd-typography"><p>Configure a content delivery network for static assets</p>
|
|
74
|
+
</div>
|
|
75
|
+
<div class="tsd-comment tsd-typography">
|
|
76
|
+
<div class="tsd-tag-default">
|
|
77
|
+
<h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">none</span>
|
|
23
78
|
</code><button type="button">Copy</button></pre>
|
|
24
79
|
|
|
25
|
-
</div></div><aside class="tsd-sources"
|
|
80
|
+
</div></div><aside class="tsd-sources">
|
|
81
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#assetcdn">assetCdn</a></p></aside></section>
|
|
82
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
83
|
+
<h3 class="tsd-anchor-link" id="authentication"><code class="tsd-tag">Optional</code><span>authentication</span><a href="#authentication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
84
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authentication</span><span class="tsd-signature-symbol">?:</span> <a href="IJwtAuthentication.html" class="tsd-signature-type tsd-kind-interface">IJwtAuthentication</a> <span class="tsd-signature-symbol">|</span> <a href="ICognitoAuthentication.html" class="tsd-signature-type tsd-kind-interface">ICognitoAuthentication</a></div>
|
|
85
|
+
<div class="tsd-comment tsd-typography"><p>Use a Cognito user pool for authorization.
|
|
26
86
|
Alternatively supply a JWT issuer and audience
|
|
27
87
|
to use any other JWT-based authorization service.</p>
|
|
28
|
-
</div
|
|
88
|
+
</div>
|
|
89
|
+
<div class="tsd-comment tsd-typography">
|
|
90
|
+
<div class="tsd-tag-default">
|
|
91
|
+
<h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">none</span>
|
|
29
92
|
</code><button type="button">Copy</button></pre>
|
|
30
93
|
|
|
31
|
-
</div></div><aside class="tsd-sources"
|
|
94
|
+
</div></div><aside class="tsd-sources">
|
|
95
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#authentication">authentication</a></p></aside></section>
|
|
96
|
+
<section class="tsd-panel tsd-member">
|
|
97
|
+
<h3 class="tsd-anchor-link" id="definitionfilename"><span>definition<wbr/>File<wbr/>Name</span><a href="#definitionfilename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
98
|
+
<div class="tsd-signature"><span class="tsd-kind-property">definitionFileName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
|
|
99
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
100
|
+
<h3 class="tsd-anchor-link" id="domainname"><code class="tsd-tag">Optional</code><span>domain<wbr/>Name</span><a href="#domainname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
101
|
+
<div class="tsd-signature"><span class="tsd-kind-property">domainName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
|
+
<div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. <a href="http://example.com">example.com</a>)</p>
|
|
32
103
|
<p>only one of hostedZone and domainName can be specified</p>
|
|
33
|
-
</div
|
|
104
|
+
</div>
|
|
105
|
+
<div class="tsd-comment tsd-typography">
|
|
106
|
+
<div class="tsd-tag-default">
|
|
107
|
+
<h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-4">No</span><span class="hl-1"> </span><span class="hl-4">custom</span><span class="hl-1"> </span><span class="hl-4">domain</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">configured</span>
|
|
34
108
|
</code><button type="button">Copy</button></pre>
|
|
35
109
|
|
|
36
|
-
</div></div><aside class="tsd-sources"
|
|
110
|
+
</div></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">
|
|
113
|
+
<h3 class="tsd-anchor-link" id="hostedzone"><code class="tsd-tag">Optional</code><span>hosted<wbr/>Zone</span><a href="#hostedzone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
114
|
+
<div class="tsd-signature"><span class="tsd-kind-property">hostedZone</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. <a href="http://example.com">example.com</a>)</p>
|
|
37
116
|
<p>only one of hostedZone and domainName can be specified</p>
|
|
38
|
-
</div
|
|
117
|
+
</div>
|
|
118
|
+
<div class="tsd-comment tsd-typography">
|
|
119
|
+
<div class="tsd-tag-default">
|
|
120
|
+
<h4 class="tsd-anchor-link" id="default-4">Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-4">No</span><span class="hl-1"> </span><span class="hl-4">custom</span><span class="hl-1"> </span><span class="hl-4">domain</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">configured</span>
|
|
39
121
|
</code><button type="button">Copy</button></pre>
|
|
40
122
|
|
|
41
|
-
</div></div><aside class="tsd-sources"
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
123
|
+
</div></div><aside class="tsd-sources">
|
|
124
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#hostedzone">hostedZone</a></p></aside></section>
|
|
125
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
126
|
+
<h3 class="tsd-anchor-link" id="lambdaoptions"><code class="tsd-tag">Optional</code><span>lambda<wbr/>Options</span><a href="#lambdaoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
127
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lambdaOptions</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a></div>
|
|
128
|
+
<div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct</p>
|
|
129
|
+
</div><aside class="tsd-sources">
|
|
130
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#lambdaoptions">lambdaOptions</a></p></aside></section>
|
|
131
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
132
|
+
<h3 class="tsd-anchor-link" id="lambdatracing"><code class="tsd-tag">Optional</code><span>lambda<wbr/>Tracing</span><a href="#lambdatracing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
133
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lambdaTracing</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaTracingOptions.html" class="tsd-signature-type tsd-kind-interface">LambdaTracingOptions</a></div>
|
|
134
|
+
<div class="tsd-comment tsd-typography"><p>Tracing config for the generated Lambda functions</p>
|
|
135
|
+
</div><aside class="tsd-sources">
|
|
136
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#lambdatracing">lambdaTracing</a></p></aside></section>
|
|
137
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
138
|
+
<h3 class="tsd-anchor-link" id="monitoring"><code class="tsd-tag">Optional</code><span>monitoring</span><a href="#monitoring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
139
|
+
<div class="tsd-signature"><span class="tsd-kind-property">monitoring</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
140
|
+
<div class="tsd-comment tsd-typography"><p>Configure CloudWatch Dashboard for the API and the Lambda functions</p>
|
|
141
|
+
</div>
|
|
142
|
+
<div class="tsd-comment tsd-typography">
|
|
143
|
+
<div class="tsd-tag-default">
|
|
144
|
+
<h4 class="tsd-anchor-link" id="default-5">Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">true</span>
|
|
45
145
|
</code><button type="button">Copy</button></pre>
|
|
46
146
|
|
|
47
|
-
</div></div><aside class="tsd-sources"
|
|
147
|
+
</div></div><aside class="tsd-sources">
|
|
148
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#monitoring">monitoring</a></p></aside></section>
|
|
149
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
150
|
+
<h3 class="tsd-anchor-link" id="singletabledatastore"><code class="tsd-tag">Optional</code><span>single<wbr/>Table<wbr/>Datastore</span><a href="#singletabledatastore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
151
|
+
<div class="tsd-signature"><span class="tsd-kind-property">singleTableDatastore</span><span class="tsd-signature-symbol">?:</span> <a href="ISingleTableDatastore.html" class="tsd-signature-type tsd-kind-interface">ISingleTableDatastore</a></div>
|
|
152
|
+
<div class="tsd-comment tsd-typography">
|
|
153
|
+
<div class="tsd-tag-default">
|
|
154
|
+
<h4 class="tsd-anchor-link" id="default-6">Default<a href="#default-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">none</span>
|
|
48
155
|
</code><button type="button">Copy</button></pre>
|
|
49
156
|
|
|
50
|
-
</div></div><aside class="tsd-sources"
|
|
51
|
-
|
|
157
|
+
</div></div><aside class="tsd-sources">
|
|
158
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#singletabledatastore">singleTableDatastore</a></p></aside></section>
|
|
159
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
160
|
+
<h3 class="tsd-anchor-link" id="stagename"><span>stage<wbr/>Name</span><a href="#stagename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
161
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stageName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
162
|
+
<div class="tsd-comment tsd-typography"><p>Deployment stage (e.g. dev)</p>
|
|
163
|
+
</div><aside class="tsd-sources">
|
|
164
|
+
<p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#stagename">stageName</a></p></aside></section>
|
|
165
|
+
<section class="tsd-panel tsd-member">
|
|
166
|
+
<h3 class="tsd-anchor-link" id="typederrors"><code class="tsd-tag">Optional</code><span>typed<wbr/>Errors</span><a href="#typederrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
167
|
+
<div class="tsd-signature"><span class="tsd-kind-property">typedErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
168
|
+
<div class="tsd-comment tsd-typography"><p>If true, addLambdaResolver synthesizes an APPSYNC_JS pipeline resolver whose
|
|
169
|
+
response handler converts the errors.appsync.* envelope returned by
|
|
170
|
+
createAppSyncHandler into a typed GraphQL error.</p>
|
|
171
|
+
<p>When false (the default), addLambdaResolver synthesizes a plain UNIT
|
|
172
|
+
direct-Lambda resolver (the pre-#385 behavior) with no response handler. On
|
|
173
|
+
that path, if a handler throws an AppSyncError the sentinel envelope is
|
|
174
|
+
returned as field data instead of becoming a GraphQL error.</p>
|
|
175
|
+
<p>This flag applies to ALL Lambda resolvers on the API. Enabling it changes
|
|
176
|
+
the resolver topology from UNIT to PIPELINE, which produces a cdk diff for
|
|
177
|
+
every Lambda resolver, so opt in deliberately.</p>
|
|
178
|
+
</div>
|
|
179
|
+
<div class="tsd-comment tsd-typography">
|
|
180
|
+
<div class="tsd-tag-default">
|
|
181
|
+
<h4 class="tsd-anchor-link" id="default-7">Default<a href="#default-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">false</span>
|
|
182
|
+
</code><button type="button">Copy</button></pre>
|
|
183
|
+
|
|
184
|
+
</div></div></section>
|
|
185
|
+
<section class="tsd-panel tsd-member">
|
|
186
|
+
<h3 class="tsd-anchor-link" id="usenestedstacks"><code class="tsd-tag">Optional</code><span>use<wbr/>Nested<wbr/>Stacks</span><a href="#usenestedstacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
187
|
+
<div class="tsd-signature"><span class="tsd-kind-property">useNestedStacks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
188
|
+
<div class="tsd-comment tsd-typography"><p>If true, resolvers and Lambda functions will be created in nested stacks
|
|
52
189
|
grouped by type (Query, Mutation, Subscription, Field).</p>
|
|
53
190
|
<p>WARNING: Only enable this if you are approaching or hitting CloudFormation's
|
|
54
191
|
500 resource limit. Nested stacks have significant downsides:</p>
|
|
@@ -61,7 +198,33 @@ grouped by type (Query, Mutation, Subscription, Field).</p>
|
|
|
61
198
|
<p>WARNING: Changing this setting on an existing stack requires manual intervention.
|
|
62
199
|
CloudFormation cannot automatically move resources between stacks. You may need
|
|
63
200
|
to delete and recreate resolvers, or perform a two-step deployment.</p>
|
|
64
|
-
</div
|
|
201
|
+
</div>
|
|
202
|
+
<div class="tsd-comment tsd-typography">
|
|
203
|
+
<div class="tsd-tag-default">
|
|
204
|
+
<h4 class="tsd-anchor-link" id="default-8">Default<a href="#default-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">false</span>
|
|
65
205
|
</code><button type="button">Copy</button></pre>
|
|
66
206
|
|
|
67
|
-
</div></div></section></section></details></div
|
|
207
|
+
</div></div></section></section></details></div>
|
|
208
|
+
<div class="col-sidebar">
|
|
209
|
+
<div class="page-menu">
|
|
210
|
+
<div class="tsd-navigation settings">
|
|
211
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
212
|
+
<h3>Settings</h3></summary>
|
|
213
|
+
<div class="tsd-accordion-details">
|
|
214
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
215
|
+
<ul id="tsd-filter-options">
|
|
216
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
217
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
218
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
219
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
220
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
221
|
+
<h3>On This Page</h3></summary>
|
|
222
|
+
<div class="tsd-accordion-details">
|
|
223
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
224
|
+
<div><a href="#additionalenv" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional<wbr/>Env</span></a><a href="#apihostname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a><a href="#apiname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>api<wbr/>Name</span></a><a href="#assetcdn" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Cdn</span></a><a href="#authentication" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authentication</span></a><a href="#definitionfilename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a><a href="#domainname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain<wbr/>Name</span></a><a href="#hostedzone" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a><a href="#lambdaoptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a><a href="#lambdatracing" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Tracing</span></a><a href="#monitoring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>monitoring</span></a><a href="#singletabledatastore" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>single<wbr/>Table<wbr/>Datastore</span></a><a href="#stagename" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stage<wbr/>Name</span></a><a href="#typederrors"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typed<wbr/>Errors</span></a><a href="#usenestedstacks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Nested<wbr/>Stacks</span></a></div></details></div></details></div>
|
|
225
|
+
<div class="site-menu">
|
|
226
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
227
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
228
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
229
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
230
|
+
<div class="overlay"></div></body></html>
|
|
@@ -1,3 +1,57 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ICognitoAuthentication | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ICognitoAuthentication | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">ICognitoAuthentication</a></li></ul>
|
|
12
|
+
<h1>Interface ICognitoAuthentication</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ICognitoAuthentication</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#userpool">userpool</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IUserPool</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
+
<section class="tsd-panel">
|
|
15
|
+
<h4>Implemented by</h4>
|
|
16
|
+
<ul class="tsd-hierarchy">
|
|
17
|
+
<li><a href="../classes/CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></li></ul></section>
|
|
18
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
19
|
+
<section class="tsd-panel tsd-index-panel">
|
|
20
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
21
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
22
|
+
<div class="tsd-accordion-details">
|
|
23
|
+
<section class="tsd-index-section">
|
|
24
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
25
|
+
<div class="tsd-index-list"><a href="#userpool" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>userpool</span></a>
|
|
26
|
+
</div></section></div></details></section></section>
|
|
27
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
28
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
29
|
+
<section>
|
|
30
|
+
<section class="tsd-panel tsd-member">
|
|
31
|
+
<h3 class="tsd-anchor-link" id="userpool"><code class="tsd-tag">Readonly</code><span>userpool</span><a href="#userpool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
32
|
+
<div class="tsd-signature"><span class="tsd-kind-property">userpool</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IUserPool</span></div>
|
|
33
|
+
<div class="tsd-comment tsd-typography"><p>The Cognito user pool that holds user information</p>
|
|
34
|
+
</div></section></section></details></div>
|
|
35
|
+
<div class="col-sidebar">
|
|
36
|
+
<div class="page-menu">
|
|
37
|
+
<div class="tsd-navigation settings">
|
|
38
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
39
|
+
<h3>Settings</h3></summary>
|
|
40
|
+
<div class="tsd-accordion-details">
|
|
41
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
42
|
+
<ul id="tsd-filter-options">
|
|
43
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
44
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
45
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
46
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
47
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
48
|
+
<h3>On This Page</h3></summary>
|
|
49
|
+
<div class="tsd-accordion-details">
|
|
50
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
51
|
+
<div><a href="#userpool"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>userpool</span></a></div></details></div></details></div>
|
|
52
|
+
<div class="site-menu">
|
|
53
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
54
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
55
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
56
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
57
|
+
<div class="overlay"></div></body></html>
|