added new feature to readme

aws · Mar 5, 2024 · 047800e · 047800e
1 parent 4c1b157
commit 047800e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/packages/aws-cdk-lib/aws-lambda-nodejs/README.md b/packages/aws-cdk-lib/aws-lambda-nodejs/README.md
@@ -168,6 +168,16 @@ new nodejs.NodejsFunction(this, 'my-handler', {
   },
 });
 ```
+Includes AWS SDK in the bundle asset by setting `bundleAwsSDK` to `true`. This will be essentially exclude sdk from the external 
+module and not be resolved to the Lambda provided sdk.
+
+```ts
+new nodejs.NodejsFunction(this, 'my-handler', {
+  bundling: {
+    bundleAwsSDK: true,
+  },
+});
+```
 
 ### Install modules
 

diff --git a/packages/aws-cdk-lib/aws-lambda-nodejs/lib/types.ts b/packages/aws-cdk-lib/aws-lambda-nodejs/lib/types.ts
@@ -185,7 +185,7 @@ export interface BundlingOptions extends DockerRunOptions {
    *
    * @default - false
    * if `true` the `aws-sdk` will be included in the asset bundle and not be
-   * resolved to the Lambda provided bundle.
+   * resolved to the Lambda provided sdk.
    */
   readonly bundleAwsSDK?: boolean;