@gradientedge/cdk-utils 5.5.0 → 5.6.0

package/dist/src/lib/manager/aws/lambda-manager.js

@@ -87,6 +87,11 @@ class LambdaManager {
         if (!props)
             throw `Lambda props undefined`;
         const functionName = `${props.functionName}-${scope.props.stage}`;
+        let deadLetterQueue;
+        if (props.deadLetterQueueEnabled && props.dlq) {
+            const redriveQueue = scope.sqsManager.createRedriveQueueForLambda(`${id}-rdq`, scope, props);
+            deadLetterQueue = scope.sqsManager.createDeadLetterQueueForLambda(`${id}-dlq`, scope, props, redriveQueue);
+        }
         const lambdaFunction = new lambda.Function(scope, `${id}`, {
             ...props,
             ...{
@@ -95,6 +100,7 @@ class LambdaManager {
                 handler: handler || 'index.lambda_handler',
                 runtime: LambdaManager.NODEJS_RUNTIME,
                 code: code,
+                deadLetterQueue: deadLetterQueue,
                 environment: {
                     REGION: scope.props.region,
                     ...environment,

package/dist/src/lib/manager/aws/sqs-manager.d.ts

@@ -16,7 +16,7 @@ import * as types from '../../types';
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
- *     this.sqsManager.createSqsQueue('MySqs', this)
+ *     this.sqsManager.createQueue('MySqs', this, {...})
  *   }
  * }
  *
@@ -28,7 +28,22 @@ export declare class SqsManager {
      * @param {string} id scoped id of the resource
      * @param {common.CommonConstruct} scope scope in which this resource is defined
      * @param {types.QueueProps} props
-     * @param {sqs.deadLetterQueue} deadLetterQueue
+     * @param {sqs.IQueue} deadLetterQueue
      */
-    createQueueService(id: string, scope: common.CommonConstruct, props: types.QueueProps, deadLetterQueue?: sqs.DeadLetterQueue): cdk.aws_sqs.Queue;
+    createQueue(id: string, scope: common.CommonConstruct, props: types.QueueProps, deadLetterQueue?: sqs.IQueue): cdk.aws_sqs.Queue;
+    /**
+     * @summary Method to create a redrive queue for a lambda function
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaProps} props the lambda properties
+     */
+    createRedriveQueueForLambda(id: string, scope: common.CommonConstruct, props: types.LambdaProps): cdk.aws_sqs.Queue;
+    /**
+     * @summary Method to create a dead letter queue for a lambda function
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaProps} props the lambda properties
+     * @param {sqs.IQueue} deadLetterQueue
+     */
+    createDeadLetterQueueForLambda(id: string, scope: common.CommonConstruct, props: types.LambdaProps, deadLetterQueue: sqs.IQueue): cdk.aws_sqs.Queue;
 }

package/dist/src/lib/manager/aws/sqs-manager.js

@@ -41,7 +41,7 @@ const utils = __importStar(require("../../utils"));
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
- *     this.sqsManager.createSqsQueue('MySqs', this)
+ *     this.sqsManager.createQueue('MySqs', this, {...})
  *   }
  * }
  *
@@ -53,9 +53,9 @@ class SqsManager {
      * @param {string} id scoped id of the resource
      * @param {common.CommonConstruct} scope scope in which this resource is defined
      * @param {types.QueueProps} props
-     * @param {sqs.deadLetterQueue} deadLetterQueue
+     * @param {sqs.IQueue} deadLetterQueue
      */
-    createQueueService(id, scope, props, deadLetterQueue) {
+    createQueue(id, scope, props, deadLetterQueue) {
         if (!props)
             throw `Queue props undefined`;
         const queue = new sqs.Queue(scope, id, {
@@ -64,7 +64,12 @@ class SqsManager {
             receiveMessageWaitTime: cdk.Duration.seconds(props.receiveMessageWaitTimeInSecs),
             contentBasedDeduplication: props.contentBasedDeduplication,
             dataKeyReuse: cdk.Duration.seconds(props.dataKeyReuseInSecs),
-            deadLetterQueue: deadLetterQueue,
+            deadLetterQueue: !deadLetterQueue
+                ? undefined
+                : {
+                    queue: deadLetterQueue,
+                    maxReceiveCount: props.maxReceiveCount,
+                },
             deduplicationScope: props.deduplicationScope,
             deliveryDelay: cdk.Duration.seconds(props.deliveryDelayInSecs),
             encryption: props.encryption,
@@ -72,13 +77,47 @@ class SqsManager {
             fifo: props.fifo,
             fifoThroughputLimit: props.fifoThroughputLimit,
             maxMessageSizeBytes: props.maxMessageSizeBytes,
-            removalPolicy: props.removalPolicy,
-            retentionPeriod: props.retentionPeriod,
+            removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
+            retentionPeriod: cdk.Duration.days(props.retentionInDays),
         });
         utils.createCfnOutput(`${id}-queueArn`, scope, queue.queueArn);
         utils.createCfnOutput(`${id}-queueName`, scope, queue.queueName);
         utils.createCfnOutput(`${id}-queueUrl`, scope, queue.queueUrl);
         return queue;
     }
+    /**
+     * @summary Method to create a redrive queue for a lambda function
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaProps} props the lambda properties
+     */
+    createRedriveQueueForLambda(id, scope, props) {
+        if (!props.dlq || !props.redriveq)
+            throw `Redrive queue props for Lambda undefined`;
+        return this.createQueue(`${id}`, scope, {
+            ...props.dlq,
+            ...props.redriveq,
+            ...{
+                queueName: `${props.functionName}-redriveq-${scope.props.stage}`,
+            },
+        });
+    }
+    /**
+     * @summary Method to create a dead letter queue for a lambda function
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaProps} props the lambda properties
+     * @param {sqs.IQueue} deadLetterQueue
+     */
+    createDeadLetterQueueForLambda(id, scope, props, deadLetterQueue) {
+        if (!props.dlq)
+            throw `Dead letter queue props for Lambda undefined`;
+        return this.createQueue(`${id}`, scope, {
+            ...props.dlq,
+            ...{
+                queueName: `${props.functionName}-dlq-${scope.props.stage}`,
+            },
+        }, deadLetterQueue);
+    }
 }
 exports.SqsManager = SqsManager;

package/dist/src/lib/types/aws/index.d.ts

@@ -491,6 +491,8 @@ export interface EventBusProps extends events.EventBusProps {
  * @subcategory Properties
  */
 export interface LambdaProps extends lambda.FunctionProps {
+    dlq?: QueueProps;
+    redriveq?: QueueProps;
     timeoutInSecs?: number;
 }
 /**
@@ -575,9 +577,11 @@ export interface ElastiCacheProps extends elasticache.CfnCacheClusterProps {
  * @subcategory Properties
  */
 export interface QueueProps extends sqs.QueueProps {
+    maxReceiveCount: number;
     visibilityTimeoutInSecs: number;
     receiveMessageWaitTimeInSecs: number;
     dataKeyReuseInSecs: number;
     deliveryDelayInSecs: number;
+    retentionInDays: number;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "5.5.0",
+  "version": "5.6.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

package/src/lib/manager/aws/lambda-manager.ts

@@ -30,6 +30,7 @@ import { CloudFrontManager } from './cloudfront-manager'
  */
 export class LambdaManager {
   public static NODEJS_RUNTIME = lambda.Runtime.NODEJS_16_X
+
   /**
    * @summary Method to create a lambda layer (nodejs)
    * @param {string} id scoped id of the resource
@@ -83,6 +84,13 @@ export class LambdaManager {
     if (!props) throw `Lambda props undefined`
 
     const functionName = `${props.functionName}-${scope.props.stage}`
+
+    let deadLetterQueue
+    if (props.deadLetterQueueEnabled && props.dlq) {
+      const redriveQueue = scope.sqsManager.createRedriveQueueForLambda(`${id}-rdq`, scope, props)
+      deadLetterQueue = scope.sqsManager.createDeadLetterQueueForLambda(`${id}-dlq`, scope, props, redriveQueue)
+    }
+
     const lambdaFunction = new lambda.Function(scope, `${id}`, {
       ...props,
       ...{
@@ -91,6 +99,7 @@ export class LambdaManager {
         handler: handler || 'index.lambda_handler',
         runtime: LambdaManager.NODEJS_RUNTIME,
         code: code,
+        deadLetterQueue: deadLetterQueue,
         environment: {
           REGION: scope.props.region,
           ...environment,

package/src/lib/manager/aws/sqs-manager.ts

@@ -18,7 +18,7 @@ import * as utils from '../../utils'
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
- *     this.sqsManager.createSqsQueue('MySqs', this)
+ *     this.sqsManager.createQueue('MySqs', this, {...})
  *   }
  * }
  *
@@ -30,14 +30,9 @@ export class SqsManager {
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {types.QueueProps} props
-   * @param {sqs.deadLetterQueue} deadLetterQueue
+   * @param {sqs.IQueue} deadLetterQueue
    */
-  public createQueueService(
-    id: string,
-    scope: common.CommonConstruct,
-    props: types.QueueProps,
-    deadLetterQueue?: sqs.DeadLetterQueue
-  ) {
+  public createQueue(id: string, scope: common.CommonConstruct, props: types.QueueProps, deadLetterQueue?: sqs.IQueue) {
     if (!props) throw `Queue props undefined`
 
     const queue = new sqs.Queue(scope, id, {
@@ -46,7 +41,12 @@ export class SqsManager {
       receiveMessageWaitTime: cdk.Duration.seconds(props.receiveMessageWaitTimeInSecs),
       contentBasedDeduplication: props.contentBasedDeduplication,
       dataKeyReuse: cdk.Duration.seconds(props.dataKeyReuseInSecs),
-      deadLetterQueue: deadLetterQueue,
+      deadLetterQueue: !deadLetterQueue
+        ? undefined
+        : {
+            queue: deadLetterQueue,
+            maxReceiveCount: props.maxReceiveCount,
+          },
       deduplicationScope: props.deduplicationScope,
       deliveryDelay: cdk.Duration.seconds(props.deliveryDelayInSecs),
       encryption: props.encryption,
@@ -54,8 +54,8 @@ export class SqsManager {
       fifo: props.fifo,
       fifoThroughputLimit: props.fifoThroughputLimit,
       maxMessageSizeBytes: props.maxMessageSizeBytes,
-      removalPolicy: props.removalPolicy,
-      retentionPeriod: props.retentionPeriod,
+      removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
+      retentionPeriod: cdk.Duration.days(props.retentionInDays),
     })
 
     utils.createCfnOutput(`${id}-queueArn`, scope, queue.queueArn)
@@ -64,4 +64,50 @@ export class SqsManager {
 
     return queue
   }
+
+  /**
+   * @summary Method to create a redrive queue for a lambda function
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaProps} props the lambda properties
+   */
+  public createRedriveQueueForLambda(id: string, scope: common.CommonConstruct, props: types.LambdaProps) {
+    if (!props.dlq || !props.redriveq) throw `Redrive queue props for Lambda undefined`
+
+    return this.createQueue(`${id}`, scope, {
+      ...props.dlq,
+      ...props.redriveq,
+      ...{
+        queueName: `${props.functionName}-redriveq-${scope.props.stage}`,
+      },
+    })
+  }
+
+  /**
+   * @summary Method to create a dead letter queue for a lambda function
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaProps} props the lambda properties
+   * @param {sqs.IQueue} deadLetterQueue
+   */
+  public createDeadLetterQueueForLambda(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.LambdaProps,
+    deadLetterQueue: sqs.IQueue
+  ) {
+    if (!props.dlq) throw `Dead letter queue props for Lambda undefined`
+
+    return this.createQueue(
+      `${id}`,
+      scope,
+      {
+        ...props.dlq,
+        ...{
+          queueName: `${props.functionName}-dlq-${scope.props.stage}`,
+        },
+      },
+      deadLetterQueue
+    )
+  }
 }

package/src/lib/types/aws/index.ts

@@ -524,6 +524,8 @@ export interface EventBusProps extends events.EventBusProps {}
  * @subcategory Properties
  */
 export interface LambdaProps extends lambda.FunctionProps {
+  dlq?: QueueProps
+  redriveq?: QueueProps
   timeoutInSecs?: number
 }
 
@@ -614,8 +616,10 @@ export interface ElastiCacheProps extends elasticache.CfnCacheClusterProps {}
  * @subcategory Properties
  */
 export interface QueueProps extends sqs.QueueProps {
+  maxReceiveCount: number
   visibilityTimeoutInSecs: number
   receiveMessageWaitTimeInSecs: number
   dataKeyReuseInSecs: number
   deliveryDelayInSecs: number
+  retentionInDays: number
 }