@gradientedge/cdk-utils 8.57.0 → 8.58.0

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

@@ -4,6 +4,9 @@ import * as iam from 'aws-cdk-lib/aws-iam';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
 import * as common from '../../common';
 import * as types from '../../types';
+import * as cdk from 'aws-cdk-lib';
+import * as sqs from 'aws-cdk-lib/aws-sqs';
+import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
 /**
  * @stability stable
  * @category cdk-utils.event-manager
@@ -64,4 +67,13 @@ export declare class EventManager {
      * @param {any} eventPattern
      */
     createFargateTaskRule(id: string, scope: common.CommonConstruct, props: types.RuleProps, cluster: ecs.ICluster, task: ecs.ITaskDefinition, subnetIds: string[], role: iam.Role | iam.CfnRole, eventPattern?: any): events.CfnRule;
+    /**
+     * @summary Method to create an eventbridge pipe with sqs queue as source and step function as target
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param props the props for the pipe
+     * @param sourceQueue the source sqs queue
+     * @param targetStepFunction the target step function
+     */
+    createSqsToSfnCfnPipe(id: string, scope: common.CommonConstruct, props: types.SqsToSfnPipeProps, sourceQueue: sqs.IQueue, targetStepFunction: sfn.IStateMachine): cdk.aws_pipes.CfnPipe;
 }

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

@@ -29,6 +29,7 @@ const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const lambda = __importStar(require("aws-cdk-lib/aws-lambda"));
 const utils = __importStar(require("../../utils"));
 const cdk = __importStar(require("aws-cdk-lib"));
+const pipes = __importStar(require("aws-cdk-lib/aws-pipes"));
 /**
  * @stability stable
  * @category cdk-utils.event-manager
@@ -170,5 +171,50 @@ class EventManager {
         utils.createCfnOutput(`${id}-ruleName`, scope, eventRule.name);
         return eventRule;
     }
+    /**
+     * @summary Method to create an eventbridge pipe with sqs queue as source and step function as target
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param props the props for the pipe
+     * @param sourceQueue the source sqs queue
+     * @param targetStepFunction the target step function
+     */
+    createSqsToSfnCfnPipe(id, scope, props, sourceQueue, targetStepFunction) {
+        const pipeRole = scope.iamManager.createRoleForSqsToSfnPipe(`${id}-role`, scope, sourceQueue.queueArn, targetStepFunction.stateMachineArn);
+        const pipe = new pipes.CfnPipe(scope, `${id}`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            description: '',
+            source: sourceQueue.queueArn,
+            sourceParameters: {
+                filterCriteria: props.pipeFilterPattern
+                    ? {
+                        filters: [
+                            {
+                                pattern: JSON.stringify(props.pipeFilterPattern),
+                            },
+                        ],
+                    }
+                    : undefined,
+                sqsQueueParameters: {
+                    batchSize: props.sqsBatchSize,
+                    maximumBatchingWindowInSeconds: props.sqsMaximumBatchingWindowInSeconds,
+                },
+            },
+            target: targetStepFunction.stateMachineArn,
+            targetParameters: {
+                inputTemplate: props.sfnInputTemplate,
+                stepFunctionStateMachineParameters: {
+                    invocationType: props.sfnInvocationType ?? 'FIRE_AND_FORGET',
+                },
+            },
+            enrichment: props.enrichment,
+            enrichmentParameters: props.enrichmentParameters,
+            roleArn: pipeRole.roleArn,
+        });
+        utils.createCfnOutput(`${id}-pipeArn`, scope, pipe.attrArn);
+        utils.createCfnOutput(`${id}-pipeName`, scope, pipe.name);
+        return pipe;
+    }
 }
 exports.EventManager = EventManager;

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

@@ -38,6 +38,16 @@ export declare class IamManager {
      * @param {string[]} resourceArns list of ARNs to allow access to
      */
     statementForPutEvents(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    /**
+     * @summary Method to create iam statement to start stepfunction execution
+     * @param {string[]} resourceArns list of ARNs to allow access to
+     */
+    statementForStartExecution(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    /**
+     * @summary Method to create iam statement to poll queue
+     * @param {string[]} resourceArns list of ARNs to allow access to
+     */
+    statementForPollQueue(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
     /**
      * @summary Method to create iam statement to invoke lambda function
      * @param {string[]} resourceArns list of ARNs to allow access to
@@ -189,6 +199,14 @@ export declare class IamManager {
      * @param {iam.ServicePrincipal} servicePrinicpal
      */
     createRoleForStepFunction(id: string, scope: common.CommonConstruct, policy: iam.PolicyDocument, servicePrinicpal?: iam.ServicePrincipal): cdk.aws_iam.Role;
+    /**
+     * @summary Method to create iam statement for sqs to step function pipe
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {string} queueArn the arn of the sqs queue
+     * @param {string} stepFunctionArn the arn of the step function
+     */
+    createRoleForSqsToSfnPipe(id: string, scope: common.CommonConstruct, queueArn: string, stepFunctionArn: string): cdk.aws_iam.Role;
     /**
      * @summary Method to create iam policy for sqs
      * @param {string} id scoped id of the resource

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

@@ -73,6 +73,28 @@ class IamManager {
             resources: resourceArns ?? ['*'],
         });
     }
+    /**
+     * @summary Method to create iam statement to start stepfunction execution
+     * @param {string[]} resourceArns list of ARNs to allow access to
+     */
+    statementForStartExecution(resourceArns) {
+        return new iam.PolicyStatement({
+            effect: iam.Effect.ALLOW,
+            actions: ['states:StartExecution'],
+            resources: resourceArns ?? ['*'],
+        });
+    }
+    /**
+     * @summary Method to create iam statement to poll queue
+     * @param {string[]} resourceArns list of ARNs to allow access to
+     */
+    statementForPollQueue(resourceArns) {
+        return new iam.PolicyStatement({
+            effect: iam.Effect.ALLOW,
+            actions: ['sqs:ReceiveMessage', 'sqs:DeleteMessage', 'sqs:GetQueueAttributes'],
+            resources: resourceArns ?? ['*'],
+        });
+    }
     /**
      * @summary Method to create iam statement to invoke lambda function
      * @param {string[]} resourceArns list of ARNs to allow access to
@@ -458,6 +480,25 @@ class IamManager {
         utils.createCfnOutput(`${id}Name`, scope, role.roleName);
         return role;
     }
+    /**
+     * @summary Method to create iam statement for sqs to step function pipe
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {string} queueArn the arn of the sqs queue
+     * @param {string} stepFunctionArn the arn of the step function
+     */
+    createRoleForSqsToSfnPipe(id, scope, queueArn, stepFunctionArn) {
+        const role = new iam.Role(scope, `${id}`, {
+            assumedBy: new iam.ServicePrincipal('pipes.amazonaws.com'),
+            description: `Role for ${id} Pipe`,
+            roleName: `${id}-${scope.props.stage}`,
+        });
+        role.addToPolicy(this.statementForPollQueue([queueArn]));
+        role.addToPolicy(this.statementForStartExecution([stepFunctionArn]));
+        utils.createCfnOutput(`${id}Arn`, scope, role.roleArn);
+        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

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

@@ -29,6 +29,7 @@ import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2';
 import * as types from '../index';
 import * as appAutoscaling from 'aws-cdk-lib/aws-applicationautoscaling';
+import * as pipes from 'aws-cdk-lib/aws-pipes';
 /**
  * @category cdk-utils.app-config-manager
  * @subcategory Properties
@@ -660,6 +661,17 @@ export interface EksClusterProps extends eks.ClusterProps {
 export interface RuleProps extends events.CfnRuleProps {
     input?: string;
 }
+/**
+ * @category cdk-utils.event-manager
+ * @subcategory Properties
+ */
+export interface SqsToSfnPipeProps extends pipes.CfnPipeProps {
+    pipeFilterPattern?: any;
+    sqsBatchSize?: number;
+    sqsMaximumBatchingWindowInSeconds?: number;
+    sfnInvocationType?: string;
+    sfnInputTemplate?: string;
+}
 /**
  * @category cdk-utils.event-manager
  * @subcategory Properties

package/package.json

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

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

@@ -6,6 +6,9 @@ import * as common from '../../common'
 import * as types from '../../types'
 import * as utils from '../../utils'
 import * as cdk from 'aws-cdk-lib'
+import * as pipes from 'aws-cdk-lib/aws-pipes'
+import * as sqs from 'aws-cdk-lib/aws-sqs'
+import * as sfn from 'aws-cdk-lib/aws-stepfunctions'
 
 /**
  * @stability stable
@@ -185,4 +188,64 @@ export class EventManager {
 
     return eventRule
   }
+
+  /**
+   * @summary Method to create an eventbridge pipe with sqs queue as source and step function as target
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param props the props for the pipe
+   * @param sourceQueue the source sqs queue
+   * @param targetStepFunction the target step function
+   */
+  public createSqsToSfnCfnPipe(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.SqsToSfnPipeProps,
+    sourceQueue: sqs.IQueue,
+    targetStepFunction: sfn.IStateMachine
+  ) {
+    const pipeRole = scope.iamManager.createRoleForSqsToSfnPipe(
+      `${id}-role`,
+      scope,
+      sourceQueue.queueArn,
+      targetStepFunction.stateMachineArn
+    )
+
+    const pipe = new pipes.CfnPipe(scope, `${id}`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      description: '',
+      source: sourceQueue.queueArn,
+      sourceParameters: {
+        filterCriteria: props.pipeFilterPattern
+          ? {
+              filters: [
+                {
+                  pattern: JSON.stringify(props.pipeFilterPattern),
+                },
+              ],
+            }
+          : undefined,
+        sqsQueueParameters: {
+          batchSize: props.sqsBatchSize,
+          maximumBatchingWindowInSeconds: props.sqsMaximumBatchingWindowInSeconds,
+        },
+      },
+      target: targetStepFunction.stateMachineArn,
+      targetParameters: {
+        inputTemplate: props.sfnInputTemplate,
+        stepFunctionStateMachineParameters: {
+          invocationType: props.sfnInvocationType ?? 'FIRE_AND_FORGET',
+        },
+      },
+      enrichment: props.enrichment,
+      enrichmentParameters: props.enrichmentParameters,
+      roleArn: pipeRole.roleArn,
+    })
+
+    utils.createCfnOutput(`${id}-pipeArn`, scope, pipe.attrArn)
+    utils.createCfnOutput(`${id}-pipeName`, scope, pipe.name)
+
+    return pipe
+  }
 }

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

@@ -56,6 +56,30 @@ export class IamManager {
     })
   }
 
+  /**
+   * @summary Method to create iam statement to start stepfunction execution
+   * @param {string[]} resourceArns list of ARNs to allow access to
+   */
+  public statementForStartExecution(resourceArns?: string[]) {
+    return new iam.PolicyStatement({
+      effect: iam.Effect.ALLOW,
+      actions: ['states:StartExecution'],
+      resources: resourceArns ?? ['*'],
+    })
+  }
+
+  /**
+   * @summary Method to create iam statement to poll queue
+   * @param {string[]} resourceArns list of ARNs to allow access to
+   */
+  public statementForPollQueue(resourceArns?: string[]) {
+    return new iam.PolicyStatement({
+      effect: iam.Effect.ALLOW,
+      actions: ['sqs:ReceiveMessage', 'sqs:DeleteMessage', 'sqs:GetQueueAttributes'],
+      resources: resourceArns ?? ['*'],
+    })
+  }
+
   /**
    * @summary Method to create iam statement to invoke lambda function
    * @param {string[]} resourceArns list of ARNs to allow access to
@@ -508,6 +532,34 @@ export class IamManager {
     return role
   }
 
+  /**
+   * @summary Method to create iam statement for sqs to step function pipe
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {string} queueArn the arn of the sqs queue
+   * @param {string} stepFunctionArn the arn of the step function
+   */
+  public createRoleForSqsToSfnPipe(
+    id: string,
+    scope: common.CommonConstruct,
+    queueArn: string,
+    stepFunctionArn: string
+  ) {
+    const role = new iam.Role(scope, `${id}`, {
+      assumedBy: new iam.ServicePrincipal('pipes.amazonaws.com'),
+      description: `Role for ${id} Pipe`,
+      roleName: `${id}-${scope.props.stage}`,
+    })
+
+    role.addToPolicy(this.statementForPollQueue([queueArn]))
+    role.addToPolicy(this.statementForStartExecution([stepFunctionArn]))
+
+    utils.createCfnOutput(`${id}Arn`, scope, role.roleArn)
+    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

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

@@ -29,6 +29,7 @@ import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks'
 import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
 import * as types from '../index'
 import * as appAutoscaling from 'aws-cdk-lib/aws-applicationautoscaling'
+import * as pipes from 'aws-cdk-lib/aws-pipes'
 
 /**
  * @category cdk-utils.app-config-manager
@@ -706,6 +707,18 @@ export interface RuleProps extends events.CfnRuleProps {
   input?: string
 }
 
+/**
+ * @category cdk-utils.event-manager
+ * @subcategory Properties
+ */
+export interface SqsToSfnPipeProps extends pipes.CfnPipeProps {
+  pipeFilterPattern?: any
+  sqsBatchSize?: number
+  sqsMaximumBatchingWindowInSeconds?: number
+  sfnInvocationType?: string
+  sfnInputTemplate?: string
+}
+
 /**
  * @category cdk-utils.event-manager
  * @subcategory Properties