@gradientedge/cdk-utils 4.9.6 → 4.11.0

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

@@ -14,6 +14,7 @@ import * as elasticache from 'aws-cdk-lib/aws-elasticache'
 import * as elb from 'aws-cdk-lib/aws-elasticloadbalancingv2'
 import * as events from 'aws-cdk-lib/aws-events'
 import * as iam from 'aws-cdk-lib/aws-iam'
+import * as kms from 'aws-cdk-lib/aws-kms'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as destinations from 'aws-cdk-lib/aws-lambda-destinations'
 import * as logs from 'aws-cdk-lib/aws-logs'
@@ -21,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'
 
@@ -108,6 +110,12 @@ export interface HealthCheck extends elb.HealthCheck {
   timeoutInSecs: number
 }
 
+/**
+ * @category cdk-utils.kms-manager
+ * @subcategory Properties
+ */
+export interface KmsKeyProps extends kms.KeyProps {}
+
 /**
  * @category cdk-utils.lambda-manager
  * @subcategory Types
@@ -533,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
+}