cdk-serverless 2.11.22 → 2.11.24

package/README.md

@@ -30,6 +30,45 @@ Adding CDK Serverless is a two step process:
 1. Add 'cdk-serverless' as a dependency to your project
 2. Run `npx projen` to install it
 
+Now you can use the project type `ServerlessProject` for your repo.
+
+### Adding projen constructs
+
+First you need to add the desired construct to your projen configuration: (e.g. RestApi)
+
+```typescript
+import { RestApi } from 'cdk-serverless/projen';
+
+new RestApi(project, {
+  apiName: 'TestApi', // logical name of your API
+  definitionFile: 'testapi.yaml', // path to your OpenAPI spec
+});
+```
+
+Then run projen to generate construct files and models for the API.
+
+### Using the CDK serverless L3 constructs
+
+In your stack you can then reference the generated L3s to create the API:
+
+```typescript
+import { TestApiRestApi } from './generated/rest.testapi-api.generated';
+
+
+const api = new TestApiRestApi(this, 'Api', {
+  stageName: props.stageName,
+  domainName: props.domainName,
+  apiHostname: 'api',
+  singleTableDatastore,
+  cors: true,
+  additionalEnv: {
+    DOMAIN_NAME: props.domainName,
+  },
+});
+```
+
+This will also create Lambda functions for all operations defined in your spec and wire them accordingly.
+
 ## Contribute
 
 ### How to contribute to CDK Serverless

package/docs/constructs/assets/highlight.css

@@ -5,20 +5,20 @@
     --dark-hl-1: #D4D4D4;
     --light-hl-2: #A31515;
     --dark-hl-2: #CE9178;
-    --light-hl-3: #0000FF;
-    --dark-hl-3: #569CD6;
-    --light-hl-4: #0070C1;
-    --dark-hl-4: #4FC1FF;
-    --light-hl-5: #267F99;
-    --dark-hl-5: #4EC9B0;
-    --light-hl-6: #001080;
-    --dark-hl-6: #9CDCFE;
-    --light-hl-7: #008000;
-    --dark-hl-7: #6A9955;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #008000;
+    --dark-hl-6: #6A9955;
+    --light-hl-7: #0070C1;
+    --dark-hl-7: #4FC1FF;
     --light-hl-8: #098658;
     --dark-hl-8: #B5CEA8;
-    --light-hl-9: #AF00DB;
-    --dark-hl-9: #C586C0;
+    --light-hl-9: #267F99;
+    --dark-hl-9: #4EC9B0;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }

package/docs/constructs/classes/AssetCdn.html

@@ -15,6 +15,12 @@
 <li><a href="../modules.html">cdk-serverless</a></li>
 <li><a href="AssetCdn.html">AssetCdn</a></li></ul>
 <h1>Class AssetCdn</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>The AssetCdn construct is responsible for setting up an S3 bucket for asset storage
+and a CloudFront distribution to serve the assets securely with HTTPS. It also
+configures a Route 53 DNS record to point to the CloudFront distribution.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
@@ -49,25 +55,40 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="constructor.new_AssetCdn"><span class="tsd-kind-constructor-signature">new <wbr/>Asset<wbr/>Cdn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AssetCdn.html" class="tsd-signature-type tsd-kind-class">AssetCdn</a><a href="#constructor.new_AssetCdn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Creates an instance of AssetCdn.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
+<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
+<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/AssetCdnProps.html" class="tsd-signature-type tsd-kind-interface">AssetCdnProps</a></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="AssetCdn.html" class="tsd-signature-type tsd-kind-class">AssetCdn</a></h4><aside class="tsd-sources">
+<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/AssetCdnProps.html" class="tsd-signature-type tsd-kind-interface">AssetCdnProps</a></h5>
+<div class="tsd-comment tsd-typography"><p>The properties of the AssetCdn construct.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="AssetCdn.html" class="tsd-signature-type tsd-kind-class">AssetCdn</a></h4>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Overrides Construct.constructor</p></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="assetBucket" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset<wbr/>Bucket</span><a href="#assetBucket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Bucket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Bucket</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Bucket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Bucket</span></div>
+<div class="tsd-comment tsd-typography"><p>The S3 bucket used to store the assets.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member"><a id="assetDomainName" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>asset<wbr/>Domain<wbr/>Name</span><a href="#assetDomainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Domain<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">asset<wbr/>Domain<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>The domain name used for accessing the assets.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div>
@@ -77,7 +98,10 @@
 <p>Inherited from Construct.node</p></aside></section>
 <section class="tsd-panel tsd-member"><a id="zone" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>zone</span><a href="#zone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">zone</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">IHostedZone</span></div></section></section>
+<div class="tsd-signature"><span class="tsd-kind-property">zone</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">IHostedZone</span></div>
+<div class="tsd-comment tsd-typography"><p>The Route 53 hosted zone for the asset domain.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString" class="tsd-anchor"></a>

package/docs/constructs/classes/BaseApi.html

@@ -15,6 +15,10 @@
 <li><a href="../modules.html">cdk-serverless</a></li>
 <li><a href="BaseApi.html">BaseApi</a></li></ul>
 <h1>Class BaseApi<code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Base class for different types of APIs</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">

package/docs/constructs/classes/CognitoAuthentication.html

@@ -15,6 +15,11 @@
 <li><a href="../modules.html">cdk-serverless</a></li>
 <li><a href="CognitoAuthentication.html">CognitoAuthentication</a></li></ul>
 <h1>Class CognitoAuthentication</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>The CognitoAuthentication construct sets up a Cognito User Pool with optional triggers and an optional Cognito Identity Pool.
+It also configures various Lambda triggers for custom message, pre-sign up, and pre-token generation events.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
@@ -55,25 +60,40 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="constructor.new_CognitoAuthentication"><span class="tsd-kind-constructor-signature">new <wbr/>Cognito<wbr/>Authentication</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a><a href="#constructor.new_CognitoAuthentication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Creates an instance of CognitoAuthentication.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
+<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
+<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/CognitoAuthenticationProps.html" class="tsd-signature-type tsd-kind-interface">CognitoAuthenticationProps</a></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></h4><aside class="tsd-sources">
+<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/CognitoAuthenticationProps.html" class="tsd-signature-type tsd-kind-interface">CognitoAuthenticationProps</a></h5>
+<div class="tsd-comment tsd-typography"><p>The properties of the CognitoAuthentication construct.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></h4>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Overrides Construct.constructor</p></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="customMessageFunction" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>custom<wbr/>Message<wbr/>Function</span><a href="#customMessageFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">custom<wbr/>Message<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">custom<wbr/>Message<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></div>
+<div class="tsd-comment tsd-typography"><p>The optional Lambda function for custom message trigger.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member"><a id="identityPool" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>identity<wbr/>Pool</span><a href="#identityPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">identity<wbr/>Pool</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IdentityPool</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">identity<wbr/>Pool</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IdentityPool</span></div>
+<div class="tsd-comment tsd-typography"><p>The optional Cognito Identity Pool for federated identities.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div>
@@ -83,14 +103,20 @@
 <p>Inherited from Construct.node</p></aside></section>
 <section class="tsd-panel tsd-member"><a id="preSignUpFunction" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pre<wbr/>Sign<wbr/>Up<wbr/>Function</span><a href="#preSignUpFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">pre<wbr/>Sign<wbr/>Up<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">pre<wbr/>Sign<wbr/>Up<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></div>
+<div class="tsd-comment tsd-typography"><p>The optional Lambda function for pre-sign up trigger.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member"><a id="preTokenGenerationFunction" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pre<wbr/>Token<wbr/>Generation<wbr/>Function</span><a href="#preTokenGenerationFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">pre<wbr/>Token<wbr/>Generation<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">pre<wbr/>Token<wbr/>Generation<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></div>
+<div class="tsd-comment tsd-typography"><p>The optional Lambda function for pre-token generation trigger.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member"><a id="userpool" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>userpool</span><a href="#userpool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">userpool</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">UserPool</span></div>
-<div class="tsd-comment tsd-typography"><p>The Cognito user pool that holds user information</p>
+<div class="tsd-comment tsd-typography"><p>The Cognito User Pool for user authentication.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Implementation of <a href="../interfaces/ICognitoAuthentication.html">ICognitoAuthentication</a>.<a href="../interfaces/ICognitoAuthentication.html#userpool">userpool</a></p></aside></section></section>

package/docs/constructs/classes/GraphQlApi.html

@@ -14,12 +14,24 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">cdk-serverless</a></li>
 <li><a href="GraphQlApi.html">GraphQlApi</a></li></ul>
-<h1>Class GraphQlApi&lt;RESOLVERS&gt;</h1></div> 
+<h1>Class GraphQlApi&lt;RESOLVERS&gt;</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>The GraphQlApi construct sets up an AWS AppSync GraphQL API integrated with Cognito for authentication and DynamoDB for data storage.
+This construct facilitates the creation of a GraphQL API with various configurations, including custom domain, logging, schema definition,
+and authorization using Cognito User Pool and Identity Pool. It also provides methods to dynamically add resolvers and grant access to specific fields.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<h4>Example</h4><pre><code class="language-ts"><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">GraphQlApi</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">&#39;MyGraphQlApi&#39;</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;MyAPI&#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-2">&#39;dev&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">definitionFileName:</span><span class="hl-1"> </span><span class="hl-2">&#39;schema.graphql&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">authentication:</span><span class="hl-1"> </span><span class="hl-4">myCognitoAuth</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">singleTableDatastore:</span><span class="hl-1"> </span><span class="hl-4">myDynamoDBTable</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">// Add a Lambda resolver</span><br/><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-0">addLambdaResolver</span><span class="hl-1">(</span><span class="hl-2">&#39;Query&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;getItem&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-6">// Grant access to unauthenticated users for a specific query</span><br/><span class="hl-4">api</span><span class="hl-1">.</span><span class="hl-0">grantAccessUnAuth</span><span class="hl-1">(</span><span class="hl-2">&#39;Query&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;getItem&#39;</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+</div></section> 
 <section class="tsd-panel">
 <h4>Type Parameters</h4>
 <ul class="tsd-type-parameter-list">
 <li>
-<h4><span class="tsd-kind-type-parameter">RESOLVERS</span></h4></li></ul></section> 
+<h4><span class="tsd-kind-type-parameter">RESOLVERS</span></h4>
+<div class="tsd-comment tsd-typography"><p>The type definition for the GraphQL resolvers.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></li></ul></section> 
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
@@ -72,6 +84,8 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="constructor.new_GraphQlApi"><span class="tsd-kind-constructor-signature">new <wbr/>Graph<wbr/>Ql<wbr/>Api</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">RESOLVERS</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GraphQlApi.html" class="tsd-signature-type tsd-kind-class">GraphQlApi</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">RESOLVERS</span><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_GraphQlApi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Creates an instance of GraphQlApi.</p>
+</div>
 <section class="tsd-panel">
 <h4>Type Parameters</h4>
 <ul class="tsd-type-parameter-list">
@@ -81,26 +95,39 @@
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
+<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
+<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/GraphQlApiProps.html" class="tsd-signature-type tsd-kind-interface">GraphQlApiProps</a></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="GraphQlApi.html" class="tsd-signature-type tsd-kind-class">GraphQlApi</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">RESOLVERS</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/GraphQlApiProps.html" class="tsd-signature-type tsd-kind-interface">GraphQlApiProps</a></h5>
+<div class="tsd-comment tsd-typography"><p>The properties of the GraphQlApi construct.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="GraphQlApi.html" class="tsd-signature-type tsd-kind-class">GraphQlApi</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">RESOLVERS</span><span class="tsd-signature-symbol">&gt;</span></h4>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Overrides <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#constructor">constructor</a></p></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_functions" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_functions</span><a href="#_functions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">_functions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">operationId</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></div>
+<div class="tsd-comment tsd-typography"><p>A collection of Lambda functions used as resolvers for the GraphQL API.</p>
+</div>
 <div class="tsd-type-declaration">
 <h4>Type declaration</h4>
 <ul class="tsd-parameters">
 <li class="tsd-parameter-index-signature">
-<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">operationId</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h5></li></ul></div></section>
+<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">operationId</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h5></li></ul></div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member"><a id="api" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api</span><a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">GraphqlApi</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">GraphqlApi</span></div>
+<div class="tsd-comment tsd-typography"><p>The AWS AppSync GraphQL API instance.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="apiDomainName" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>api<wbr/>Domain<wbr/>Name</span><a href="#apiDomainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Domain<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -115,7 +142,10 @@
 <p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#apiHostName">apiHostName</a></p></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="cognitoAuth" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>cognito<wbr/>Auth</span><a href="#cognitoAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">cognito<wbr/>Auth</span><span class="tsd-signature-symbol">:</span> <a href="CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">cognito<wbr/>Auth</span><span class="tsd-signature-symbol">:</span> <a href="CognitoAuthentication.html" class="tsd-signature-type tsd-kind-class">CognitoAuthentication</a></div>
+<div class="tsd-comment tsd-typography"><p>The Cognito authentication configuration.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="hostedZone" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div><aside class="tsd-sources">
@@ -129,10 +159,16 @@
 <p>Inherited from <a href="BaseApi.html">BaseApi</a>.<a href="BaseApi.html#node">node</a></p></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="props" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>props</span><a href="#props" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GraphQlApiProps.html" class="tsd-signature-type tsd-kind-interface">GraphQlApiProps</a></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GraphQlApiProps.html" class="tsd-signature-type tsd-kind-interface">GraphQlApiProps</a></div>
+<div class="tsd-comment tsd-typography"><p>The properties of the GraphQlApi construct.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member"><a id="tableDataSource" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>table<wbr/>Data<wbr/>Source</span><a href="#tableDataSource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">table<wbr/>Data<wbr/>Source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">DynamoDbDataSource</span></div></section></section>
+<div class="tsd-signature"><span class="tsd-kind-property">table<wbr/>Data<wbr/>Source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">DynamoDbDataSource</span></div>
+<div class="tsd-comment tsd-typography"><p>The optional DynamoDB data source for the GraphQL API.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="addDynamoDbJSResolver" class="tsd-anchor"></a>

package/docs/constructs/classes/LambdaFunction.html

@@ -15,6 +15,16 @@
 <li><a href="../modules.html">cdk-serverless</a></li>
 <li><a href="LambdaFunction.html">LambdaFunction</a></li></ul>
 <h1>Class LambdaFunction</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>The LambdaFunction construct extends the AWS CDK NodejsFunction to provide additional configurations and environment settings for AWS Lambda functions.
+This construct facilitates setting up a Lambda function with various custom options, environment variables, and permissions required to interact with AWS services
+such as DynamoDB, Cognito, and S3. It supports setting up Lambda functions with pre-defined bundles, custom handlers, and integrations with AWS services.
+The construct also provides methods to dynamically update the configuration and permissions of the Lambda function after it has been created.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<h4>Example</h4><pre><code class="language-ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">lambdaFunction</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">LambdaFunction</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">&#39;MyLambdaFunction&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-4">entry:</span><span class="hl-1"> </span><span class="hl-2">&#39;path/to/lambda/handler.ts&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">handler:</span><span class="hl-1"> </span><span class="hl-2">&#39;main&#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-2">&#39;dev&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">table:</span><span class="hl-1"> </span><span class="hl-4">myDynamoDBTable</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">userPool:</span><span class="hl-1"> </span><span class="hl-4">myCognitoUserPool</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">assetBucket:</span><span class="hl-1"> </span><span class="hl-4">myS3Bucket</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">lambdaOptions:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">timeout:</span><span class="hl-1"> </span><span class="hl-4">Duration</span><span class="hl-1">.</span><span class="hl-0">seconds</span><span class="hl-1">(</span><span class="hl-8">30</span><span class="hl-1">),</span><br/><span class="hl-1">    </span><span class="hl-4">memorySize:</span><span class="hl-1"> </span><span class="hl-8">512</span><span class="hl-1">,</span><br/><span class="hl-1">  },</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">// Add additional permissions</span><br/><span class="hl-4">lambdaFunction</span><span class="hl-1">.</span><span class="hl-0">grantSendEmails</span><span class="hl-1">();</span><br/><span class="hl-4">lambdaFunction</span><span class="hl-1">.</span><span class="hl-0">grantTableWrite</span><span class="hl-1">();</span>
+</code><button>Copy</button></pre>
+</div></section>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
@@ -117,16 +127,25 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="constructor.new_LambdaFunction"><span class="tsd-kind-constructor-signature">new <wbr/>Lambda<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#constructor.new_LambdaFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Creates an instance of LambdaFunction.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
+<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
+<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
+</div></li>
 <li>
-<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></h5></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4><aside class="tsd-sources">
+<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></h5>
+<div class="tsd-comment tsd-typography"><p>The properties of the LambdaFunction construct.</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Overrides lambdaNodejs.NodejsFunction.constructor</p></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
@@ -208,7 +227,10 @@ cross-environment scenarios.</li>
 <p>Inherited from lambdaNodejs.NodejsFunction.physicalName</p></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="props" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>props</span><a href="#props" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></div>
+<div class="tsd-comment tsd-typography"><p>The properties of the LambdaFunction construct.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="role" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IRole</span></div>
@@ -311,7 +333,7 @@ to never expire even if it was configured with a different value.</p>
 <div class="tsd-comment tsd-typography"><p>Defines an alias for this function.</p>
 <p>The alias will automatically be updated to point to the latest version of
 the function as it is being updated during a deployment.</p>
-<pre><code class="language-ts"><span class="hl-3">declare</span><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">fn</span><span class="hl-1">: </span><span class="hl-5">lambda</span><span class="hl-1">.</span><span class="hl-5">Function</span><span class="hl-1">;</span><br/><br/><span class="hl-6">fn</span><span class="hl-1">.</span><span class="hl-0">addAlias</span><span class="hl-1">(</span><span class="hl-2">&#39;Live&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Is equivalent to</span><br/><br/><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-6">lambda</span><span class="hl-1">.</span><span class="hl-0">Alias</span><span class="hl-1">(</span><span class="hl-3">this</span><span class="hl-1">, </span><span class="hl-2">&#39;AliasLive&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-6">aliasName:</span><span class="hl-1"> </span><span class="hl-2">&#39;Live&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-6">version:</span><span class="hl-1"> </span><span class="hl-6">fn</span><span class="hl-1">.</span><span class="hl-6">currentVersion</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
+<pre><code class="language-ts"><span class="hl-5">declare</span><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">fn</span><span class="hl-1">: </span><span class="hl-9">lambda</span><span class="hl-1">.</span><span class="hl-9">Function</span><span class="hl-1">;</span><br/><br/><span class="hl-4">fn</span><span class="hl-1">.</span><span class="hl-0">addAlias</span><span class="hl-1">(</span><span class="hl-2">&#39;Live&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-6">// Is equivalent to</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-4">lambda</span><span class="hl-1">.</span><span class="hl-0">Alias</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">&#39;AliasLive&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-4">aliasName:</span><span class="hl-1"> </span><span class="hl-2">&#39;Live&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-4">version:</span><span class="hl-1"> </span><span class="hl-4">fn</span><span class="hl-1">.</span><span class="hl-4">currentVersion</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 </div>
 <div class="tsd-parameters">
@@ -997,7 +1019,7 @@ this type-testing method instead.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">max</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
+<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">max</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <p>Inherited from lambdaNodejs.NodejsFunction.metricAllConcurrentExecutions</p></aside></li></ul></section>
@@ -1015,7 +1037,7 @@ this type-testing method instead.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">average</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
+<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">average</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <p>Inherited from lambdaNodejs.NodejsFunction.metricAllDuration</p></aside></li></ul></section>
@@ -1033,7 +1055,7 @@ this type-testing method instead.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">sum</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
+<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <p>Inherited from lambdaNodejs.NodejsFunction.metricAllErrors</p></aside></li></ul></section>
@@ -1051,7 +1073,7 @@ this type-testing method instead.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">sum</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
+<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <p>Inherited from lambdaNodejs.NodejsFunction.metricAllInvocations</p></aside></li></ul></section>
@@ -1069,7 +1091,7 @@ this type-testing method instead.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">sum</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
+<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <p>Inherited from lambdaNodejs.NodejsFunction.metricAllThrottles</p></aside></li></ul></section>
@@ -1087,7 +1109,7 @@ this type-testing method instead.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">max</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
+<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">max</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <p>Inherited from lambdaNodejs.NodejsFunction.metricAllUnreservedConcurrentExecutions</p></aside></li></ul></section></section></div>