@gradientedge/cdk-utils 8.62.0 → 8.63.0

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

@@ -129,6 +129,14 @@ export declare class SfnManager {
      * @param {apig.IRestApi} api
      */
     createApiStep(id: string, scope: common.CommonConstruct, props: types.SfnCallApiGatewayRestApiEndpointProps, api: apig.IRestApi): cdk.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpoint;
+    /**
+     * @summary Method to create a step function execution step
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.SfnStartExecutionProps} props props for the step
+     * @param {sfn.IStateMachine} stateMachine the state machine to execute
+     */
+    createSfnExecutionStep(id: string, scope: common.CommonConstruct, props: types.SfnStartExecutionProps, stateMachine: sfn.IStateMachine): cdk.aws_stepfunctions_tasks.StepFunctionsStartExecution;
     /**
      * @summary Method to create a step function map state
      * @param {string} id scoped id of the resource

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

@@ -28,6 +28,7 @@ const cdk = __importStar(require("aws-cdk-lib"));
 const sfn = __importStar(require("aws-cdk-lib/aws-stepfunctions"));
 const tasks = __importStar(require("aws-cdk-lib/aws-stepfunctions-tasks"));
 const utils = __importStar(require("../../utils"));
+const uuid_1 = require("uuid");
 const DEFAULT_RETRY_CONFIG = [
     {
         errors: ['States.ALL'],
@@ -380,6 +381,31 @@ class SfnManager {
         }));
         return step;
     }
+    /**
+     * @summary Method to create a step function execution step
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.SfnStartExecutionProps} props props for the step
+     * @param {sfn.IStateMachine} stateMachine the state machine to execute
+     */
+    createSfnExecutionStep(id, scope, props, stateMachine) {
+        const step = new tasks.StepFunctionsStartExecution(scope, `${id}`, {
+            ...props,
+            associateWithParent: props.associateWithParent ?? true,
+            inputPath: props.inputPath,
+            name: props.name ?? (0, uuid_1.v4)(),
+            stateMachine: stateMachine,
+        });
+        let retries = props.retries;
+        if (!retries || retries.length === 0) {
+            retries = DEFAULT_RETRY_CONFIG;
+        }
+        retries.forEach(retry => step.addRetry({
+            ...retry,
+            ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        }));
+        return step;
+    }
     /**
      * @summary Method to create a step function map state
      * @param {string} id scoped id of the resource

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

@@ -668,6 +668,13 @@ export interface RuleProps extends events.CfnRuleProps {
  */
 export interface SfnMapProps extends sfn.MapProps {
 }
+/**
+ * @category cdk-utils.sfn-manager
+ * @subcategory Properties
+ */
+export interface SfnStartExecutionProps extends tasks.StepFunctionsStartExecutionProps {
+    retries?: SfnRetryProps[];
+}
 /**
    }
  * @category cdk-utils.event-manager

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.62.0",
+  "version": "8.63.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -46,17 +46,19 @@
     }
   },
   "dependencies": {
+    "@aws-sdk/client-secrets-manager": "^3.334.0",
     "@types/lodash": "^4.14.194",
     "@types/node": "^20.2.0",
+    "@types/uuid": "^9.0.1",
     "app-root-path": "^3.1.0",
     "aws-cdk-lib": "^2.79.1",
-    "@aws-sdk/client-secrets-manager": "^3.334.0",
     "constructs": "^10.2.27",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nconf": "^0.12.0",
     "pluralize": "^8.0.0",
-    "ts-node": "^10.9.1"
+    "ts-node": "^10.9.1",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.21.8",

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

@@ -11,6 +11,7 @@ import * as common from '../../common'
 import * as types from '../../types'
 import * as utils from '../../utils'
 import { SfnMapProps } from '../../types'
+import { v4 as uuidv4 } from 'uuid'
 
 const DEFAULT_RETRY_CONFIG = [
   {
@@ -433,6 +434,42 @@ export class SfnManager {
     return step
   }
 
+  /**
+   * @summary Method to create a step function execution step
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.SfnStartExecutionProps} props props for the step
+   * @param {sfn.IStateMachine} stateMachine the state machine to execute
+   */
+  public createSfnExecutionStep(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.SfnStartExecutionProps,
+    stateMachine: sfn.IStateMachine
+  ) {
+    const step = new tasks.StepFunctionsStartExecution(scope, `${id}`, {
+      ...props,
+      associateWithParent: props.associateWithParent ?? true,
+      inputPath: props.inputPath,
+      name: props.name ?? uuidv4(),
+      stateMachine: stateMachine,
+    })
+
+    let retries = props.retries
+    if (!retries || retries.length === 0) {
+      retries = DEFAULT_RETRY_CONFIG
+    }
+
+    retries.forEach(retry =>
+      step.addRetry({
+        ...retry,
+        ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+      })
+    )
+
+    return step
+  }
+
   /**
    * @summary Method to create a step function map state
    * @param {string} id scoped id of the resource

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

@@ -714,6 +714,14 @@ export interface RuleProps extends events.CfnRuleProps {
  */
 export interface SfnMapProps extends sfn.MapProps {}
 
+/**
+ * @category cdk-utils.sfn-manager
+ * @subcategory Properties
+ */
+export interface SfnStartExecutionProps extends tasks.StepFunctionsStartExecutionProps {
+  retries?: SfnRetryProps[]
+}
+
 /**
    }
  * @category cdk-utils.event-manager