cdk-serverless 3.3.2 → 3.3.3

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.
Files changed (97) hide show
  1. package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-233633-review.md +98 -0
  2. package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-234937-review.md +86 -0
  3. package/.agents/tasks/task-dependency-cve-upgrade/context.json +24 -0
  4. package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-001.json +28 -0
  5. package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-002.json +33 -0
  6. package/.agents/tasks/task-dependency-cve-upgrade/task.json +7 -0
  7. package/docs/constructs/assets/hierarchy.js +1 -1
  8. package/docs/constructs/assets/highlight.css +1 -1
  9. package/docs/constructs/assets/main.js +1 -1
  10. package/docs/constructs/assets/style.css +18 -3
  11. package/docs/constructs/classes/AssetCdn.html +161 -20
  12. package/docs/constructs/classes/BaseApi.html +153 -13
  13. package/docs/constructs/classes/CognitoAuthentication.html +188 -22
  14. package/docs/constructs/classes/GraphQlApi.html +349 -23
  15. package/docs/constructs/classes/LambdaFunction.html +1074 -106
  16. package/docs/constructs/classes/McpAuth.html +152 -16
  17. package/docs/constructs/classes/McpCognitoAuth.html +152 -16
  18. package/docs/constructs/classes/RestApi.html +344 -37
  19. package/docs/constructs/classes/SingleTableDatastore.html +173 -19
  20. package/docs/constructs/classes/Workflow.html +170 -21
  21. package/docs/constructs/hierarchy.html +47 -1
  22. package/docs/constructs/index.html +75 -2
  23. package/docs/constructs/interfaces/AssetCdnProps.html +61 -5
  24. package/docs/constructs/interfaces/BaseApiProps.html +141 -20
  25. package/docs/constructs/interfaces/CognitoAuthenticationProps.html +135 -20
  26. package/docs/constructs/interfaces/GraphQlApiProps.html +164 -22
  27. package/docs/constructs/interfaces/ICognitoAuthentication.html +57 -3
  28. package/docs/constructs/interfaces/IJwtAuthentication.html +63 -5
  29. package/docs/constructs/interfaces/ISingleTableDatastore.html +57 -3
  30. package/docs/constructs/interfaces/JsResolverOptions.html +66 -6
  31. package/docs/constructs/interfaces/LambdaFunctionProps.html +126 -18
  32. package/docs/constructs/interfaces/LambdaTracingOptions.html +57 -4
  33. package/docs/constructs/interfaces/McpAuthCognitoOptions.html +75 -8
  34. package/docs/constructs/interfaces/McpAuthFunctions.html +76 -8
  35. package/docs/constructs/interfaces/McpAuthGenericOptions.html +66 -6
  36. package/docs/constructs/interfaces/McpAuthOptions.html +107 -15
  37. package/docs/constructs/interfaces/McpAuthProps.html +123 -18
  38. package/docs/constructs/interfaces/McpCognitoAuthProps.html +127 -19
  39. package/docs/constructs/interfaces/RestApiProps.html +237 -37
  40. package/docs/constructs/interfaces/SingleTableDatastoreProps.html +77 -9
  41. package/docs/constructs/interfaces/SingleTableDesign.html +72 -7
  42. package/docs/constructs/interfaces/VtlResolverOptions.html +62 -5
  43. package/docs/constructs/interfaces/WorkflowProps.html +63 -2
  44. package/docs/constructs/modules.html +44 -1
  45. package/docs/constructs/types/LambdaOptions.html +31 -1
  46. package/docs/lambda/assets/highlight.css +1 -1
  47. package/docs/lambda/assets/main.js +1 -1
  48. package/docs/lambda/assets/style.css +18 -3
  49. package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +248 -21
  50. package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +247 -20
  51. package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +248 -21
  52. package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +246 -20
  53. package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +242 -21
  54. package/docs/lambda/classes/auth.CognitoAuthorizer.html +235 -20
  55. package/docs/lambda/classes/auth.JwtAuthorizer.html +225 -20
  56. package/docs/lambda/classes/errors.BadRequestError.html +147 -11
  57. package/docs/lambda/classes/errors.ForbiddenError.html +147 -11
  58. package/docs/lambda/classes/errors.HttpError.html +154 -12
  59. package/docs/lambda/classes/errors.NotFoundError.html +147 -11
  60. package/docs/lambda/classes/errors.UnauthenticatedError.html +147 -11
  61. package/docs/lambda/functions/api.createAppSyncHandler.html +50 -3
  62. package/docs/lambda/functions/api.createHttpHandler.html +48 -2
  63. package/docs/lambda/functions/api.createOpenApiHandler.html +48 -2
  64. package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +48 -2
  65. package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +47 -2
  66. package/docs/lambda/hierarchy.html +52 -1
  67. package/docs/lambda/index.html +75 -2
  68. package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +68 -3
  69. package/docs/lambda/interfaces/api.HttpHandlerContext.html +67 -3
  70. package/docs/lambda/interfaces/api.HttpResponseContext.html +61 -3
  71. package/docs/lambda/interfaces/api.Operation.html +61 -3
  72. package/docs/lambda/interfaces/api.OperationWithRequestBody.html +65 -3
  73. package/docs/lambda/modules/api.html +45 -1
  74. package/docs/lambda/modules/auth.html +37 -1
  75. package/docs/lambda/modules/errors.html +37 -1
  76. package/docs/lambda/modules.html +36 -1
  77. package/docs/lambda/types/api.APIGatewayv1Handler.html +34 -2
  78. package/docs/lambda/types/api.AppSyncHandler.html +51 -2
  79. package/docs/lambda/types/api.HttpHandler.html +52 -2
  80. package/docs/projen/assets/highlight.css +5 -12
  81. package/docs/projen/assets/main.js +1 -1
  82. package/docs/projen/assets/style.css +18 -3
  83. package/docs/projen/classes/Datastore.html +254 -18
  84. package/docs/projen/classes/GraphQlApi.html +238 -18
  85. package/docs/projen/classes/RestApi.html +325 -40
  86. package/docs/projen/classes/ServerlessProject.html +1021 -159
  87. package/docs/projen/classes/Workflow.html +288 -31
  88. package/docs/projen/hierarchy.html +29 -1
  89. package/docs/projen/index.html +75 -2
  90. package/docs/projen/interfaces/DatastoreOptions.html +54 -2
  91. package/docs/projen/interfaces/GraphQlApiOptions.html +54 -2
  92. package/docs/projen/interfaces/RestApiOptions.html +54 -2
  93. package/docs/projen/interfaces/ServerlessProjectOptions.html +2089 -692
  94. package/docs/projen/interfaces/WorkflowOptions.html +54 -2
  95. package/docs/projen/modules.html +44 -1
  96. package/docs/projen/variables/PACKAGE_NAME.html +31 -1
  97. package/package.json +26 -24
package/docs/constructs/interfaces/RestApiProps.html CHANGED
@@ -1,4 +1,34 @@
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>RestApiProps | 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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">RestApiProps</a></li></ul><h1>Interface RestApiProps&lt;OPS&gt;</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RestApiProps</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#ops">OPS</a><span class="tsd-signature-symbol">&gt;</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="#anonymousoperations">anonymousOperations</a><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#ops">OPS</a>)<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="#authorizationscopes">authorizationScopes</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="#authorizationscopesbyoperation">authorizationScopesByOperation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#autogenerateroutes">autoGenerateRoutes</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="#cors">cors</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="#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="#jwtauthorizertype">jwtAuthorizerType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;token&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;request&quot;</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="#lambdaoptionsbyoperation">lambdaOptionsByOperation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a><br/>    <span class="tsd-signature-symbol">}</span><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="#mcpauth">mcpAuth</a><span class="tsd-signature-symbol">?:</span> <a href="McpAuthOptions.html" class="tsd-signature-type tsd-kind-interface">McpAuthOptions</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="#restapiprops">restApiProps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RestApiBaseProps</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/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="ops"><span class="tsd-kind-type-parameter">OPS</span></span></li></ul></section><section class="tsd-panel tsd-hierarchy" data-refl="601"><h4>Hierarchy (<a href="../hierarchy.html#RestApiProps">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BaseApiProps.html" class="tsd-signature-type tsd-kind-interface">BaseApiProps</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RestApiProps</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><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>
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>RestApiProps | 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">RestApiProps</a></li></ul>
12
+ <h1>Interface RestApiProps&lt;OPS&gt;</h1></div>
13
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RestApiProps</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#ops">OPS</a><span class="tsd-signature-symbol">&gt;</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="#anonymousoperations">anonymousOperations</a><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#ops">OPS</a>)<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="#authorizationscopes">authorizationScopes</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="#authorizationscopesbyoperation">authorizationScopesByOperation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#autogenerateroutes">autoGenerateRoutes</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="#cors">cors</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="#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="#jwtauthorizertype">jwtAuthorizerType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;token&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;request&quot;</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="#lambdaoptionsbyoperation">lambdaOptionsByOperation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a><br/>    <span class="tsd-signature-symbol">}</span><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="#mcpauth">mcpAuth</a><span class="tsd-signature-symbol">?:</span> <a href="McpAuthOptions.html" class="tsd-signature-type tsd-kind-interface">McpAuthOptions</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="#restapiprops">restApiProps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RestApiBaseProps</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/><span class="tsd-signature-symbol">}</span></div>
14
+ <section class="tsd-panel">
15
+ <h4>Type Parameters</h4>
16
+ <ul class="tsd-type-parameter-list">
17
+ <li><span id="ops"><span class="tsd-kind-type-parameter">OPS</span></span></li></ul></section>
18
+ <section class="tsd-panel tsd-hierarchy" data-refl="604">
19
+ <h4>Hierarchy (<a href="../hierarchy.html#RestApiProps">View Summary</a>)</h4>
20
+ <ul class="tsd-hierarchy">
21
+ <li class="tsd-hierarchy-item"><a href="BaseApiProps.html" class="tsd-signature-type tsd-kind-interface">BaseApiProps</a>
22
+ <ul class="tsd-hierarchy">
23
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RestApiProps</span></li></ul></li></ul></section>
24
+ <section class="tsd-panel-group tsd-index-group">
25
+ <section class="tsd-panel tsd-index-panel">
26
+ <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>
27
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
28
+ <div class="tsd-accordion-details">
29
+ <section class="tsd-index-section">
30
+ <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>
31
+ <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
32
  <a href="#anonymousoperations" 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>anonymous<wbr/>Operations?</span></a>
3
33
  <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>
4
34
  <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>
@@ -20,63 +50,156 @@
20
50
  <a href="#restapiprops" 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>rest<wbr/>Api<wbr/>Props?</span></a>
21
51
  <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>
22
52
  <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>
23
- </div></section></div></details></section></section><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Additional environment variables of all Lambda functions</p>
24
- </div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#additionalenv">additionalEnv</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="anonymousoperations"><code class="tsd-tag">Optional</code><span>anonymous<wbr/>Operations</span><a href="#anonymousoperations" 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><div class="tsd-signature"><span class="tsd-kind-property">anonymousOperations</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#ops">OPS</a>)<span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of operation IDs that should skip the authorizer entirely.
53
+ </div></section></div></details></section></section>
54
+ <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>
55
+ <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>
56
+ <section>
57
+ <section class="tsd-panel tsd-member tsd-is-inherited">
58
+ <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>
59
+ <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>
60
+ <div class="tsd-comment tsd-typography"><p>Additional environment variables of all Lambda functions</p>
61
+ </div><aside class="tsd-sources">
62
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#additionalenv">additionalEnv</a></p></aside></section>
63
+ <section class="tsd-panel tsd-member">
64
+ <h3 class="tsd-anchor-link" id="anonymousoperations"><code class="tsd-tag">Optional</code><span>anonymous<wbr/>Operations</span><a href="#anonymousoperations" 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>
65
+ <div class="tsd-signature"><span class="tsd-kind-property">anonymousOperations</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#ops">OPS</a>)<span class="tsd-signature-symbol">[]</span></div>
66
+ <div class="tsd-comment tsd-typography"><p>A list of operation IDs that should skip the authorizer entirely.
25
67
  These operations will have <code>security: []</code> in the OpenAPI spec, meaning
26
68
  they are publicly accessible without authentication.</p>
27
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">anonymous</span><span class="hl-1"> </span><span class="hl-4">operations</span>
69
+ </div>
70
+ <div class="tsd-comment tsd-typography">
71
+ <div class="tsd-tag-default">
72
+ <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-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">anonymous</span><span class="hl-1"> </span><span class="hl-4">operations</span>
28
73
  </code><button type="button">Copy</button></pre>
29
74
 
30
- </div></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
31
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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">api</span>
75
+ </div></div></section>
76
+ <section class="tsd-panel tsd-member tsd-is-inherited">
77
+ <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>
78
+ <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>
79
+ <div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
80
+ </div>
81
+ <div class="tsd-comment tsd-typography">
82
+ <div class="tsd-tag-default">
83
+ <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">api</span>
32
84
  </code><button type="button">Copy</button></pre>
33
85
 
34
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apihostname">apiHostname</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Name of the API</p>
35
- </div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apiname">apiName</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Configure a content delivery network for static assets</p>
36
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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>
86
+ </div></div><aside class="tsd-sources">
87
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apihostname">apiHostname</a></p></aside></section>
88
+ <section class="tsd-panel tsd-member tsd-is-inherited">
89
+ <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>
90
+ <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>
91
+ <div class="tsd-comment tsd-typography"><p>Name of the API</p>
92
+ </div><aside class="tsd-sources">
93
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apiname">apiName</a></p></aside></section>
94
+ <section class="tsd-panel tsd-member tsd-is-inherited">
95
+ <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>
96
+ <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>
97
+ <div class="tsd-comment tsd-typography"><p>Configure a content delivery network for static assets</p>
98
+ </div>
99
+ <div class="tsd-comment tsd-typography">
100
+ <div class="tsd-tag-default">
101
+ <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>
37
102
  </code><button type="button">Copy</button></pre>
38
103
 
39
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#assetcdn">assetCdn</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Use a Cognito user pool for authorization.
104
+ </div></div><aside class="tsd-sources">
105
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#assetcdn">assetCdn</a></p></aside></section>
106
+ <section class="tsd-panel tsd-member tsd-is-inherited">
107
+ <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>
108
+ <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>
109
+ <div class="tsd-comment tsd-typography"><p>Use a Cognito user pool for authorization.
40
110
  Alternatively supply a JWT issuer and audience
41
111
  to use any other JWT-based authorization service.</p>
42
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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-4">none</span>
112
+ </div>
113
+ <div class="tsd-comment tsd-typography">
114
+ <div class="tsd-tag-default">
115
+ <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-4">none</span>
43
116
  </code><button type="button">Copy</button></pre>
44
117
 
45
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#authentication">authentication</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="authorizationscopes"><code class="tsd-tag">Optional</code><span>authorization<wbr/>Scopes</span><a href="#authorizationscopes" 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><div class="tsd-signature"><span class="tsd-kind-property">authorizationScopes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Global OAuth2 scopes required by the Cognito authorizer.</p>
118
+ </div></div><aside class="tsd-sources">
119
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#authentication">authentication</a></p></aside></section>
120
+ <section class="tsd-panel tsd-member">
121
+ <h3 class="tsd-anchor-link" id="authorizationscopes"><code class="tsd-tag">Optional</code><span>authorization<wbr/>Scopes</span><a href="#authorizationscopes" 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">authorizationScopes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
123
+ <div class="tsd-comment tsd-typography"><p>Global OAuth2 scopes required by the Cognito authorizer.</p>
46
124
  <p>When scopes are present, API Gateway validates the <strong>access token</strong> and checks
47
125
  that it contains at least one of the specified scopes. An empty array means no
48
126
  scopes are required; API Gateway then validates the <strong>ID token</strong> instead,
49
127
  rejecting access tokens with a 401.</p>
50
128
  <p>Use per-operation overrides via <code>authorizationScopesByOperation</code> to set
51
129
  different scopes on individual operations.</p>
52
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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-2">&#39;openid&#39;</span><span class="hl-1">]</span>
130
+ </div>
131
+ <div class="tsd-comment tsd-typography">
132
+ <div class="tsd-tag-default">
133
+ <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-2">&#39;openid&#39;</span><span class="hl-1">]</span>
53
134
  </code><button type="button">Copy</button></pre>
54
135
 
55
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="authorizationscopesbyoperation"><code class="tsd-tag">Optional</code><span>authorization<wbr/>Scopes<wbr/>By<wbr/>Operation</span><a href="#authorizationscopesbyoperation" 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><div class="tsd-signature"><span class="tsd-kind-property">authorizationScopesByOperation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Per-operation OAuth2 scope overrides for the Cognito authorizer.</p>
136
+ </div></div></section>
137
+ <section class="tsd-panel tsd-member">
138
+ <h3 class="tsd-anchor-link" id="authorizationscopesbyoperation"><code class="tsd-tag">Optional</code><span>authorization<wbr/>Scopes<wbr/>By<wbr/>Operation</span><a href="#authorizationscopesbyoperation" 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">authorizationScopesByOperation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span class="tsd-signature-symbol">}</span></div>
140
+ <div class="tsd-comment tsd-typography"><p>Per-operation OAuth2 scope overrides for the Cognito authorizer.</p>
56
141
  <p>Operations listed here use the specified scopes instead of the global
57
142
  <code>authorizationScopes</code> default. Operations not listed fall back to the
58
143
  global default.</p>
59
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" 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-10">authorizationScopesByOperation</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-10">createItem</span><span class="hl-1">: [</span><span class="hl-2">&#39;openid&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;items:write&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-10">deleteItem</span><span class="hl-1">: [</span><span class="hl-2">&#39;openid&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;items:delete&#39;</span><span class="hl-1">],</span><br/><span class="hl-1">}</span>
144
+ </div>
145
+ <div class="tsd-comment tsd-typography">
146
+ <div class="tsd-tag-example">
147
+ <h4 class="tsd-anchor-link" id="example">Example<a href="#example" 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-10">authorizationScopesByOperation</span><span class="hl-1">: {</span><br/><span class="hl-1"> </span><span class="hl-10">createItem</span><span class="hl-1">: [</span><span class="hl-2">&#39;openid&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;items:write&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-10">deleteItem</span><span class="hl-1">: [</span><span class="hl-2">&#39;openid&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;items:delete&#39;</span><span class="hl-1">],</span><br/><span class="hl-1">}</span>
60
148
  </code><button type="button">Copy</button></pre>
61
149
 
62
- </div><div class="tsd-tag-default"><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-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">per</span><span class="hl-1">-</span><span class="hl-4">operation</span><span class="hl-1"> </span><span class="hl-4">overrides</span><span class="hl-1">; </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">operations</span><span class="hl-1"> </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">authorizationScopes</span>
150
+ </div>
151
+ <div class="tsd-tag-default">
152
+ <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-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">per</span><span class="hl-1">-</span><span class="hl-4">operation</span><span class="hl-1"> </span><span class="hl-4">overrides</span><span class="hl-1">; </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">operations</span><span class="hl-1"> </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">authorizationScopes</span>
63
153
  </code><button type="button">Copy</button></pre>
64
154
 
65
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="autogenerateroutes"><code class="tsd-tag">Optional</code><span>auto<wbr/>Generate<wbr/>Routes</span><a href="#autogenerateroutes" 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><div class="tsd-signature"><span class="tsd-kind-property">autoGenerateRoutes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate routes for all endpoints configured in the openapi.yaml file</p>
66
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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-5">true</span>
155
+ </div></div></section>
156
+ <section class="tsd-panel tsd-member">
157
+ <h3 class="tsd-anchor-link" id="autogenerateroutes"><code class="tsd-tag">Optional</code><span>auto<wbr/>Generate<wbr/>Routes</span><a href="#autogenerateroutes" 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>
158
+ <div class="tsd-signature"><span class="tsd-kind-property">autoGenerateRoutes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
159
+ <div class="tsd-comment tsd-typography"><p>Generate routes for all endpoints configured in the openapi.yaml file</p>
160
+ </div>
161
+ <div class="tsd-comment tsd-typography">
162
+ <div class="tsd-tag-default">
163
+ <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-5">true</span>
67
164
  </code><button type="button">Copy</button></pre>
68
165
 
69
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cors"><span>cors</span><a href="#cors" 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><div class="tsd-signature"><span class="tsd-kind-property">cors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div></section><section class="tsd-panel tsd-member"><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><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><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. <a href="http://example.com">example.com</a>)</p>
166
+ </div></div></section>
167
+ <section class="tsd-panel tsd-member">
168
+ <h3 class="tsd-anchor-link" id="cors"><span>cors</span><a href="#cors" 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>
169
+ <div class="tsd-signature"><span class="tsd-kind-property">cors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div></section>
170
+ <section class="tsd-panel tsd-member">
171
+ <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>
172
+ <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>
173
+ <section class="tsd-panel tsd-member tsd-is-inherited">
174
+ <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>
175
+ <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>
176
+ <div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. <a href="http://example.com">example.com</a>)</p>
70
177
  <p>only one of hostedZone and domainName can be specified</p>
71
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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-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>
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-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>
72
182
  </code><button type="button">Copy</button></pre>
73
183
 
74
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#domainname">domainName</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. <a href="http://example.com">example.com</a>)</p>
184
+ </div></div><aside class="tsd-sources">
185
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#domainname">domainName</a></p></aside></section>
186
+ <section class="tsd-panel tsd-member tsd-is-inherited">
187
+ <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>
188
+ <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>
189
+ <div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. <a href="http://example.com">example.com</a>)</p>
75
190
  <p>only one of hostedZone and domainName can be specified</p>
76
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><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-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>
191
+ </div>
192
+ <div class="tsd-comment tsd-typography">
193
+ <div class="tsd-tag-default">
194
+ <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-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>
77
195
  </code><button type="button">Copy</button></pre>
78
196
 
79
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#hostedzone">hostedZone</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="jwtauthorizertype"><code class="tsd-tag">Optional</code><span>jwt<wbr/>Authorizer<wbr/>Type</span><a href="#jwtauthorizertype" 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><div class="tsd-signature"><span class="tsd-kind-property">jwtAuthorizerType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;token&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;request&quot;</span></div><div class="tsd-comment tsd-typography"><p>Controls whether the JWT Lambda authorizer uses the TOKEN or REQUEST type.</p>
197
+ </div></div><aside class="tsd-sources">
198
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#hostedzone">hostedZone</a></p></aside></section>
199
+ <section class="tsd-panel tsd-member">
200
+ <h3 class="tsd-anchor-link" id="jwtauthorizertype"><code class="tsd-tag">Optional</code><span>jwt<wbr/>Authorizer<wbr/>Type</span><a href="#jwtauthorizertype" 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>
201
+ <div class="tsd-signature"><span class="tsd-kind-property">jwtAuthorizerType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;token&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;request&quot;</span></div>
202
+ <div class="tsd-comment tsd-typography"><p>Controls whether the JWT Lambda authorizer uses the TOKEN or REQUEST type.</p>
80
203
  <p><strong>token (default):</strong> The API Gateway validates that the Authorization header is present
81
204
  before invoking the Lambda authorizer. If the header is missing, API Gateway immediately
82
205
  returns 401 without invoking the Lambda. This is cheaper for unauthenticated requests
@@ -90,16 +213,40 @@ is that you pay for a Lambda invocation on every request, including unauthentica
90
213
  <p>Use 'request' when you need endpoints that behave differently for authenticated vs
91
214
  anonymous users (e.g., personalized responses for logged-in users, generic responses
92
215
  for guests) without splitting them into separate operations.</p>
93
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-9">Default<a href="#default-9" 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">&#39;token&#39;</span>
216
+ </div>
217
+ <div class="tsd-comment tsd-typography">
218
+ <div class="tsd-tag-default">
219
+ <h4 class="tsd-anchor-link" id="default-9">Default<a href="#default-9" 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">&#39;token&#39;</span>
94
220
  </code><button type="button">Copy</button></pre>
95
221
 
96
- </div></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct</p>
97
- </div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#lambdaoptions">lambdaOptions</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lambdaoptionsbyoperation"><code class="tsd-tag">Optional</code><span>lambda<wbr/>Options<wbr/>By<wbr/>Operation</span><a href="#lambdaoptionsbyoperation" 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><div class="tsd-signature"><span class="tsd-kind-property">lambdaOptionsByOperation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct per operationId</p>
98
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-10">Default<a href="#default-10" 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>
222
+ </div></div></section>
223
+ <section class="tsd-panel tsd-member tsd-is-inherited">
224
+ <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>
225
+ <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>
226
+ <div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct</p>
227
+ </div><aside class="tsd-sources">
228
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#lambdaoptions">lambdaOptions</a></p></aside></section>
229
+ <section class="tsd-panel tsd-member">
230
+ <h3 class="tsd-anchor-link" id="lambdaoptionsbyoperation"><code class="tsd-tag">Optional</code><span>lambda<wbr/>Options<wbr/>By<wbr/>Operation</span><a href="#lambdaoptionsbyoperation" 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>
231
+ <div class="tsd-signature"><span class="tsd-kind-property">lambdaOptionsByOperation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">operationId</span> <span class="tsd-signature-keyword">in</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a><br/><span class="tsd-signature-symbol">}</span></div>
232
+ <div class="tsd-comment tsd-typography"><p>additional options for the underlying Lambda function construct per operationId</p>
233
+ </div>
234
+ <div class="tsd-comment tsd-typography">
235
+ <div class="tsd-tag-default">
236
+ <h4 class="tsd-anchor-link" id="default-10">Default<a href="#default-10" 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>
99
237
  </code><button type="button">Copy</button></pre>
100
238
 
101
- </div></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Tracing config for the generated Lambda functions</p>
102
- </div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#lambdatracing">lambdaTracing</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mcpauth"><code class="tsd-tag">Optional</code><span>mcp<wbr/>Auth</span><a href="#mcpauth" 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><div class="tsd-signature"><span class="tsd-kind-property">mcpAuth</span><span class="tsd-signature-symbol">?:</span> <a href="McpAuthOptions.html" class="tsd-signature-type tsd-kind-interface">McpAuthOptions</a></div><div class="tsd-comment tsd-typography"><p>MCP Auth configuration to wire into this API.
239
+ </div></div></section>
240
+ <section class="tsd-panel tsd-member tsd-is-inherited">
241
+ <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>
242
+ <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>
243
+ <div class="tsd-comment tsd-typography"><p>Tracing config for the generated Lambda functions</p>
244
+ </div><aside class="tsd-sources">
245
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#lambdatracing">lambdaTracing</a></p></aside></section>
246
+ <section class="tsd-panel tsd-member">
247
+ <h3 class="tsd-anchor-link" id="mcpauth"><code class="tsd-tag">Optional</code><span>mcp<wbr/>Auth</span><a href="#mcpauth" 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>
248
+ <div class="tsd-signature"><span class="tsd-kind-property">mcpAuth</span><span class="tsd-signature-symbol">?:</span> <a href="McpAuthOptions.html" class="tsd-signature-type tsd-kind-interface">McpAuthOptions</a></div>
249
+ <div class="tsd-comment tsd-typography"><p>MCP Auth configuration to wire into this API.
103
250
  When provided, the following paths are automatically added to the OpenAPI spec
104
251
  with Lambda proxy integrations:</p>
105
252
  <ul>
@@ -113,19 +260,72 @@ with Lambda proxy integrations:</p>
113
260
  The API domain is derived from the RestApi's own domain configuration.</p>
114
261
  <p>Provide either <code>cognito</code> (creates a Cognito client automatically) or
115
262
  <code>generic</code> (for any OAuth2 provider with explicit endpoint URLs).</p>
116
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-11">Default<a href="#default-11" 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-7">MCP</span><span class="hl-1"> </span><span class="hl-4">auth</span>
263
+ </div>
264
+ <div class="tsd-comment tsd-typography">
265
+ <div class="tsd-tag-default">
266
+ <h4 class="tsd-anchor-link" id="default-11">Default<a href="#default-11" 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-7">MCP</span><span class="hl-1"> </span><span class="hl-4">auth</span>
117
267
  </code><button type="button">Copy</button></pre>
118
268
 
119
- </div></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Configure CloudWatch Dashboard for the API and the Lambda functions</p>
120
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-12">Default<a href="#default-12" 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>
269
+ </div></div></section>
270
+ <section class="tsd-panel tsd-member tsd-is-inherited">
271
+ <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>
272
+ <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>
273
+ <div class="tsd-comment tsd-typography"><p>Configure CloudWatch Dashboard for the API and the Lambda functions</p>
274
+ </div>
275
+ <div class="tsd-comment tsd-typography">
276
+ <div class="tsd-tag-default">
277
+ <h4 class="tsd-anchor-link" id="default-12">Default<a href="#default-12" 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>
121
278
  </code><button type="button">Copy</button></pre>
122
279
 
123
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#monitoring">monitoring</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restapiprops"><code class="tsd-tag">Optional</code><span>rest<wbr/>Api<wbr/>Props</span><a href="#restapiprops" 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><div class="tsd-signature"><span class="tsd-kind-property">restApiProps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RestApiBaseProps</span></div><div class="tsd-comment tsd-typography"><p>custom options for the created HttpApi</p>
124
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-13">Default<a href="#default-13" 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>
280
+ </div></div><aside class="tsd-sources">
281
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#monitoring">monitoring</a></p></aside></section>
282
+ <section class="tsd-panel tsd-member">
283
+ <h3 class="tsd-anchor-link" id="restapiprops"><code class="tsd-tag">Optional</code><span>rest<wbr/>Api<wbr/>Props</span><a href="#restapiprops" 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>
284
+ <div class="tsd-signature"><span class="tsd-kind-property">restApiProps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RestApiBaseProps</span></div>
285
+ <div class="tsd-comment tsd-typography"><p>custom options for the created HttpApi</p>
286
+ </div>
287
+ <div class="tsd-comment tsd-typography">
288
+ <div class="tsd-tag-default">
289
+ <h4 class="tsd-anchor-link" id="default-13">Default<a href="#default-13" 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>
125
290
  </code><button type="button">Copy</button></pre>
126
291
 
127
- </div></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-14">Default<a href="#default-14" 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>
292
+ </div></div></section>
293
+ <section class="tsd-panel tsd-member tsd-is-inherited">
294
+ <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>
295
+ <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>
296
+ <div class="tsd-comment tsd-typography">
297
+ <div class="tsd-tag-default">
298
+ <h4 class="tsd-anchor-link" id="default-14">Default<a href="#default-14" 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>
128
299
  </code><button type="button">Copy</button></pre>
129
300
 
130
- </div></div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#singletabledatastore">singleTableDatastore</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><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><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><div class="tsd-comment tsd-typography"><p>Deployment stage (e.g. dev)</p>
131
- </div><aside class="tsd-sources"><p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#stagename">stageName</a></p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><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><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="#anonymousoperations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>anonymous<wbr/>Operations</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="#authorizationscopes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authorization<wbr/>Scopes</span></a><a href="#authorizationscopesbyoperation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authorization<wbr/>Scopes<wbr/>By<wbr/>Operation</span></a><a href="#autogenerateroutes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Generate<wbr/>Routes</span></a><a href="#cors"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cors</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="#jwtauthorizertype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jwt<wbr/>Authorizer<wbr/>Type</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="#lambdaoptionsbyoperation"><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<wbr/>By<wbr/>Operation</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="#mcpauth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mcp<wbr/>Auth</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="#restapiprops"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rest<wbr/>Api<wbr/>Props</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></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
301
+ </div></div><aside class="tsd-sources">
302
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#singletabledatastore">singleTableDatastore</a></p></aside></section>
303
+ <section class="tsd-panel tsd-member tsd-is-inherited">
304
+ <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>
305
+ <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>
306
+ <div class="tsd-comment tsd-typography"><p>Deployment stage (e.g. dev)</p>
307
+ </div><aside class="tsd-sources">
308
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#stagename">stageName</a></p></aside></section></section></details></div>
309
+ <div class="col-sidebar">
310
+ <div class="page-menu">
311
+ <div class="tsd-navigation settings">
312
+ <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>
313
+ <h3>Settings</h3></summary>
314
+ <div class="tsd-accordion-details">
315
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
316
+ <ul id="tsd-filter-options">
317
+ <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>
318
+ <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>
319
+ <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>
320
+ <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>
321
+ <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>
322
+ <h3>On This Page</h3></summary>
323
+ <div class="tsd-accordion-details">
324
+ <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>
325
+ <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="#anonymousoperations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>anonymous<wbr/>Operations</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="#authorizationscopes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authorization<wbr/>Scopes</span></a><a href="#authorizationscopesbyoperation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authorization<wbr/>Scopes<wbr/>By<wbr/>Operation</span></a><a href="#autogenerateroutes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Generate<wbr/>Routes</span></a><a href="#cors"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cors</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="#jwtauthorizertype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jwt<wbr/>Authorizer<wbr/>Type</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="#lambdaoptionsbyoperation"><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<wbr/>By<wbr/>Operation</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="#mcpauth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mcp<wbr/>Auth</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="#restapiprops"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rest<wbr/>Api<wbr/>Props</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></div></details></div></details></div>
326
+ <div class="site-menu">
327
+ <nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
328
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
329
+ <li>Loading...</li></ul></nav></div></div></div><footer>
330
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
331
+ <div class="overlay"></div></body></html>