@gradientedge/cdk-utils 8.0.0 → 8.2.0

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

@@ -81,4 +81,12 @@ export declare class LambdaManager {
      * @param {ec2.SubnetSelection?} vpcSubnets
      */
     createLambdaDockerFunction(id: string, scope: common.CommonConstruct, props: types.LambdaProps, role: iam.Role | iam.CfnRole, code: lambda.DockerImageCode, environment?: any, vpc?: ec2.IVpc, securityGroups?: ec2.ISecurityGroup[], accessPoint?: efs.IAccessPoint, mountPath?: string, vpcSubnets?: ec2.SubnetSelection): cdk.aws_lambda.DockerImageFunction;
+    /**
+     * @summary Method to create a lambda function Alias
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaAliasProps} props
+     * @param {types.LambdaAliasProps} lambdaVersion
+     */
+    createLambdaFunctionAlias(id: string, scope: common.CommonConstruct, props: types.LambdaAliasProps, lambdaVersion: lambda.IVersion): cdk.aws_lambda.Alias;
 }

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

@@ -199,5 +199,33 @@ class LambdaManager {
         utils.createCfnOutput(`${id}-lambdaName`, scope, lambdaFunction.functionName);
         return lambdaFunction;
     }
+    /**
+     * @summary Method to create a lambda function Alias
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaAliasProps} props
+     * @param {types.LambdaAliasProps} lambdaVersion
+     */
+    createLambdaFunctionAlias(id, scope, props, lambdaVersion) {
+        if (!props)
+            throw `Lambda Alias props undefined for ${id}`;
+        const lambdaFunctionAlias = new lambda.Alias(scope, `${id}`, {
+            ...props,
+            ...{
+                aliasName: `${id}-lambda-alias`,
+                version: lambdaVersion,
+                additionalVersions: props.additionalVersions,
+                description: props.description,
+                maxEventAge: props.maxEventAge,
+                onFailure: props.onFailure,
+                onSuccess: props.onSuccess,
+                provisionedConcurrentExecutions: props.provisionedConcurrentExecutions,
+                retryAttempts: props.retryAttempts,
+            },
+        });
+        utils.createCfnOutput(`${id}-lambdaAliasName`, scope, lambdaFunctionAlias.functionArn);
+        utils.createCfnOutput(`${id}-lambdaAliasArn`, scope, lambdaFunctionAlias.functionName);
+        return lambdaFunctionAlias;
+    }
 }
 exports.LambdaManager = LambdaManager;

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

@@ -106,12 +106,19 @@ class SfnManager {
     createParallelStep(id, scope, props) {
         if (!props)
             throw `Step props undefined for ${id}`;
-        return new sfn.Parallel(scope, `${props.name}`, {
+        const step = new sfn.Parallel(scope, `${props.name}`, {
             ...props,
             ...{
                 comment: `Parallel step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
+        if (props.retries && props.retries.length > 0) {
+            props.retries.forEach(retry => step.addRetry({
+                ...retry,
+                ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+            }));
+        }
+        return step;
     }
     /**
      * @summary Method to create a choice step
@@ -155,7 +162,7 @@ class SfnManager {
     createDynamoDbGetItemStep(id, scope, props, table, tableKey) {
         if (!props)
             throw `Step props undefined for ${id}`;
-        return new tasks.DynamoGetItem(scope, `${props.name}`, {
+        const step = new tasks.DynamoGetItem(scope, `${props.name}`, {
             ...props,
             ...{
                 table: table,
@@ -174,6 +181,13 @@ class SfnManager {
                 comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
+        if (props.retries && props.retries.length > 0) {
+            props.retries.forEach(retry => step.addRetry({
+                ...retry,
+                ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+            }));
+        }
+        return step;
     }
     /**
      * @summary Method to create a DynamoDB put item step
@@ -186,7 +200,7 @@ class SfnManager {
     createDynamoDbPutItemStep(id, scope, props, table, tableItem) {
         if (!props)
             throw `Step props undefined for ${id}`;
-        return new tasks.DynamoPutItem(scope, `${props.name}`, {
+        const step = new tasks.DynamoPutItem(scope, `${props.name}`, {
             ...props,
             ...{
                 table: table,
@@ -207,6 +221,13 @@ class SfnManager {
                 comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
+        if (props.retries && props.retries.length > 0) {
+            props.retries.forEach(retry => step.addRetry({
+                ...retry,
+                ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+            }));
+        }
+        return step;
     }
     /**
      * @summary Method to send a message to SQS step
@@ -220,7 +241,7 @@ class SfnManager {
             throw `Step props undefined for ${id}`;
         if (!props.messageBody)
             throw 'Message body undefined';
-        return new tasks.SqsSendMessage(scope, `${props.name}`, {
+        const step = new tasks.SqsSendMessage(scope, `${props.name}`, {
             ...props,
             ...{
                 queue: queue,
@@ -238,6 +259,13 @@ class SfnManager {
                 comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
+        if (props.retries && props.retries.length > 0) {
+            props.retries.forEach(retry => step.addRetry({
+                ...retry,
+                ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+            }));
+        }
+        return step;
     }
     /**
      * @summary Method to create a lambda invoke step
@@ -249,13 +277,20 @@ class SfnManager {
     createLambdaStep(id, scope, props, lambdaFunction) {
         if (!props)
             throw `Step props undefined for ${id}`;
-        return new tasks.LambdaInvoke(scope, `${props.name}`, {
+        const step = new tasks.LambdaInvoke(scope, `${props.name}`, {
             ...props,
             ...{
                 lambdaFunction,
                 comment: `Lambda step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
+        if (props.retries && props.retries.length > 0) {
+            props.retries.forEach(retry => step.addRetry({
+                ...retry,
+                ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+            }));
+        }
+        return step;
     }
     /**
      * @summary Method to create a API Gateway invoke step
@@ -267,7 +302,7 @@ class SfnManager {
     createApiStep(id, scope, props, api) {
         if (!props)
             throw `Step props undefined for ${id}`;
-        return new tasks.CallApiGatewayRestApiEndpoint(scope, `${props.name}`, {
+        const step = new tasks.CallApiGatewayRestApiEndpoint(scope, `${props.name}`, {
             ...props,
             ...{
                 api,
@@ -275,6 +310,13 @@ class SfnManager {
                 comment: `API step for ${props.name} - ${scope.props.stage} stage`,
             },
         });
+        if (props.retries && props.retries.length > 0) {
+            props.retries.forEach(retry => step.addRetry({
+                ...retry,
+                ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+            }));
+        }
+        return step;
     }
     /**
      * @summary Method to create a state machine

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

@@ -121,6 +121,13 @@ export interface KmsKeyProps extends kms.KeyProps {
 export interface SfnSucceedProps extends sfn.SucceedProps {
     name: string;
 }
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnRetryProps extends sfn.RetryProps {
+    intervalInSecs: number;
+}
 /**
  * @category cdk-utils.step-functions-manager
  * @subcategory Properties
@@ -141,6 +148,7 @@ export interface SfnPassProps extends sfn.PassProps {
  */
 export interface SfnDynamoGetItemProps extends tasks.DynamoGetItemProps {
     name: string;
+    retries?: SfnRetryProps[];
 }
 /**
  * @category cdk-utils.step-functions-manager
@@ -148,6 +156,7 @@ export interface SfnDynamoGetItemProps extends tasks.DynamoGetItemProps {
  */
 export interface SfnDynamoPutItemProps extends tasks.DynamoPutItemProps {
     name: string;
+    retries?: SfnRetryProps[];
 }
 /**
  * @category cdk-utils.step-functions-manager
@@ -155,6 +164,7 @@ export interface SfnDynamoPutItemProps extends tasks.DynamoPutItemProps {
  */
 export interface SfnSqsSendMessageProps extends tasks.SqsSendMessageProps {
     name: string;
+    retries?: SfnRetryProps[];
 }
 /**
  * @category cdk-utils.step-functions-manager
@@ -162,6 +172,7 @@ export interface SfnSqsSendMessageProps extends tasks.SqsSendMessageProps {
  */
 export interface SfnParallelProps extends sfn.ParallelProps {
     name: string;
+    retries?: SfnRetryProps[];
 }
 /**
  * @category cdk-utils.step-functions-manager
@@ -184,6 +195,7 @@ export interface SfnWaitProps extends sfn.WaitProps {
  */
 export interface SfnLambdaInvokeProps extends tasks.LambdaInvokeProps {
     name: string;
+    retries?: SfnRetryProps[];
 }
 /**
  * @category cdk-utils.step-functions-manager
@@ -191,6 +203,7 @@ export interface SfnLambdaInvokeProps extends tasks.LambdaInvokeProps {
  */
 export interface SfnCallApiGatewayRestApiEndpointProps extends tasks.CallApiGatewayRestApiEndpointProps {
     name: string;
+    retries?: SfnRetryProps[];
 }
 /**
  * @category cdk-utils.step-functions-manager
@@ -620,6 +633,12 @@ export interface LambdaProps extends lambda.FunctionProps {
     timeoutInSecs?: number;
     excludeLastModifiedTimestamp?: boolean;
 }
+/**
+ * @category cdk-utils.lambda-manager
+ * @subcategory Properties
+ */
+export interface LambdaAliasProps extends lambda.AliasProps {
+}
 /**
  * @category cdk-utils.lambda-manager
  * @subcategory Properties

package/package.json

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

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

@@ -244,4 +244,40 @@ export class LambdaManager {
 
     return lambdaFunction
   }
+
+  /**
+   * @summary Method to create a lambda function Alias
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.LambdaAliasProps} props
+   * @param {types.LambdaAliasProps} lambdaVersion
+   */
+  public createLambdaFunctionAlias(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.LambdaAliasProps,
+    lambdaVersion: lambda.IVersion
+  ) {
+    if (!props) throw `Lambda Alias props undefined for ${id}`
+
+    const lambdaFunctionAlias = new lambda.Alias(scope, `${id}`, {
+      ...props,
+      ...{
+        aliasName: `${id}-lambda-alias`,
+        version: lambdaVersion,
+        additionalVersions: props.additionalVersions,
+        description: props.description,
+        maxEventAge: props.maxEventAge,
+        onFailure: props.onFailure,
+        onSuccess: props.onSuccess,
+        provisionedConcurrentExecutions: props.provisionedConcurrentExecutions,
+        retryAttempts: props.retryAttempts,
+      },
+    })
+
+    utils.createCfnOutput(`${id}-lambdaAliasName`, scope, lambdaFunctionAlias.functionArn)
+    utils.createCfnOutput(`${id}-lambdaAliasArn`, scope, lambdaFunctionAlias.functionName)
+
+    return lambdaFunctionAlias
+  }
 }

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

@@ -88,12 +88,23 @@ export class SfnManager {
    */
   public createParallelStep(id: string, scope: common.CommonConstruct, props: types.SfnParallelProps) {
     if (!props) throw `Step props undefined for ${id}`
-    return new sfn.Parallel(scope, `${props.name}`, {
+    const step = new sfn.Parallel(scope, `${props.name}`, {
       ...props,
       ...{
         comment: `Parallel step for ${props.name} - ${scope.props.stage} stage`,
       },
     })
+
+    if (props.retries && props.retries.length > 0) {
+      props.retries.forEach(retry =>
+        step.addRetry({
+          ...retry,
+          ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        })
+      )
+    }
+
+    return step
   }
 
   /**
@@ -144,7 +155,7 @@ export class SfnManager {
     tableKey: { [key: string]: tasks.DynamoAttributeValue }
   ) {
     if (!props) throw `Step props undefined for ${id}`
-    return new tasks.DynamoGetItem(scope, `${props.name}`, {
+    const step = new tasks.DynamoGetItem(scope, `${props.name}`, {
       ...props,
       ...{
         table: table,
@@ -163,6 +174,17 @@ export class SfnManager {
         comment: `DynamoDB GetItem step for ${props.name} - ${scope.props.stage} stage`,
       },
     })
+
+    if (props.retries && props.retries.length > 0) {
+      props.retries.forEach(retry =>
+        step.addRetry({
+          ...retry,
+          ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        })
+      )
+    }
+
+    return step
   }
 
   /**
@@ -181,7 +203,7 @@ export class SfnManager {
     tableItem: { [key: string]: tasks.DynamoAttributeValue }
   ) {
     if (!props) throw `Step props undefined for ${id}`
-    return new tasks.DynamoPutItem(scope, `${props.name}`, {
+    const step = new tasks.DynamoPutItem(scope, `${props.name}`, {
       ...props,
       ...{
         table: table,
@@ -202,6 +224,17 @@ export class SfnManager {
         comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
       },
     })
+
+    if (props.retries && props.retries.length > 0) {
+      props.retries.forEach(retry =>
+        step.addRetry({
+          ...retry,
+          ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        })
+      )
+    }
+
+    return step
   }
 
   /**
@@ -219,7 +252,7 @@ export class SfnManager {
   ) {
     if (!props) throw `Step props undefined for ${id}`
     if (!props.messageBody) throw 'Message body undefined'
-    return new tasks.SqsSendMessage(scope, `${props.name}`, {
+    const step = new tasks.SqsSendMessage(scope, `${props.name}`, {
       ...props,
       ...{
         queue: queue,
@@ -237,6 +270,17 @@ export class SfnManager {
         comment: `DynamoDB PutItem step for ${props.name} - ${scope.props.stage} stage`,
       },
     })
+
+    if (props.retries && props.retries.length > 0) {
+      props.retries.forEach(retry =>
+        step.addRetry({
+          ...retry,
+          ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        })
+      )
+    }
+
+    return step
   }
 
   /**
@@ -253,13 +297,24 @@ export class SfnManager {
     lambdaFunction: lambda.IFunction
   ) {
     if (!props) throw `Step props undefined for ${id}`
-    return new tasks.LambdaInvoke(scope, `${props.name}`, {
+    const step = new tasks.LambdaInvoke(scope, `${props.name}`, {
       ...props,
       ...{
         lambdaFunction,
         comment: `Lambda step for ${props.name} - ${scope.props.stage} stage`,
       },
     })
+
+    if (props.retries && props.retries.length > 0) {
+      props.retries.forEach(retry =>
+        step.addRetry({
+          ...retry,
+          ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        })
+      )
+    }
+
+    return step
   }
 
   /**
@@ -276,7 +331,7 @@ export class SfnManager {
     api: apig.IRestApi
   ) {
     if (!props) throw `Step props undefined for ${id}`
-    return new tasks.CallApiGatewayRestApiEndpoint(scope, `${props.name}`, {
+    const step = new tasks.CallApiGatewayRestApiEndpoint(scope, `${props.name}`, {
       ...props,
       ...{
         api,
@@ -284,6 +339,17 @@ export class SfnManager {
         comment: `API step for ${props.name} - ${scope.props.stage} stage`,
       },
     })
+
+    if (props.retries && props.retries.length > 0) {
+      props.retries.forEach(retry =>
+        step.addRetry({
+          ...retry,
+          ...{ interval: retry.intervalInSecs ? cdk.Duration.seconds(retry.intervalInSecs) : retry.interval },
+        })
+      )
+    }
+
+    return step
   }
 
   /**

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

@@ -128,6 +128,14 @@ export interface SfnSucceedProps extends sfn.SucceedProps {
   name: string
 }
 
+/**
+ * @category cdk-utils.step-functions-manager
+ * @subcategory Properties
+ */
+export interface SfnRetryProps extends sfn.RetryProps {
+  intervalInSecs: number
+}
+
 /**
  * @category cdk-utils.step-functions-manager
  * @subcategory Properties
@@ -150,6 +158,7 @@ export interface SfnPassProps extends sfn.PassProps {
  */
 export interface SfnDynamoGetItemProps extends tasks.DynamoGetItemProps {
   name: string
+  retries?: SfnRetryProps[]
 }
 
 /**
@@ -158,6 +167,7 @@ export interface SfnDynamoGetItemProps extends tasks.DynamoGetItemProps {
  */
 export interface SfnDynamoPutItemProps extends tasks.DynamoPutItemProps {
   name: string
+  retries?: SfnRetryProps[]
 }
 
 /**
@@ -166,6 +176,7 @@ export interface SfnDynamoPutItemProps extends tasks.DynamoPutItemProps {
  */
 export interface SfnSqsSendMessageProps extends tasks.SqsSendMessageProps {
   name: string
+  retries?: SfnRetryProps[]
 }
 
 /**
@@ -174,6 +185,7 @@ export interface SfnSqsSendMessageProps extends tasks.SqsSendMessageProps {
  */
 export interface SfnParallelProps extends sfn.ParallelProps {
   name: string
+  retries?: SfnRetryProps[]
 }
 
 /**
@@ -199,6 +211,7 @@ export interface SfnWaitProps extends sfn.WaitProps {
  */
 export interface SfnLambdaInvokeProps extends tasks.LambdaInvokeProps {
   name: string
+  retries?: SfnRetryProps[]
 }
 
 /**
@@ -207,6 +220,7 @@ export interface SfnLambdaInvokeProps extends tasks.LambdaInvokeProps {
  */
 export interface SfnCallApiGatewayRestApiEndpointProps extends tasks.CallApiGatewayRestApiEndpointProps {
   name: string
+  retries?: SfnRetryProps[]
 }
 
 /**
@@ -659,6 +673,12 @@ export interface LambdaProps extends lambda.FunctionProps {
   excludeLastModifiedTimestamp?: boolean
 }
 
+/**
+ * @category cdk-utils.lambda-manager
+ * @subcategory Properties
+ */
+export interface LambdaAliasProps extends lambda.AliasProps {}
+
 /**
  * @category cdk-utils.lambda-manager
  * @subcategory Properties