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,24 @@
|
|
|
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>LambdaFunctionProps | 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>LambdaFunctionProps | 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">LambdaFunctionProps</a></li></ul>
|
|
12
|
+
<h1>Interface LambdaFunctionProps</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LambdaFunctionProps</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="#assetbucket">assetBucket</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Bucket</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#assetdomainname">assetDomainName</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="#description">description</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="#entry">entry</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="#handler">handler</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="#includesdk">includeSDK</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="#jwt">jwt</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><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="#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="#table">table</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ITable</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tablewrites">tableWrites</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="#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-group tsd-index-group">
|
|
15
|
+
<section class="tsd-panel tsd-index-panel">
|
|
16
|
+
<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>
|
|
17
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
18
|
+
<div class="tsd-accordion-details">
|
|
19
|
+
<section class="tsd-index-section">
|
|
20
|
+
<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>
|
|
21
|
+
<div class="tsd-index-list"><a href="#additionalenv" 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>additional<wbr/>Env?</span></a>
|
|
2
22
|
<a href="#assetbucket" 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>asset<wbr/>Bucket?</span></a>
|
|
3
23
|
<a href="#assetdomainname" 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>asset<wbr/>Domain<wbr/>Name?</span></a>
|
|
4
24
|
<a href="#description" 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>description?</span></a>
|
|
@@ -12,29 +32,117 @@
|
|
|
12
32
|
<a href="#table" 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>table?</span></a>
|
|
13
33
|
<a href="#tablewrites" 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>table<wbr/>Writes?</span></a>
|
|
14
34
|
<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>user<wbr/>Pool?</span></a>
|
|
15
|
-
</div></section></div></details></section></section
|
|
16
|
-
|
|
35
|
+
</div></section></div></details></section></section>
|
|
36
|
+
<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>
|
|
37
|
+
<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>
|
|
38
|
+
<section>
|
|
39
|
+
<section class="tsd-panel tsd-member">
|
|
40
|
+
<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>
|
|
41
|
+
<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>
|
|
42
|
+
<div class="tsd-comment tsd-typography"><p>additional environment variables of the Lambda function</p>
|
|
43
|
+
</div></section>
|
|
44
|
+
<section class="tsd-panel tsd-member">
|
|
45
|
+
<h3 class="tsd-anchor-link" id="assetbucket"><code class="tsd-tag">Optional</code><span>asset<wbr/>Bucket</span><a href="#assetbucket" 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>
|
|
46
|
+
<div class="tsd-signature"><span class="tsd-kind-property">assetBucket</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Bucket</span></div>
|
|
47
|
+
<div class="tsd-comment tsd-typography"><p>Bucket that is used for assets and published using the asset CDN
|
|
17
48
|
The name of the bucket is available as process.env.ASSET_BUCKET</p>
|
|
18
|
-
</div></section
|
|
49
|
+
</div></section>
|
|
50
|
+
<section class="tsd-panel tsd-member">
|
|
51
|
+
<h3 class="tsd-anchor-link" id="assetdomainname"><code class="tsd-tag">Optional</code><span>asset<wbr/>Domain<wbr/>Name</span><a href="#assetdomainname" 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>
|
|
52
|
+
<div class="tsd-signature"><span class="tsd-kind-property">assetDomainName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
53
|
+
<div class="tsd-comment tsd-typography"><p>Fully qualified domain name of the asset CDN
|
|
19
54
|
It is available as process.env.ASSET_DOMAIN_NAME</p>
|
|
20
|
-
</div></section
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
55
|
+
</div></section>
|
|
56
|
+
<section class="tsd-panel tsd-member">
|
|
57
|
+
<h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code><span>description</span><a href="#description" 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>
|
|
58
|
+
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
59
|
+
<div class="tsd-comment tsd-typography"><p>description of the Lambda function</p>
|
|
60
|
+
</div></section>
|
|
61
|
+
<section class="tsd-panel tsd-member">
|
|
62
|
+
<h3 class="tsd-anchor-link" id="entry"><span>entry</span><a href="#entry" 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>
|
|
63
|
+
<div class="tsd-signature"><span class="tsd-kind-property">entry</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
64
|
+
<div class="tsd-comment tsd-typography"><p>entry file name</p>
|
|
65
|
+
</div></section>
|
|
66
|
+
<section class="tsd-panel tsd-member">
|
|
67
|
+
<h3 class="tsd-anchor-link" id="handler"><code class="tsd-tag">Optional</code><span>handler</span><a href="#handler" 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>
|
|
68
|
+
<div class="tsd-signature"><span class="tsd-kind-property">handler</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
69
|
+
<div class="tsd-comment tsd-typography"><p>name of the exported handler function</p>
|
|
70
|
+
</div>
|
|
71
|
+
<div class="tsd-comment tsd-typography">
|
|
72
|
+
<div class="tsd-tag-default">
|
|
73
|
+
<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">handler</span>
|
|
24
74
|
</code><button type="button">Copy</button></pre>
|
|
25
75
|
|
|
26
|
-
</div></div></section
|
|
27
|
-
|
|
76
|
+
</div></div></section>
|
|
77
|
+
<section class="tsd-panel tsd-member">
|
|
78
|
+
<h3 class="tsd-anchor-link" id="includesdk"><code class="tsd-tag">Optional</code><span>include<wbr/>SDK</span><a href="#includesdk" 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>
|
|
79
|
+
<div class="tsd-signature"><span class="tsd-kind-property">includeSDK</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
80
|
+
<div class="tsd-comment tsd-typography"><p>Should the AWS-SDK be packaged with the Lambda code or excluded</p>
|
|
81
|
+
</div>
|
|
82
|
+
<div class="tsd-comment tsd-typography">
|
|
83
|
+
<div class="tsd-tag-default">
|
|
84
|
+
<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-5">false</span><span class="hl-1"> (</span><span class="hl-4">exclude</span><span class="hl-1"> </span><span class="hl-7">SDK</span><span class="hl-1"> </span><span class="hl-4">and</span><span class="hl-1"> </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">runtime</span><span class="hl-1"> </span><span class="hl-4">provided</span><span class="hl-1"> </span><span class="hl-4">one</span><span class="hl-1">)</span>
|
|
28
85
|
</code><button type="button">Copy</button></pre>
|
|
29
86
|
|
|
30
|
-
</div></div></section
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
87
|
+
</div></div></section>
|
|
88
|
+
<section class="tsd-panel tsd-member">
|
|
89
|
+
<h3 class="tsd-anchor-link" id="jwt"><code class="tsd-tag">Optional</code><span>jwt</span><a href="#jwt" 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>
|
|
90
|
+
<div class="tsd-signature"><span class="tsd-kind-property">jwt</span><span class="tsd-signature-symbol">?:</span> <a href="IJwtAuthentication.html" class="tsd-signature-type tsd-kind-interface">IJwtAuthentication</a></div>
|
|
91
|
+
<div class="tsd-comment tsd-typography"><p>JwtAuthentication settings</p>
|
|
92
|
+
</div></section>
|
|
93
|
+
<section class="tsd-panel tsd-member">
|
|
94
|
+
<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>
|
|
95
|
+
<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>
|
|
96
|
+
<div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct</p>
|
|
97
|
+
</div></section>
|
|
98
|
+
<section class="tsd-panel tsd-member">
|
|
99
|
+
<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>
|
|
100
|
+
<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>
|
|
101
|
+
<div class="tsd-comment tsd-typography"><p>Tracing config</p>
|
|
102
|
+
</div></section>
|
|
103
|
+
<section class="tsd-panel tsd-member">
|
|
104
|
+
<h3 class="tsd-anchor-link" id="stagename"><code class="tsd-tag">Optional</code><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>
|
|
105
|
+
<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>
|
|
106
|
+
<div class="tsd-comment tsd-typography"><p>Deployment stage (e.g. dev)</p>
|
|
107
|
+
</div></section>
|
|
108
|
+
<section class="tsd-panel tsd-member">
|
|
109
|
+
<h3 class="tsd-anchor-link" id="table"><code class="tsd-tag">Optional</code><span>table</span><a href="#table" 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>
|
|
110
|
+
<div class="tsd-signature"><span class="tsd-kind-property">table</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ITable</span></div>
|
|
111
|
+
<div class="tsd-comment tsd-typography"><p>DynamoDB that is used as datastore
|
|
35
112
|
The Lambda function will have read access to this table automatically
|
|
36
113
|
The name of the table is available as process.env.TABLE</p>
|
|
37
|
-
</div></section
|
|
38
|
-
|
|
114
|
+
</div></section>
|
|
115
|
+
<section class="tsd-panel tsd-member">
|
|
116
|
+
<h3 class="tsd-anchor-link" id="tablewrites"><code class="tsd-tag">Optional</code><span>table<wbr/>Writes</span><a href="#tablewrites" 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>
|
|
117
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tableWrites</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
118
|
+
<div class="tsd-comment tsd-typography"><p>Activate write permissions to the DynamoDB table</p>
|
|
119
|
+
</div></section>
|
|
120
|
+
<section class="tsd-panel tsd-member">
|
|
121
|
+
<h3 class="tsd-anchor-link" id="userpool"><code class="tsd-tag">Optional</code><span>user<wbr/>Pool</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>
|
|
122
|
+
<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>
|
|
123
|
+
<div class="tsd-comment tsd-typography"><p>Cognito user pool
|
|
39
124
|
The name of the pool is available as process.env.USER_POOL_ID</p>
|
|
40
|
-
</div></section></section></details></div
|
|
125
|
+
</div></section></section></details></div>
|
|
126
|
+
<div class="col-sidebar">
|
|
127
|
+
<div class="page-menu">
|
|
128
|
+
<div class="tsd-navigation settings">
|
|
129
|
+
<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>
|
|
130
|
+
<h3>Settings</h3></summary>
|
|
131
|
+
<div class="tsd-accordion-details">
|
|
132
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
133
|
+
<ul id="tsd-filter-options">
|
|
134
|
+
<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>
|
|
135
|
+
<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>
|
|
136
|
+
<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>
|
|
137
|
+
<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>
|
|
138
|
+
<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>
|
|
139
|
+
<h3>On This Page</h3></summary>
|
|
140
|
+
<div class="tsd-accordion-details">
|
|
141
|
+
<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>
|
|
142
|
+
<div><a href="#additionalenv"><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="#assetbucket"><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/>Bucket</span></a><a href="#assetdomainname"><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/>Domain<wbr/>Name</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#entry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entry</span></a><a href="#handler"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handler</span></a><a href="#includesdk"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>SDK</span></a><a href="#jwt"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jwt</span></a><a href="#lambdaoptions"><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"><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="#stagename"><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="#table"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table</span></a><a href="#tablewrites"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>table<wbr/>Writes</span></a><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>user<wbr/>Pool</span></a></div></details></div></details></div>
|
|
143
|
+
<div class="site-menu">
|
|
144
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
145
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
146
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
147
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
148
|
+
<div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,59 @@
|
|
|
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>LambdaTracingOptions | 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>LambdaTracingOptions | 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">LambdaTracingOptions</a></li></ul>
|
|
12
|
+
<h1>Interface LambdaTracingOptions</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LambdaTracingOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#xraytracing">xRayTracing</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Tracing</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
14
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
15
|
+
<section class="tsd-panel tsd-index-panel">
|
|
16
|
+
<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>
|
|
17
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
18
|
+
<div class="tsd-accordion-details">
|
|
19
|
+
<section class="tsd-index-section">
|
|
20
|
+
<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>
|
|
21
|
+
<div class="tsd-index-list"><a href="#xraytracing" 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>x<wbr/>Ray<wbr/>Tracing?</span></a>
|
|
22
|
+
</div></section></div></details></section></section>
|
|
23
|
+
<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>
|
|
24
|
+
<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>
|
|
25
|
+
<section>
|
|
26
|
+
<section class="tsd-panel tsd-member">
|
|
27
|
+
<h3 class="tsd-anchor-link" id="xraytracing"><code class="tsd-tag">Optional</code><span>x<wbr/>Ray<wbr/>Tracing</span><a href="#xraytracing" 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>
|
|
28
|
+
<div class="tsd-signature"><span class="tsd-kind-property">xRayTracing</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Tracing</span></div>
|
|
29
|
+
<div class="tsd-comment tsd-typography"><p>Activate tracing with X-Ray</p>
|
|
30
|
+
</div>
|
|
31
|
+
<div class="tsd-comment tsd-typography">
|
|
32
|
+
<div class="tsd-tag-default">
|
|
33
|
+
<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">lambda</span><span class="hl-1">.</span><span class="hl-4">Tracing</span><span class="hl-1">.</span><span class="hl-7">DISABLED</span>
|
|
4
34
|
</code><button type="button">Copy</button></pre>
|
|
5
35
|
|
|
6
|
-
</div></div></section></section></details></div
|
|
36
|
+
</div></div></section></section></details></div>
|
|
37
|
+
<div class="col-sidebar">
|
|
38
|
+
<div class="page-menu">
|
|
39
|
+
<div class="tsd-navigation settings">
|
|
40
|
+
<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>
|
|
41
|
+
<h3>Settings</h3></summary>
|
|
42
|
+
<div class="tsd-accordion-details">
|
|
43
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
44
|
+
<ul id="tsd-filter-options">
|
|
45
|
+
<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>
|
|
46
|
+
<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>
|
|
47
|
+
<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>
|
|
48
|
+
<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>
|
|
49
|
+
<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>
|
|
50
|
+
<h3>On This Page</h3></summary>
|
|
51
|
+
<div class="tsd-accordion-details">
|
|
52
|
+
<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>
|
|
53
|
+
<div><a href="#xraytracing"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x<wbr/>Ray<wbr/>Tracing</span></a></div></details></div></details></div>
|
|
54
|
+
<div class="site-menu">
|
|
55
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
56
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
57
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
58
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
59
|
+
<div class="overlay"></div></body></html>
|
|
@@ -1,17 +1,84 @@
|
|
|
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>McpAuthCognitoOptions | 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>McpAuthCognitoOptions | 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">McpAuthCognitoOptions</a></li></ul>
|
|
12
|
+
<h1>Interface McpAuthCognitoOptions</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Cognito-specific MCP auth configuration.
|
|
2
15
|
Creates a dedicated user pool client for MCP connectors automatically.</p>
|
|
3
|
-
</div></section
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">McpAuthCognitoOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#additionalcallbackurls">additionalCallbackUrls</a><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="#auth">auth</a><span class="tsd-signature-symbol">:</span> <a href="../classes/CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authdomain">authDomain</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="#clientconstructid">clientConstructId</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
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="#additionalcallbackurls" 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>additional<wbr/>Callback<wbr/>Urls?</span></a>
|
|
4
26
|
<a href="#auth" 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>auth</span></a>
|
|
5
27
|
<a href="#authdomain" 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>auth<wbr/>Domain</span></a>
|
|
6
28
|
<a href="#clientconstructid" 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>client<wbr/>Construct<wbr/>Id?</span></a>
|
|
7
|
-
</div></section></div></details></section></section
|
|
8
|
-
|
|
29
|
+
</div></section></div></details></section></section>
|
|
30
|
+
<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>
|
|
31
|
+
<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>
|
|
32
|
+
<section>
|
|
33
|
+
<section class="tsd-panel tsd-member">
|
|
34
|
+
<h3 class="tsd-anchor-link" id="additionalcallbackurls"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>additional<wbr/>Callback<wbr/>Urls</span><a href="#additionalcallbackurls" 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>
|
|
35
|
+
<div class="tsd-signature"><span class="tsd-kind-property">additionalCallbackUrls</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
36
|
+
<div class="tsd-comment tsd-typography"><p>Additional OAuth callback URLs for the Cognito client beyond the allowedRedirectUris.</p>
|
|
37
|
+
</div></section>
|
|
38
|
+
<section class="tsd-panel tsd-member">
|
|
39
|
+
<h3 class="tsd-anchor-link" id="auth"><code class="tsd-tag">Readonly</code><span>auth</span><a href="#auth" 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>
|
|
40
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auth</span><span class="tsd-signature-symbol">:</span> <a href="../classes/CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></div>
|
|
41
|
+
<div class="tsd-comment tsd-typography"><p>The CognitoAuthentication construct managing the user pool.
|
|
9
42
|
A dedicated client with auth code + PKCE will be created.</p>
|
|
10
|
-
</div></section
|
|
43
|
+
</div></section>
|
|
44
|
+
<section class="tsd-panel tsd-member">
|
|
45
|
+
<h3 class="tsd-anchor-link" id="authdomain"><code class="tsd-tag">Readonly</code><span>auth<wbr/>Domain</span><a href="#authdomain" 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>
|
|
46
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authDomain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
47
|
+
<div class="tsd-comment tsd-typography"><p>The Cognito auth domain (custom or Cognito-hosted).
|
|
11
48
|
Required — never inferred from apiDomain.
|
|
12
49
|
Example: '<a href="http://auth.example.com">auth.example.com</a>'</p>
|
|
13
|
-
</div></section
|
|
14
|
-
|
|
50
|
+
</div></section>
|
|
51
|
+
<section class="tsd-panel tsd-member">
|
|
52
|
+
<h3 class="tsd-anchor-link" id="clientconstructid"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>client<wbr/>Construct<wbr/>Id</span><a href="#clientconstructid" 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>
|
|
53
|
+
<div class="tsd-signature"><span class="tsd-kind-property">clientConstructId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
54
|
+
<div class="tsd-comment tsd-typography"><p>Construct ID for the user pool client (affects CloudFormation logical ID).</p>
|
|
55
|
+
</div>
|
|
56
|
+
<div class="tsd-comment tsd-typography">
|
|
57
|
+
<div class="tsd-tag-default">
|
|
58
|
+
<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-2">'mcpConnector'</span>
|
|
15
59
|
</code><button type="button">Copy</button></pre>
|
|
16
60
|
|
|
17
|
-
</div></div></section></section></details></div
|
|
61
|
+
</div></div></section></section></details></div>
|
|
62
|
+
<div class="col-sidebar">
|
|
63
|
+
<div class="page-menu">
|
|
64
|
+
<div class="tsd-navigation settings">
|
|
65
|
+
<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>
|
|
66
|
+
<h3>Settings</h3></summary>
|
|
67
|
+
<div class="tsd-accordion-details">
|
|
68
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
69
|
+
<ul id="tsd-filter-options">
|
|
70
|
+
<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>
|
|
71
|
+
<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>
|
|
72
|
+
<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>
|
|
73
|
+
<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>
|
|
74
|
+
<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>
|
|
75
|
+
<h3>On This Page</h3></summary>
|
|
76
|
+
<div class="tsd-accordion-details">
|
|
77
|
+
<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>
|
|
78
|
+
<div><a href="#additionalcallbackurls"><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/>Callback<wbr/>Urls</span></a><a href="#auth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth</span></a><a href="#authdomain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth<wbr/>Domain</span></a><a href="#clientconstructid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Construct<wbr/>Id</span></a></div></details></div></details></div>
|
|
79
|
+
<div class="site-menu">
|
|
80
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
81
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
82
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
83
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
84
|
+
<div class="overlay"></div></body></html>
|