@gradientedge/cdk-utils 4.10.1 → 4.11.0

package/dist/src/lib/common/construct.d.ts

@@ -44,6 +44,7 @@ export declare class CommonConstruct extends Construct {
     ssMManager: aws.SsmManager;
     vpcManager: aws.VpcManager;
     wafManager: aws.WafManager;
+    sqsManager: aws.SqsManager;
     fullyQualifiedDomainName: string;
     constructor(parent: Construct, id: string, props: types.CommonStackProps);
     /**

package/dist/src/lib/common/construct.js

@@ -69,6 +69,7 @@ class CommonConstruct extends constructs_1.Construct {
     ssMManager;
     vpcManager;
     wafManager;
+    sqsManager;
     fullyQualifiedDomainName;
     constructor(parent, id, props) {
         super(parent, id);
@@ -97,6 +98,7 @@ class CommonConstruct extends constructs_1.Construct {
         this.ssMManager = new aws.SsmManager();
         this.vpcManager = new aws.VpcManager();
         this.wafManager = new aws.WafManager();
+        this.sqsManager = new aws.SqsManager();
         this.determineFullyQualifiedDomain();
     }
     /**

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

@@ -1,8 +1,10 @@
 import * as cdk from 'aws-cdk-lib';
 import * as ecs from 'aws-cdk-lib/aws-ecs';
+import * as events from 'aws-cdk-lib/aws-events';
 import * as iam from 'aws-cdk-lib/aws-iam';
 import * as logs from 'aws-cdk-lib/aws-logs';
 import * as s3 from 'aws-cdk-lib/aws-s3';
+import * as sqs from 'aws-cdk-lib/aws-sqs';
 import * as common from '../../common';
 /**
  * @stability stable
@@ -151,4 +153,11 @@ export declare class IamManager {
      * @param {iam.ServicePrincipal} servicePrinicpal
      */
     createRoleForLambda(id: string, scope: common.CommonConstruct, policy: iam.PolicyDocument, servicePrinicpal?: iam.ServicePrincipal): cdk.aws_iam.Role;
+    /**
+     * @summary Method to create iam policy for sqs
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {iam.ServicePrincipal} servicePrinicpal
+     */
+    createPolicyForSqsEvent(id: string, scope: common.CommonConstruct, sqsQueue: sqs.Queue, eventBridgeRule: events.IRule, servicePrincipals?: iam.ServicePrincipal[]): cdk.aws_iam.PolicyDocument;
 }

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

@@ -380,5 +380,29 @@ class IamManager {
         utils.createCfnOutput(`${id}Name`, scope, role.roleName);
         return role;
     }
+    /**
+     * @summary Method to create iam policy for sqs
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {iam.ServicePrincipal} servicePrinicpal
+     */
+    createPolicyForSqsEvent(id, scope, sqsQueue, eventBridgeRule, servicePrincipals) {
+        const policy = new iam.PolicyDocument({
+            statements: [
+                new iam.PolicyStatement({
+                    actions: ['sqs:*'],
+                    effect: iam.Effect.ALLOW,
+                    conditions: {
+                        ArnEquals: {
+                            'aws:SourceArn': eventBridgeRule,
+                        },
+                    },
+                    principals: servicePrincipals ?? [new iam.ServicePrincipal('events.amazonaws.com')],
+                    resources: [sqsQueue.queueArn],
+                }),
+            ],
+        });
+        return policy;
+    }
 }
 exports.IamManager = IamManager;

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

@@ -19,6 +19,7 @@ export * from './route53-manager';
 export * from './s3-manager';
 export * from './secrets-manager';
 export * from './sns-manager';
+export * from './sqs-manager';
 export * from './ssm-manager';
 export * from './vpc-manager';
 export * from './waf-manager';

package/dist/src/lib/manager/aws/index.js

@@ -35,6 +35,7 @@ __exportStar(require("./route53-manager"), exports);
 __exportStar(require("./s3-manager"), exports);
 __exportStar(require("./secrets-manager"), exports);
 __exportStar(require("./sns-manager"), exports);
+__exportStar(require("./sqs-manager"), exports);
 __exportStar(require("./ssm-manager"), exports);
 __exportStar(require("./vpc-manager"), exports);
 __exportStar(require("./waf-manager"), exports);

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

@@ -0,0 +1,34 @@
+import * as cdk from 'aws-cdk-lib';
+import * as sqs from 'aws-cdk-lib/aws-sqs';
+import * as common from '../../common';
+import * as types from '../../types';
+/**
+ * @stability stable
+ * @category cdk-utils.sqs-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Simple Queue Service.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * @example
+ * import * as common from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends common.common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.sqsManager.createSqsQueue('MySqs', this)
+ *   }
+ * }
+ *
+ * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
+ */
+export declare class SqsManager {
+    /**
+     * @summary Method to create a lambda queue service
+     * @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
+     */
+    createQueueService(id: string, scope: common.CommonConstruct, props: types.QueueProps, deadLetterQueue?: sqs.DeadLetterQueue): cdk.aws_sqs.Queue;
+}

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

@@ -0,0 +1,84 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqsManager = void 0;
+const cdk = __importStar(require("aws-cdk-lib"));
+const sqs = __importStar(require("aws-cdk-lib/aws-sqs"));
+const utils = __importStar(require("../../utils"));
+/**
+ * @stability stable
+ * @category cdk-utils.sqs-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Simple Queue Service.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * @example
+ * import * as common from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends common.common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.sqsManager.createSqsQueue('MySqs', this)
+ *   }
+ * }
+ *
+ * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
+ */
+class SqsManager {
+    /**
+     * @summary Method to create a lambda queue service
+     * @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
+     */
+    createQueueService(id, scope, props, deadLetterQueue) {
+        if (!props)
+            throw `Queue props undefined`;
+        const queue = new sqs.Queue(scope, id, {
+            queueName: props.queueName,
+            visibilityTimeout: cdk.Duration.seconds(props.visibilityTimeoutInSecs),
+            receiveMessageWaitTime: cdk.Duration.seconds(props.receiveMessageWaitTimeInSecs),
+            contentBasedDeduplication: props.contentBasedDeduplication,
+            dataKeyReuse: cdk.Duration.seconds(props.dataKeyReuseInSecs),
+            deadLetterQueue: deadLetterQueue,
+            deduplicationScope: props.deduplicationScope,
+            deliveryDelay: cdk.Duration.seconds(props.deliveryDelayInSecs),
+            encryption: props.encryption,
+            encryptionMasterKey: props.encryptionMasterKey,
+            fifo: props.fifo,
+            fifoThroughputLimit: props.fifoThroughputLimit,
+            maxMessageSizeBytes: props.maxMessageSizeBytes,
+            removalPolicy: props.removalPolicy,
+            retentionPeriod: props.retentionPeriod,
+        });
+        utils.createCfnOutput(`${id}-queueArn`, scope, queue.queueArn);
+        utils.createCfnOutput(`${id}-queueName`, scope, queue.queueName);
+        utils.createCfnOutput(`${id}-queueUrl`, scope, queue.queueUrl);
+        return queue;
+    }
+}
+exports.SqsManager = SqsManager;

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

@@ -22,6 +22,7 @@ import * as route53 from 'aws-cdk-lib/aws-route53';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
 import * as sns from 'aws-cdk-lib/aws-sns';
+import * as sqs from 'aws-cdk-lib/aws-sqs';
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2';
 import * as types from '../index';
 /**
@@ -510,4 +511,14 @@ export interface WafWebACLProps extends wafv2.CfnWebACLProps {
  */
 export interface ElastiCacheProps extends elasticache.CfnCacheClusterProps {
 }
+/**
+ * @category cdk-utils.sqs-manager
+ * @subcategory Properties
+ */
+export interface QueueProps extends sqs.QueueProps {
+    visibilityTimeoutInSecs: number;
+    receiveMessageWaitTimeInSecs: number;
+    dataKeyReuseInSecs: number;
+    deliveryDelayInSecs: number;
+}
 export {};

package/package.json

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

package/src/lib/common/construct.ts

@@ -46,6 +46,8 @@ export class CommonConstruct extends Construct {
   ssMManager: aws.SsmManager
   vpcManager: aws.VpcManager
   wafManager: aws.WafManager
+  sqsManager: aws.SqsManager
+
   fullyQualifiedDomainName: string
 
   constructor(parent: Construct, id: string, props: types.CommonStackProps) {
@@ -75,6 +77,7 @@ export class CommonConstruct extends Construct {
     this.ssMManager = new aws.SsmManager()
     this.vpcManager = new aws.VpcManager()
     this.wafManager = new aws.WafManager()
+    this.sqsManager = new aws.SqsManager()
 
     this.determineFullyQualifiedDomain()
   }

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

@@ -81,6 +81,7 @@ export class EventManager {
 
     return rule
   }
+
   /**
    * @summary Method to create an eventbridge rule with lambda target
    * @param {string} id scoped id of the resource

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

@@ -1,8 +1,10 @@
 import * as cdk from 'aws-cdk-lib'
 import * as ecs from 'aws-cdk-lib/aws-ecs'
+import * as events from 'aws-cdk-lib/aws-events'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as logs from 'aws-cdk-lib/aws-logs'
 import * as s3 from 'aws-cdk-lib/aws-s3'
+import * as sqs from 'aws-cdk-lib/aws-sqs'
 import * as common from '../../common'
 import * as utils from '../../utils'
 
@@ -412,4 +414,36 @@ export class IamManager {
 
     return role
   }
+
+  /**
+   * @summary Method to create iam policy for sqs
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {iam.ServicePrincipal} servicePrinicpal
+   */
+  public createPolicyForSqsEvent(
+    id: string,
+    scope: common.CommonConstruct,
+    sqsQueue: sqs.Queue,
+    eventBridgeRule: events.IRule,
+    servicePrincipals?: iam.ServicePrincipal[]
+  ) {
+    const policy = new iam.PolicyDocument({
+      statements: [
+        new iam.PolicyStatement({
+          actions: ['sqs:*'],
+          effect: iam.Effect.ALLOW,
+          conditions: {
+            ArnEquals: {
+              'aws:SourceArn': eventBridgeRule,
+            },
+          },
+          principals: servicePrincipals ?? [new iam.ServicePrincipal('events.amazonaws.com')],
+          resources: [sqsQueue.queueArn],
+        }),
+      ],
+    })
+
+    return policy
+  }
 }

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

@@ -19,6 +19,7 @@ export * from './route53-manager'
 export * from './s3-manager'
 export * from './secrets-manager'
 export * from './sns-manager'
+export * from './sqs-manager'
 export * from './ssm-manager'
 export * from './vpc-manager'
 export * from './waf-manager'

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

@@ -0,0 +1,67 @@
+import * as cdk from 'aws-cdk-lib'
+import * as sqs from 'aws-cdk-lib/aws-sqs'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
+
+/**
+ * @stability stable
+ * @category cdk-utils.sqs-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Simple Queue Service.
+ * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
+ * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
+ * @example
+ * import * as common from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends common.common.CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.sqsManager.createSqsQueue('MySqs', this)
+ *   }
+ * }
+ *
+ * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
+ */
+export class SqsManager {
+  /**
+   * @summary Method to create a lambda queue service
+   * @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
+   */
+  public createQueueService(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.QueueProps,
+    deadLetterQueue?: sqs.DeadLetterQueue
+  ) {
+    if (!props) throw `Queue props undefined`
+
+    const queue = new sqs.Queue(scope, id, {
+      queueName: props.queueName,
+      visibilityTimeout: cdk.Duration.seconds(props.visibilityTimeoutInSecs),
+      receiveMessageWaitTime: cdk.Duration.seconds(props.receiveMessageWaitTimeInSecs),
+      contentBasedDeduplication: props.contentBasedDeduplication,
+      dataKeyReuse: cdk.Duration.seconds(props.dataKeyReuseInSecs),
+      deadLetterQueue: deadLetterQueue,
+      deduplicationScope: props.deduplicationScope,
+      deliveryDelay: cdk.Duration.seconds(props.deliveryDelayInSecs),
+      encryption: props.encryption,
+      encryptionMasterKey: props.encryptionMasterKey,
+      fifo: props.fifo,
+      fifoThroughputLimit: props.fifoThroughputLimit,
+      maxMessageSizeBytes: props.maxMessageSizeBytes,
+      removalPolicy: props.removalPolicy,
+      retentionPeriod: props.retentionPeriod,
+    })
+
+    utils.createCfnOutput(`${id}-queueArn`, scope, queue.queueArn)
+    utils.createCfnOutput(`${id}-queueName`, scope, queue.queueName)
+    utils.createCfnOutput(`${id}-queueUrl`, scope, queue.queueUrl)
+
+    return queue
+  }
+}

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

@@ -22,6 +22,7 @@ import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
 import * as sns from 'aws-cdk-lib/aws-sns'
+import * as sqs from 'aws-cdk-lib/aws-sqs'
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
 import * as types from '../index'
 
@@ -540,3 +541,14 @@ export interface WafWebACLProps extends wafv2.CfnWebACLProps {}
  * @category Compute
  */
 export interface ElastiCacheProps extends elasticache.CfnCacheClusterProps {}
+
+/**
+ * @category cdk-utils.sqs-manager
+ * @subcategory Properties
+ */
+export interface QueueProps extends sqs.QueueProps {
+  visibilityTimeoutInSecs: number
+  receiveMessageWaitTimeInSecs: number
+  dataKeyReuseInSecs: number
+  deliveryDelayInSecs: number
+}