@gradientedge/cdk-utils 4.3.1 → 4.4.2

package/src/lib/manager/aws/{lambdaManager.ts → lambda-manager.ts}

@@ -7,12 +7,13 @@ import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as common from '../../common'
 import * as types from '../../types'
 import * as utils from '../../utils'
-import { CloudFrontManager } from './cloudFrontManager'
+import { CloudFrontManager } from './cloudfront-manager'
 
 /**
  * @stability stable
- * @category Compute
- * @summary Provides operations on AWS Lambda.
+ * @category cdk-utils.lambda-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Lambda.
  * - 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
@@ -68,45 +69,49 @@ export class LambdaManager {
   }
 
   /**
-   * @summary Method to create a lambda function (nodejs)
+   * @summary Method to create a lambda function (python)
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {types.LambdaProps} props
    * @param {iam.Role | iam.CfnRole} role
    * @param {lambda.ILayerVersion[]} layers
-   * @param {lambda.AssetCode} code
-   * @param {string} handler
-   * @param {Map<string, string>} environment
-   * @param {ec2.IVpc} vpc
-   * @param {ec2.ISecurityGroup[]} securityGroups
-   * @param {ec2.SubnetSelection} vpcSubnets
-   * @param {efs.IAccessPoint} accessPoint
-   * @param {string} mountPath
+   * @param {string} entry path to lambda source
+   * @param {string?} index
+   * @param {string?} handler
+   * @param {Map<string, string>?} environment
+   * @param {ec2.IVpc?} vpc
+   * @param {ec2.ISecurityGroup[]?} securityGroups
+   * @param {efs.IAccessPoint?} accessPoint
+   * @param {string?} mountPath
+   * @param {ec2.SubnetSelection?} vpcSubnets
    */
-  public createLambdaFunction(
+
+  public createPythonLambdaFunction(
     id: string,
     scope: common.CommonConstruct,
     props: types.LambdaProps,
     role: iam.Role | iam.CfnRole,
     layers: lambda.ILayerVersion[],
-    code: lambda.AssetCode,
+    entry: string,
+    index?: string,
     handler?: string,
     environment?: any,
     vpc?: ec2.IVpc,
     securityGroups?: ec2.ISecurityGroup[],
-    vpcSubnets?: ec2.SubnetSelection,
     accessPoint?: efs.IAccessPoint,
-    mountPath?: string
+    mountPath?: string,
+    vpcSubnets?: ec2.SubnetSelection
   ) {
     if (!props) throw `Lambda props undefined`
 
     const functionName = `${props.functionName}-${scope.props.stage}`
-    const lambdaFunction = new lambda.Function(scope, `${id}`, {
+    const lambdaFunction = new pylambda.PythonFunction(scope, `${id}`, {
       allowPublicSubnet: !!vpc,
       functionName: functionName,
-      handler: handler || 'index.lambda_handler',
-      runtime: lambda.Runtime.NODEJS_14_X,
-      code: code,
+      index: index,
+      handler: handler,
+      runtime: lambda.Runtime.PYTHON_3_8,
+      entry: entry,
       environment: {
         REGION: scope.props.region,
         ...environment,
@@ -115,6 +120,8 @@ export class LambdaManager {
       layers: layers,
       logRetention: props.logRetention,
       memorySize: props.memorySize,
+      onFailure: props.onFailure,
+      onSuccess: props.onSuccess,
       reservedConcurrentExecutions: props.reservedConcurrentExecutions,
       role: role instanceof iam.Role ? role : undefined,
       securityGroups: securityGroups,
@@ -130,47 +137,45 @@ export class LambdaManager {
   }
 
   /**
-   * @summary Method to create a lambda function (python)
+   * @summary Method to create a lambda function (nodejs)
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param {types.LambdaProps} props
    * @param {iam.Role | iam.CfnRole} role
    * @param {lambda.ILayerVersion[]} layers
-   * @param {string} entry path to lambda source
-   * @param {string} index
-   * @param {string} handler
-   * @param {Map<string, string>} environment
-   * @param {ec2.IVpc} vpc
-   * @param {ec2.ISecurityGroup[]} securityGroups
-   * @param {efs.IAccessPoint} accessPoint
-   * @param {string} mountPath
+   * @param {lambda.AssetCode} code
+   * @param {string?} handler
+   * @param {Map<string, string>?} environment
+   * @param {ec2.IVpc?} vpc
+   * @param {ec2.ISecurityGroup[]?} securityGroups
+   * @param {efs.IAccessPoint?} accessPoint
+   * @param {string?} mountPath
+   * @param {ec2.SubnetSelection?} vpcSubnets
    */
-
-  public createPythonLambdaFunction(
+  public createLambdaFunction(
     id: string,
     scope: common.CommonConstruct,
     props: types.LambdaProps,
     role: iam.Role | iam.CfnRole,
     layers: lambda.ILayerVersion[],
-    entry: string,
-    index?: string,
+    code: lambda.AssetCode,
     handler?: string,
     environment?: any,
     vpc?: ec2.IVpc,
     securityGroups?: ec2.ISecurityGroup[],
     accessPoint?: efs.IAccessPoint,
-    mountPath?: string
+    mountPath?: string,
+    vpcSubnets?: ec2.SubnetSelection
   ) {
     if (!props) throw `Lambda props undefined`
 
     const functionName = `${props.functionName}-${scope.props.stage}`
-    const lambdaFunction = new pylambda.PythonFunction(scope, `${id}`, {
+    const lambdaFunction = new lambda.Function(scope, `${id}`, {
       allowPublicSubnet: !!vpc,
       functionName: functionName,
-      index: index,
-      handler: handler,
-      runtime: lambda.Runtime.PYTHON_3_8,
-      entry: entry,
+      handler: handler || 'index.lambda_handler',
+      runtime: lambda.Runtime.NODEJS_14_X,
+      code: code,
       environment: {
         REGION: scope.props.region,
         ...environment,
@@ -179,11 +184,14 @@ export class LambdaManager {
       layers: layers,
       logRetention: props.logRetention,
       memorySize: props.memorySize,
+      onFailure: props.onFailure,
+      onSuccess: props.onSuccess,
       reservedConcurrentExecutions: props.reservedConcurrentExecutions,
       role: role instanceof iam.Role ? role : undefined,
       securityGroups: securityGroups,
       timeout: props.timeoutInSecs ? cdk.Duration.seconds(props.timeoutInSecs) : cdk.Duration.minutes(1),
       vpc: vpc,
+      vpcSubnets: vpcSubnets,
     })
 
     utils.createCfnOutput(`${id}-lambdaArn`, scope, lambdaFunction.functionArn)
@@ -200,11 +208,11 @@ export class LambdaManager {
    * @param {types.LambdaEdgeProps} props lambda@edge properties
    * @param {lambda.ILayerVersion[]} layers
    * @param {lambda.AssetCode} code
-   * @param {Map<string, string>} environment
-   * @param {ec2.IVpc} vpc
-   * @param {ec2.ISecurityGroup[]} securityGroups
-   * @param {efs.IAccessPoint} accessPoint
-   * @param {string} mountPath
+   * @param {Map<string, string>?} environment
+   * @param {ec2.IVpc?} vpc
+   * @param {ec2.ISecurityGroup[]?} securityGroups
+   * @param {efs.IAccessPoint?} accessPoint
+   * @param {string?} mountPath
    */
   public createEdgeFunction(
     id: string,

package/src/lib/manager/aws/{logManager.ts → log-manager.ts}

@@ -6,8 +6,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Management & Governance
- * @summary Provides operations on AWS CloudWatch.
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS CloudWatch.
  * - 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

package/src/lib/manager/aws/{route53Manager.ts → route53-manager.ts}

@@ -8,8 +8,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Networking & Content Delivery
- * @summary Provides operations on AWS Route53.
+ * @category cdk-utils.route53-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Route53.
  * - 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
@@ -143,7 +144,7 @@ export class Route53Manager {
   }
 
   /**
-   * @summary Method to create a-record for api gateway target
+   * @summary Method to create a-record for restApi gateway target
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param recordName

package/src/lib/manager/aws/{s3Manager.ts → s3-manager.ts}

@@ -9,8 +9,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Storage
- * @summary Provides operations on AWS S3.
+ * @category cdk-utils.s3-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS S3.
  * - 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

package/src/lib/manager/aws/{secretsManager.ts → secrets-manager.ts}

@@ -7,8 +7,9 @@ const fs = require('fs')
 
 /**
  * @stability experimental
- * @category Security, Identity & Compliance
- * @summary Provides operations on AWS Secrets Manager.
+ * @category cdk-utils.secrets-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Secrets Manager.
  * - 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

package/src/lib/manager/aws/{snsManager.ts → sns-manager.ts}

@@ -7,8 +7,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Application Integration
- * @summary Provides operations on AWS Simple Notification Service.
+ * @category cdk-utils.sns-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Simple Notification 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

package/src/lib/manager/aws/{ssmManager.ts → ssm-manager.ts}

@@ -6,8 +6,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Management & Governance
- * @summary Provides operations on AWS Systems Manager.
+ * @category cdk-utils.ssm-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Systems Manager.
  * - 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
@@ -81,15 +82,11 @@ export class SsmManager {
 }
 
 /**
- *
+ * @category cdk-utils.ssm-manager
+ * @subcategory Construct
+ * @classdesc Provides utilities to read same/cross region SSM parameters
  */
 export class SSMParameterReader extends cr.AwsCustomResource {
-  /**
-   *
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {string} name parameter name
-   * @param {types.SSMParameterReaderProps} props
-   */
   constructor(scope: common.CommonConstruct, name: string, props: types.SSMParameterReaderProps) {
     const { parameterName, region } = props
 

package/src/lib/manager/aws/{vpcManager.ts → vpc-manager.ts}

@@ -5,13 +5,15 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Utils
+ * @category cdk-utils.vpc-manager
+ * @subcategory Construct
  */
 const CommonVpcIdentifier = 'CommonVpc'
 
 /**
- * @category Networking & Content Delivery
- * @summary Provides operations on AWS VPC.
+ * @category cdk-utils.vpc-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS VPC.
  * - 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
@@ -76,8 +78,9 @@ export class VpcManager {
    * @summary Method to retrieve a common vpc
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {string?} vpcIdentifier optional identifier for VPC
    */
-  public retrieveCommonVpc(id: string, scope: common.CommonConstruct) {
-    return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: CommonVpcIdentifier })
+  public retrieveCommonVpc(id: string, scope: common.CommonConstruct, vpcIdentifier?: string) {
+    return ec2.Vpc.fromLookup(scope, `${id}`, { vpcName: vpcIdentifier ?? CommonVpcIdentifier })
   }
 }

package/src/lib/manager/aws/{wafManager.ts → waf-manager.ts}

@@ -5,8 +5,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Security, Identity & Compliance
- * @summary Provides operations on AWS WAF.
+ * @category cdk-utils.waf-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS WAF.
  * - 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