cdk-serverless 2.14.6 → 2.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/docs/constructs/assets/hierarchy.js +1 -0
  2. package/docs/constructs/assets/icons.js +18 -0
  3. package/docs/constructs/assets/icons.svg +1 -0
  4. package/docs/constructs/assets/main.js +5 -3
  5. package/docs/constructs/assets/navigation.js +1 -0
  6. package/docs/constructs/assets/search.js +1 -1
  7. package/docs/constructs/assets/style.css +1424 -1193
  8. package/docs/constructs/classes/AssetCdn.html +21 -187
  9. package/docs/constructs/classes/BaseApi.html +15 -177
  10. package/docs/constructs/classes/CognitoAuthentication.html +26 -223
  11. package/docs/constructs/classes/GraphQlApi.html +37 -516
  12. package/docs/constructs/classes/LambdaFunction.html +213 -1159
  13. package/docs/constructs/classes/RestApi.html +43 -397
  14. package/docs/constructs/classes/SingleTableDatastore.html +20 -174
  15. package/docs/constructs/classes/Workflow.html +24 -195
  16. package/docs/constructs/hierarchy.html +1 -0
  17. package/docs/constructs/index.html +34 -110
  18. package/docs/constructs/interfaces/AssetCdnProps.html +6 -99
  19. package/docs/constructs/interfaces/BaseApiProps.html +45 -202
  20. package/docs/constructs/interfaces/CognitoAuthenticationProps.html +40 -188
  21. package/docs/constructs/interfaces/GraphQlApiProps.html +46 -218
  22. package/docs/constructs/interfaces/ICognitoAuthentication.html +3 -91
  23. package/docs/constructs/interfaces/IJwtAuthentication.html +7 -103
  24. package/docs/constructs/interfaces/JsResolverOptions.html +11 -106
  25. package/docs/constructs/interfaces/LambdaFunctionProps.html +35 -202
  26. package/docs/constructs/interfaces/LambdaTracingOptions.html +6 -90
  27. package/docs/constructs/interfaces/RestApiProps.html +62 -261
  28. package/docs/constructs/interfaces/SingleTableDatastoreProps.html +12 -111
  29. package/docs/constructs/interfaces/SingleTableDesign.html +12 -121
  30. package/docs/constructs/interfaces/VtlResolverOptions.html +8 -103
  31. package/docs/constructs/interfaces/WorkflowProps.html +6 -109
  32. package/docs/constructs/modules.html +1 -93
  33. package/docs/constructs/types/LambdaOptions.html +1 -62
  34. package/docs/lambda/assets/hierarchy.js +1 -0
  35. package/docs/lambda/assets/icons.js +18 -0
  36. package/docs/lambda/assets/icons.svg +1 -0
  37. package/docs/lambda/assets/main.js +5 -3
  38. package/docs/lambda/assets/navigation.js +1 -0
  39. package/docs/lambda/assets/search.js +1 -1
  40. package/docs/lambda/assets/style.css +1424 -1193
  41. package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +38 -309
  42. package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +37 -308
  43. package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +38 -309
  44. package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +37 -306
  45. package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +36 -299
  46. package/docs/lambda/classes/auth.CognitoAuthorizer.html +34 -288
  47. package/docs/lambda/classes/auth.JwtAuthorizer.html +34 -282
  48. package/docs/lambda/classes/errors.BadRequestError.html +16 -181
  49. package/docs/lambda/classes/errors.ForbiddenError.html +16 -181
  50. package/docs/lambda/classes/errors.HttpError.html +17 -189
  51. package/docs/lambda/classes/errors.NotFoundError.html +16 -181
  52. package/docs/lambda/classes/errors.UnauthenticatedError.html +16 -181
  53. package/docs/lambda/functions/api.createAppSyncHandler.html +3 -80
  54. package/docs/lambda/functions/api.createHttpHandler.html +2 -78
  55. package/docs/lambda/functions/api.createOpenApiHandler.html +2 -78
  56. package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +2 -78
  57. package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +2 -76
  58. package/docs/lambda/hierarchy.html +1 -0
  59. package/docs/lambda/index.html +34 -90
  60. package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +6 -105
  61. package/docs/lambda/interfaces/api.HttpHandlerContext.html +7 -105
  62. package/docs/lambda/interfaces/api.HttpResponseContext.html +5 -100
  63. package/docs/lambda/interfaces/api.Operation.html +3 -92
  64. package/docs/lambda/interfaces/api.OperationWithRequestBody.html +4 -106
  65. package/docs/lambda/modules/api.html +1 -82
  66. package/docs/lambda/modules/auth.html +1 -64
  67. package/docs/lambda/modules/errors.html +1 -60
  68. package/docs/lambda/modules.html +1 -47
  69. package/docs/lambda/types/api.APIGatewayv1Handler.html +2 -62
  70. package/docs/lambda/types/api.AppSyncHandler.html +2 -82
  71. package/docs/lambda/types/api.HttpHandler.html +2 -84
  72. package/docs/projen/assets/hierarchy.js +1 -0
  73. package/docs/projen/assets/icons.js +18 -0
  74. package/docs/projen/assets/icons.svg +1 -0
  75. package/docs/projen/assets/main.js +5 -3
  76. package/docs/projen/assets/navigation.js +1 -0
  77. package/docs/projen/assets/search.js +1 -1
  78. package/docs/projen/assets/style.css +1424 -1193
  79. package/docs/projen/classes/Datastore.html +26 -246
  80. package/docs/projen/classes/GraphQlApi.html +25 -212
  81. package/docs/projen/classes/RestApi.html +49 -347
  82. package/docs/projen/classes/ServerlessProject.html +245 -1409
  83. package/docs/projen/classes/Workflow.html +39 -273
  84. package/docs/projen/index.html +34 -98
  85. package/docs/projen/interfaces/DatastoreOptions.html +3 -77
  86. package/docs/projen/interfaces/GraphQlApiOptions.html +3 -77
  87. package/docs/projen/interfaces/RestApiOptions.html +3 -77
  88. package/docs/projen/interfaces/ServerlessProjectOptions.html +822 -2053
  89. package/docs/projen/interfaces/WorkflowOptions.html +3 -77
  90. package/docs/projen/modules.html +1 -69
  91. package/docs/projen/variables/PACKAGE_NAME.html +1 -50
  92. package/lib/constructs/authentication.d.ts +13 -0
  93. package/lib/constructs/authentication.js +47 -13
  94. package/lib/constructs/base-api.js +1 -1
  95. package/lib/constructs/func.js +1 -1
  96. package/lib/constructs/graphql.js +21 -11
  97. package/lib/constructs/rest-api.js +18 -8
  98. package/lib/constructs/table.js +1 -1
  99. package/lib/constructs/workflow.js +18 -8
  100. package/lib/lambda/auth.js +1 -1
  101. package/lib/lambda/handler.d.ts +1 -1
  102. package/lib/lambda/handler.js +21 -11
  103. package/lib/lambda/index.js +18 -8
  104. package/lib/projen/core.js +18 -8
  105. package/lib/projen/datastore.js +18 -8
  106. package/lib/projen/graphql.js +21 -11
  107. package/lib/projen/lazy-sampledir.js +1 -1
  108. package/lib/projen/rest-api.js +18 -8
  109. package/lib/projen/workflow.js +18 -8
  110. package/lib/tests/integ-test-util.js +3 -3
  111. package/package.json +26 -25
package/docs/constructs/index.html CHANGED
@@ -1,21 +1,7 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base=".">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cdk-serverless</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <h2>cdk-serverless</h2></div>
15
- <div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="#md:cdk-serverless">CDK Serverless</a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
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>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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>cdk-serverless</h1></div><div class="tsd-panel tsd-typography"><a id="cdk-serverless" class="tsd-anchor"></a><h1 class="tsd-anchor-link">CDK Serverless<a href="#cdk-serverless" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
16
2
  <p>CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.</p>
17
3
  <p>Video introduction: <a href="https://www.youtube.com/watch?v=xhNJ0cXG3O8">https://www.youtube.com/watch?v=xhNJ0cXG3O8</a></p>
18
- <a id="md:features" class="tsd-anchor"></a><h3><a href="#md:features">Features</a></h3><ul>
4
+ <a id="features" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
19
5
  <li>Projen helper classes for easy project configuration</li>
20
6
  <li>AWS CDK L3-constructs for RestApi, GraphQlApi, and more</li>
21
7
  <li>Zero-config Lambda function and VTL template generation</li>
@@ -26,116 +12,54 @@
26
12
  <li>Support for Cognito authentication and authorization</li>
27
13
  <li>Automated generation of CloudFormation outputs for testing</li>
28
14
  </ul>
29
- <a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#md:quick-start">Quick Start</a></h2><p>To begin a new project with CDK Serverless:</p>
15
+ <a id="quick-start" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Quick Start<a href="#quick-start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>To begin a new project with CDK Serverless:</p>
30
16
  <p>Create a new CDK TypeScript app using projen:</p>
31
- <pre><code class="language-bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npx</span><span class="hl-1"> </span><span class="hl-2">projen</span><span class="hl-1"> </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-2">awscdk-app-ts</span>
32
- </code><button>Copy</button></pre>
17
+ <pre><code class="bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npx</span><span class="hl-1"> </span><span class="hl-2">projen</span><span class="hl-1"> </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-2">awscdk-app-ts</span>
18
+ </code><button type="button">Copy</button></pre>
19
+
33
20
  <p>Adding CDK Serverless is a two step process:</p>
34
21
  <ol>
35
- <li>Add &#39;cdk-serverless&#39; as a dependency to your project</li>
22
+ <li>Add 'cdk-serverless' as a dependency to your project</li>
36
23
  <li>Run <code>npx projen</code> to install it</li>
37
24
  </ol>
38
25
  <p>Now you can use the project type <code>ServerlessProject</code> for your app.</p>
39
- <a id="md:adding-projen-constructs" class="tsd-anchor"></a><h3><a href="#md:adding-projen-constructs">Adding projen constructs</a></h3><p>First you need to add the desired construct to your projen configuration: (e.g. RestApi)</p>
40
- <pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">RestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;cdk-serverless/projen&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RestApi</span><span class="hl-1">(</span><span class="hl-4">project</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">apiName:</span><span class="hl-1"> </span><span class="hl-2">&#39;TestApi&#39;</span><span class="hl-1">, </span><span class="hl-6">// logical name of your API</span><br/><span class="hl-1"> </span><span class="hl-4">definitionFile:</span><span class="hl-1"> </span><span class="hl-2">&#39;testapi.yaml&#39;</span><span class="hl-1">, </span><span class="hl-6">// path to your OpenAPI spec</span><br/><span class="hl-1">});</span>
41
- </code><button>Copy</button></pre>
26
+ <a id="adding-projen-constructs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Adding projen constructs<a href="#adding-projen-constructs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>First you need to add the desired construct to your projen configuration: (e.g. RestApi)</p>
27
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">RestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;cdk-serverless/projen&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RestApi</span><span class="hl-1">(</span><span class="hl-4">project</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">apiName:</span><span class="hl-1"> </span><span class="hl-2">&#39;TestApi&#39;</span><span class="hl-1">, </span><span class="hl-6">// logical name of your API</span><br/><span class="hl-1"> </span><span class="hl-4">definitionFile:</span><span class="hl-1"> </span><span class="hl-2">&#39;testapi.yaml&#39;</span><span class="hl-1">, </span><span class="hl-6">// path to your OpenAPI spec</span><br/><span class="hl-1">});</span>
28
+ </code><button type="button">Copy</button></pre>
29
+
42
30
  <p>Then run projen to generate construct files and models for the API.</p>
43
- <a id="md:using-the-cdk-serverless-l3-constructs" class="tsd-anchor"></a><h3><a href="#md:using-the-cdk-serverless-l3-constructs">Using the CDK serverless L3 constructs</a></h3><p>In your stack you can then reference the generated L3s to create the API:</p>
44
- <pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">TestApiRestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./generated/rest.testapi-api.generated&#39;</span><span class="hl-1">;</span><br/><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">api</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">TestApiRestApi</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">&#39;Api&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">stageName:</span><span class="hl-1"> </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">stageName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">domainName:</span><span class="hl-1"> </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">domainName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">apiHostname:</span><span class="hl-1"> </span><span class="hl-2">&#39;api&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">singleTableDatastore</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">cors:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">additionalEnv:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">DOMAIN_NAME:</span><span class="hl-1"> </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">domainName</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
45
- </code><button>Copy</button></pre>
31
+ <a id="using-the-cdk-serverless-l3-constructs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Using the CDK serverless L3 constructs<a href="#using-the-cdk-serverless-l3-constructs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>In your stack you can then reference the generated L3s to create the API:</p>
32
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">TestApiRestApi</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./generated/rest.testapi-api.generated&#39;</span><span class="hl-1">;</span><br/><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">api</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">TestApiRestApi</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">&#39;Api&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">stageName:</span><span class="hl-1"> </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">stageName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">domainName:</span><span class="hl-1"> </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">domainName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">apiHostname:</span><span class="hl-1"> </span><span class="hl-2">&#39;api&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">singleTableDatastore</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">cors:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">additionalEnv:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">DOMAIN_NAME:</span><span class="hl-1"> </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">domainName</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
33
+ </code><button type="button">Copy</button></pre>
34
+
46
35
  <p>This will also create Lambda functions for all operations defined in your spec and wire them accordingly.</p>
47
- <a id="md:contribute" class="tsd-anchor"></a><h2><a href="#md:contribute">Contribute</a></h2><a id="md:how-to-contribute-to-cdk-serverless" class="tsd-anchor"></a><h3><a href="#md:how-to-contribute-to-cdk-serverless">How to contribute to CDK Serverless</a></h3><a id="md:did-you-find-a-bug" class="tsd-anchor"></a><h4><a href="#md:did-you-find-a-bug"><strong>Did you find a bug?</strong></a></h4><ul>
48
- <li><p><strong>Ensure the bug was not already reported</strong> by searching on GitHub under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
36
+ <a id="contribute" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Contribute<a href="#contribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="how-to-contribute-to-cdk-serverless" class="tsd-anchor"></a><h3 class="tsd-anchor-link">How to contribute to CDK Serverless<a href="#how-to-contribute-to-cdk-serverless" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><a id="did-you-find-a-bug" class="tsd-anchor"></a><h4 class="tsd-anchor-link"><strong>Did you find a bug?</strong><a href="#did-you-find-a-bug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
37
+ <li>
38
+ <p><strong>Ensure the bug was not already reported</strong> by searching on GitHub under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
49
39
  </li>
50
- <li><p>If you&#39;re unable to find an open issue addressing the problem, <a href="https://github.com/taimos/cdk-serverless/issues/new">open a new one</a>. Be sure to include a <strong>title and clear description</strong>, as much relevant information as possible, and a <strong>code sample</strong> or an <strong>executable test case</strong> demonstrating the expected behavior that is not occurring.</p>
40
+ <li>
41
+ <p>If you're unable to find an open issue addressing the problem, <a href="https://github.com/taimos/cdk-serverless/issues/new">open a new one</a>. Be sure to include a <strong>title and clear description</strong>, as much relevant information as possible, and a <strong>code sample</strong> or an <strong>executable test case</strong> demonstrating the expected behavior that is not occurring.</p>
51
42
  </li>
52
43
  </ul>
53
- <a id="md:did-you-write-a-patch-that-fixes-a-bug" class="tsd-anchor"></a><h4><a href="#md:did-you-write-a-patch-that-fixes-a-bug"><strong>Did you write a patch that fixes a bug?</strong></a></h4><ul>
54
- <li><p>Open a new GitHub pull request with the patch.</p>
44
+ <a id="did-you-write-a-patch-that-fixes-a-bug" class="tsd-anchor"></a><h4 class="tsd-anchor-link"><strong>Did you write a patch that fixes a bug?</strong><a href="#did-you-write-a-patch-that-fixes-a-bug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
45
+ <li>
46
+ <p>Open a new GitHub pull request with the patch.</p>
55
47
  </li>
56
- <li><p>Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.</p>
48
+ <li>
49
+ <p>Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.</p>
57
50
  </li>
58
51
  </ul>
59
- <a id="md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" class="tsd-anchor"></a><h4><a href="#md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch"><strong>Did you fix whitespace, format code, or make a purely cosmetic patch?</strong></a></h4><p>Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will normally not be accepted.</p>
60
- <a id="md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one" class="tsd-anchor"></a><h4><a href="#md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one"><strong>Do you intend to add a new feature or change an existing one?</strong></a></h4><ul>
61
- <li><p>Suggest your change under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
52
+ <a id="did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" class="tsd-anchor"></a><h4 class="tsd-anchor-link"><strong>Did you fix whitespace, format code, or make a purely cosmetic patch?</strong><a href="#did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will normally not be accepted.</p>
53
+ <a id="do-you-intend-to-add-a-new-feature-or-change-an-existing-one" class="tsd-anchor"></a><h4 class="tsd-anchor-link"><strong>Do you intend to add a new feature or change an existing one?</strong><a href="#do-you-intend-to-add-a-new-feature-or-change-an-existing-one" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
54
+ <li>
55
+ <p>Suggest your change under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
62
56
  </li>
63
- <li><p>Do not open a pull request on GitHub until you have collected positive feedback about the change.</p>
57
+ <li>
58
+ <p>Do not open a pull request on GitHub until you have collected positive feedback about the change.</p>
64
59
  </li>
65
60
  </ul>
66
- <a id="md:do-you-want-to-contribute-to-the-cdk-serverless-documentation" class="tsd-anchor"></a><h4><a href="#md:do-you-want-to-contribute-to-the-cdk-serverless-documentation"><strong>Do you want to contribute to the CDK Serverless documentation?</strong></a></h4><ul>
61
+ <a id="do-you-want-to-contribute-to-the-cdk-serverless-documentation" class="tsd-anchor"></a><h4 class="tsd-anchor-link"><strong>Do you want to contribute to the CDK Serverless documentation?</strong><a href="#do-you-want-to-contribute-to-the-cdk-serverless-documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
67
62
  <li>Just file a PR with your recommended changes</li>
68
63
  </ul>
69
- <a id="md:authors" class="tsd-anchor"></a><h2><a href="#md:authors">Authors</a></h2><p>Brought to you by <a href="https://taimos.de">Taimos</a></p>
70
- </div></div>
71
- <div class="col-sidebar">
72
- <div class="page-menu">
73
- <div class="tsd-navigation settings">
74
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
75
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
76
- <div class="tsd-accordion-details">
77
- <div class="tsd-filter-visibility">
78
- <h4 class="uppercase">Member Visibility</h4><form>
79
- <ul id="tsd-filter-options">
80
- <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>
81
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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>Private</span></label></li>
82
- <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>
83
- <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></form></div>
84
- <div class="tsd-theme-toggle">
85
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
86
- <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
87
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
88
- <div class="tsd-accordion-details">
89
- <ul>
90
- <li>
91
- <ul>
92
- <li><a href="#md:cdk-serverless"><span>CDK <wbr/>Serverless</span></a></li>
93
- <li>
94
- <ul>
95
- <li><a href="#md:features"><span>Features</span></a></li>
96
- <li><a href="#md:quick-start"><span>Quick <wbr/>Start</span></a></li>
97
- <li>
98
- <ul>
99
- <li><a href="#md:adding-projen-constructs"><span>Adding projen constructs</span></a></li>
100
- <li><a href="#md:using-the-cdk-serverless-l3-constructs"><span>Using the CDK serverless <wbr/>L3 constructs</span></a></li></ul></li>
101
- <li><a href="#md:contribute"><span>Contribute</span></a></li>
102
- <li>
103
- <ul>
104
- <li><a href="#md:how-to-contribute-to-cdk-serverless"><span>How to contribute to CDK <wbr/>Serverless</span></a></li>
105
- <li>
106
- <ul>
107
- <li><a href="#md:did-you-find-a-bug"><span>Did you find a bug?</span></a></li>
108
- <li><a href="#md:did-you-write-a-patch-that-fixes-a-bug"><span>Did you write a patch that fixes a bug?</span></a></li>
109
- <li><a href="#md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch"><span>Did you fix whitespace, format code, or make a purely cosmetic patch?</span></a></li>
110
- <li><a href="#md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one"><span>Do you intend to add a new feature or change an existing one?</span></a></li>
111
- <li><a href="#md:do-you-want-to-contribute-to-the-cdk-serverless-documentation"><span>Do you want to contribute to the CDK <wbr/>Serverless documentation?</span></a></li></ul></li></ul></li>
112
- <li><a href="#md:authors"><span>Authors</span></a></li></ul></li></ul></li></ul></div></details></div>
113
- <div class="site-menu">
114
- <nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
115
- <ul class="tsd-small-nested-navigation">
116
- <li><a href="classes/AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
117
- <li><a href="classes/BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
118
- <li><a href="classes/CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
119
- <li><a href="classes/GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
120
- <li><a href="classes/LambdaFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
121
- <li><a href="classes/RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
122
- <li><a href="classes/SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
123
- <li><a href="classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
124
- <li><a href="interfaces/AssetCdnProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
125
- <li><a href="interfaces/BaseApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
126
- <li><a href="interfaces/CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
127
- <li><a href="interfaces/GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
128
- <li><a href="interfaces/ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
129
- <li><a href="interfaces/IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
130
- <li><a href="interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
131
- <li><a href="interfaces/LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
132
- <li><a href="interfaces/LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
133
- <li><a href="interfaces/RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
134
- <li><a href="interfaces/SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
135
- <li><a href="interfaces/SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
136
- <li><a href="interfaces/VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
137
- <li><a href="interfaces/WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
138
- <li><a href="types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
139
- <div class="tsd-generator">
140
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
141
- <div class="overlay"></div></body></html>
64
+ <a id="authors" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Authors<a href="#authors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Brought to you by <a href="https://taimos.de">Taimos</a></p>
65
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cdk-serverless"><span>CDK <wbr/>Serverless</span></a><ul><li><ul><li><a href="#features"><span>Features</span></a></li></ul></li><li><a href="#quick-start"><span>Quick <wbr/>Start</span></a></li><li><ul><li><a href="#adding-projen-constructs"><span>Adding projen constructs</span></a></li><li><a href="#using-the-cdk-serverless-l3-constructs"><span>Using the CDK serverless <wbr/>L3 constructs</span></a></li></ul></li><li><a href="#contribute"><span>Contribute</span></a></li><li><ul><li><a href="#how-to-contribute-to-cdk-serverless"><span>How to contribute to CDK <wbr/>Serverless</span></a></li><li><ul><li><a href="#did-you-find-a-bug"><span>Did you find a bug?</span></a></li><li><a href="#did-you-write-a-patch-that-fixes-a-bug"><span>Did you write a patch that fixes a bug?</span></a></li><li><a href="#did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch"><span>Did you fix whitespace, format code, or make a purely cosmetic patch?</span></a></li><li><a href="#do-you-intend-to-add-a-new-feature-or-change-an-existing-one"><span>Do you intend to add a new feature or change an existing one?</span></a></li><li><a href="#do-you-want-to-contribute-to-the-cdk-serverless-documentation"><span>Do you want to contribute to the CDK <wbr/>Serverless documentation?</span></a></li></ul></li></ul></li><li><a href="#authors"><span>Authors</span></a></li></ul></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>
package/docs/constructs/interfaces/AssetCdnProps.html CHANGED
@@ -1,99 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AssetCdnProps | 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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">cdk-serverless</a></li>
16
- <li><a href="AssetCdnProps.html">AssetCdnProps</a></li></ul>
17
- <h1>Interface AssetCdnProps</h1></div>
18
- <section class="tsd-panel tsd-comment">
19
- <div class="tsd-comment tsd-typography"><p>Properties for AssetCdn L3 construct</p>
20
- </div>
21
- <div class="tsd-comment tsd-typography"></div></section>
22
- <section class="tsd-panel tsd-hierarchy">
23
- <h4>Hierarchy</h4>
24
- <ul class="tsd-hierarchy">
25
- <li><span class="target">AssetCdnProps</span></li></ul></section>
26
- <section class="tsd-panel-group tsd-index-group">
27
- <section class="tsd-panel tsd-index-panel">
28
- <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
29
- <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
30
- <div class="tsd-accordion-details">
31
- <section class="tsd-index-section">
32
- <h3 class="tsd-index-heading">Properties</h3>
33
- <div class="tsd-index-list"><a href="AssetCdnProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>domain<wbr/>Name</span></a>
34
- <a href="AssetCdnProps.html#hostName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>host<wbr/>Name</span></a>
35
- </div></section></div></details></section></section>
36
- <section class="tsd-panel-group tsd-member-group">
37
- <h2>Properties</h2>
38
- <section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
39
- <h3 class="tsd-anchor-link"><span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
40
- <div class="tsd-signature"><span class="tsd-kind-property">domain<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
41
- <div class="tsd-comment tsd-typography"><p>Domain name of the asset content delivery network (e.g. example.com)</p>
42
- </div>
43
- <div class="tsd-comment tsd-typography"></div></section>
44
- <section class="tsd-panel tsd-member"><a id="hostName" class="tsd-anchor"></a>
45
- <h3 class="tsd-anchor-link"><span>host<wbr/>Name</span><a href="#hostName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
46
- <div class="tsd-signature"><span class="tsd-kind-property">host<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
47
- <div class="tsd-comment tsd-typography"><p>Hostname of the asset content delivery network (e.g. cdn)</p>
48
- </div>
49
- <div class="tsd-comment tsd-typography"></div></section></section></div>
50
- <div class="col-sidebar">
51
- <div class="page-menu">
52
- <div class="tsd-navigation settings">
53
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
54
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
55
- <div class="tsd-accordion-details">
56
- <div class="tsd-filter-visibility">
57
- <h4 class="uppercase">Member Visibility</h4><form>
58
- <ul id="tsd-filter-options">
59
- <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>
60
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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>Private</span></label></li>
61
- <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>
62
- <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></form></div>
63
- <div class="tsd-theme-toggle">
64
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
65
- <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
66
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
67
- <div class="tsd-accordion-details">
68
- <ul>
69
- <li><a href="#domainName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
70
- <li><a href="#hostName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>host<wbr/>Name</span></a></li></ul></div></details></div>
71
- <div class="site-menu">
72
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
73
- <ul class="tsd-small-nested-navigation">
74
- <li><a href="../classes/AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
75
- <li><a href="../classes/BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
76
- <li><a href="../classes/CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
77
- <li><a href="../classes/GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
78
- <li><a href="../classes/LambdaFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
79
- <li><a href="../classes/RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
80
- <li><a href="../classes/SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
81
- <li><a href="../classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
82
- <li><a href="AssetCdnProps.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
83
- <li><a href="BaseApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
84
- <li><a href="CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
85
- <li><a href="GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
86
- <li><a href="ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
87
- <li><a href="IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
88
- <li><a href="JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
89
- <li><a href="LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
90
- <li><a href="LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
91
- <li><a href="RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
92
- <li><a href="SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
93
- <li><a href="SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
94
- <li><a href="VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
95
- <li><a href="WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
96
- <li><a href="../types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
97
- <div class="tsd-generator">
98
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
99
- <div class="overlay"></div></body></html>
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>AssetCdnProps | 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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="AssetCdnProps.html">AssetCdnProps</a></li></ul><h1>Interface AssetCdnProps</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Properties for AssetCdn L3 construct</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AssetCdnProps</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="AssetCdnProps.html#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="AssetCdnProps.html#hostname">hostName</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-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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> 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="AssetCdnProps.html#domainname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain<wbr/>Name</span></a>
3
+ <a href="AssetCdnProps.html#hostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host<wbr/>Name</span></a>
4
+ </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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="domainname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>domain<wbr/>Name</span><a href="#domainname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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 asset content delivery network (e.g. <a href="http://example.com">example.com</a>)</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="hostname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>host<wbr/>Name</span><a href="#hostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hostName</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 asset content delivery network (e.g. cdn)</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#domainname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain<wbr/>Name</span></a><a href="#hostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host<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>