@gradientedge/cdk-utils 4.4.6 → 4.5.0

package/dist/src/lib/utils/index.js

@@ -0,0 +1,85 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redirectSuccess = exports.redirectError = exports.isPrdStage = exports.isUatStage = exports.isTestStage = exports.isDevStage = exports.LogLevel = void 0;
+__exportStar(require("./aws"), exports);
+/**
+ * @category cdk-utils.utils
+ */
+const defaultResponseObject = {
+    statusCode: 200,
+    body: '',
+    isBase64Encoded: false,
+    headers: {
+        'Access-Control-Allow-Origin': '*',
+    },
+};
+/**
+ * @category cdk-utils.utils
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "DEBUG";
+    LogLevel["INFO"] = "INFO";
+    LogLevel["WARNING"] = "WARNING";
+    LogLevel["TRACE"] = "TRACE";
+    LogLevel["ERROR"] = "ERROR";
+    LogLevel["CRITICAL"] = "CRITICAL";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+/**
+ * @category cdk-utils.utils
+ * @param stage
+ */
+const isDevStage = (stage) => stage === 'dev';
+exports.isDevStage = isDevStage;
+/**
+ * @category cdk-utils.utils
+ * @param stage
+ */
+const isTestStage = (stage) => stage === 'tst';
+exports.isTestStage = isTestStage;
+/**
+ * @category cdk-utils.utils
+ * @param stage
+ */
+const isUatStage = (stage) => stage === 'uat';
+exports.isUatStage = isUatStage;
+/**
+ * @category cdk-utils.utils
+ * @param stage
+ */
+const isPrdStage = (stage) => stage === 'prd';
+exports.isPrdStage = isPrdStage;
+/**
+ * @category cdk-utils.utils
+ * @param error
+ */
+function redirectError(error) {
+    console.error(error, error.message, error.stack);
+    return Object.assign({}, defaultResponseObject, {
+        statusCode: 500,
+        body: JSON.stringify(Object.assign({}, { success: false, error: error.message })),
+    });
+}
+exports.redirectError = redirectError;
+/**
+ * @category cdk-utils.utils
+ * @param message
+ */
+function redirectSuccess(message) {
+    return Object.assign({}, defaultResponseObject, {
+        statusCode: 200,
+        body: JSON.stringify(Object.assign({}, { success: true, error: message })),
+    });
+}
+exports.redirectSuccess = redirectSuccess;
+//# sourceMappingURL=index.js.map

package/dist/src/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,wCAAqB;AAErB;;GAEG;AACH,MAAM,qBAAqB,GAAG;IAC5B,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,EAAE;IACR,eAAe,EAAE,KAAK;IACtB,OAAO,EAAE;QACP,6BAA6B,EAAE,GAAG;KACnC;CACF,CAAA;AAED;;GAEG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,+BAAmB,CAAA;IACnB,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,iCAAqB,CAAA;AACvB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAED;;;GAGG;AACI,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAA;AAA/C,QAAA,UAAU,cAAqC;AAC5D;;;GAGG;AACI,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAA;AAAhD,QAAA,WAAW,eAAqC;AAC7D;;;GAGG;AACI,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAA;AAA/C,QAAA,UAAU,cAAqC;AAC5D;;;GAGG;AACI,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAA;AAA/C,QAAA,UAAU,cAAqC;AAE5D;;;GAGG;AACH,SAAgB,aAAa,CAAC,KAAU;IACtC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAChD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,qBAAqB,EAAE;QAC9C,UAAU,EAAE,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KAClF,CAAC,CAAA;AACJ,CAAC;AAND,sCAMC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,OAAY;IAC1C,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,qBAAqB,EAAE;QAC9C,UAAU,EAAE,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;KAC3E,CAAC,CAAA;AACJ,CAAC;AALD,0CAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "4.4.6",
+  "version": "4.5.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -31,7 +31,7 @@
     "docs": "rimraf api-docs && npx jsdoc --pedantic -c jsdoc.json .",
     "lint": "yarn prettify && eslint **/*.ts --max-warnings=0",
     "fix": "yarn prettify && eslint --fix **/*.ts",
-    "postinstall": "npx lerna bootstrap && yarn build",
+    "postinstall": "npx lerna run init",
     "prettier": "npx prettier --check \"**/*.{ts,json,md}\"",
     "prettify": "npx prettier --write \"**/*.{ts,json,md}\"",
     "test": "rimraf coverage && npx jest --ci --runInBand",
@@ -50,14 +50,11 @@
     "aws-cdk-lib": "^2.10.0",
     "aws-sdk": "^2.1070.0",
     "constructs": "^10.0.55",
-    "lerna": "^4.0.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "nconf": "^0.11.3",
     "pluralize": "^8.0.0",
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.5.0",
-    "typescript": "^4.5.5"
+    "ts-node": "^10.5.0"
   },
   "devDependencies": {
     "@babel/plugin-proposal-class-properties": "^7.16.7",
@@ -80,10 +77,14 @@
     "jsdoc": "^3.6.10",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-mermaid": "^1.0.0",
+    "lerna": "^4.0.0",
     "prettier": "^2.5.1",
     "prettier-plugin-organize-imports": "^2.3.4",
+    "rimraf": "^3.0.2",
     "semantic-release": "^19.0.2",
-    "ts-jest": "^27.1.3"
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.5.0",
+    "typescript": "4.5.5"
   },
   "optionalDependencies": {
     "@babel/core": "^7.17.0",

package/src/lib/common/construct.ts

@@ -44,6 +44,7 @@ export class CommonConstruct extends Construct {
   ssMManager: aws.SsmManager
   vpcManager: aws.VpcManager
   wafManager: aws.WafManager
+  elasticacheManager: aws.ElastiCacheManager
   fullyQualifiedDomainName: string
 
   constructor(parent: Construct, id: string, props: types.CommonStackProps) {
@@ -71,6 +72,7 @@ export class CommonConstruct extends Construct {
     this.ssMManager = new aws.SsmManager()
     this.vpcManager = new aws.VpcManager()
     this.wafManager = new aws.WafManager()
+    this.elasticacheManager = new aws.ElastiCacheManager()
 
     this.determineFullyQualifiedDomain()
   }

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

@@ -0,0 +1,98 @@
+import * as elasticache from 'aws-cdk-lib/aws-elasticache'
+import * as common from '../../common'
+import * as types from '../../types'
+import * as utils from '../../utils'
+
+/**
+ * @stability stable
+ * @category cdk-utils.elasticache-manager
+ * @subcategory Construct
+ * @summary Provides operations on AWS ElastiCache Service.
+ * - A new instance of scope 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.elasticacheManager.createElastiCache('MyElastiCache', scope, props)
+ *   }
+ * }
+ *
+ * @see [CDK ElastiCache Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache-readme.html}
+ */
+export class ElastiCacheManager {
+  /**
+   * @summary Method to create an elasticache resource
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which scope resource is defined
+   * @param {string[]} subnetIds
+   */
+  public createElastiCacheSubnetGroup(id: string, scope: common.CommonConstruct, subnetIds: string[]) {
+    const elasticacheSubnetGroup = new elasticache.CfnSubnetGroup(scope, `${id}`, {
+      cacheSubnetGroupName: `${id}-subnet-group-${scope.props.stage}`,
+      subnetIds: subnetIds,
+      description: `${id}-subnet-group-${scope.props.stage}`,
+    })
+
+    return elasticacheSubnetGroup
+  }
+
+  /**
+   * @summary Method to create an elasticache resource
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which scope resource is defined
+   * @param {types.ElastiCacheProps} props
+   * @param {string[]} subnetIds
+   * @param {string[]} securityGroupIds
+   * @param {string[]} logDeliveryConfigurations
+   */
+  public createElastiCache(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.ElastiCacheProps,
+    subnetIds: string[],
+    securityGroupIds: string[],
+    logDeliveryConfigurations?: any
+  ) {
+    if (!props) throw `ElastiCache props undefined`
+
+    const subnetGroup = this.createElastiCacheSubnetGroup(`${id}-subnetGroup`, scope, subnetIds)
+
+    const elasticacheCluster = new elasticache.CfnCacheCluster(scope, `${id}`, {
+      engine: props.engine,
+      engineVersion: props.engineVersion,
+      cacheNodeType: props.cacheNodeType,
+      numCacheNodes: props.numCacheNodes,
+      clusterName: `${id}-${scope.props.stage}`,
+      vpcSecurityGroupIds: securityGroupIds,
+      cacheSubnetGroupName: subnetGroup.cacheSubnetGroupName,
+      azMode: props.azMode,
+      preferredAvailabilityZones: props.preferredAvailabilityZones,
+      preferredMaintenanceWindow: props.preferredMaintenanceWindow,
+      autoMinorVersionUpgrade: props.autoMinorVersionUpgrade,
+      cacheParameterGroupName: props.cacheParameterGroupName,
+      cacheSecurityGroupNames: props.cacheSecurityGroupNames,
+      port: props.port,
+      snapshotArns: props.snapshotArns,
+      snapshotName: props.snapshotName,
+      snapshotRetentionLimit: props.snapshotRetentionLimit,
+      snapshotWindow: props.snapshotWindow,
+      logDeliveryConfigurations: logDeliveryConfigurations,
+    })
+
+    utils.createCfnOutput(`${id}-clusterName`, scope, elasticacheCluster.clusterName)
+    utils.createCfnOutput(
+      `${id}-configurationEndpointAddress`,
+      scope,
+      elasticacheCluster.attrConfigurationEndpointAddress
+    )
+    utils.createCfnOutput(`${id}-configurationEndpointPort`, scope, elasticacheCluster.attrConfigurationEndpointPort)
+    utils.createCfnOutput(`${id}-redisEndpointPort`, scope, elasticacheCluster.attrRedisEndpointPort)
+    utils.createCfnOutput(`${id}-redisEndpointAddress`, scope, elasticacheCluster.attrRedisEndpointAddress)
+
+    return elasticacheCluster
+  }
+}

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

@@ -9,6 +9,7 @@ export * from './dynamodb-manager'
 export * from './ecr-manager'
 export * from './ecs-manager'
 export * from './eks-manager'
+export * from './elasticache-manager'
 export * from './event-manager'
 export * from './iam-manager'
 export * from './lambda-manager'

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

@@ -10,6 +10,7 @@ import * as ec2 from 'aws-cdk-lib/aws-ec2'
 import * as ecs from 'aws-cdk-lib/aws-ecs'
 import * as ecsPatterns from 'aws-cdk-lib/aws-ecs-patterns'
 import * as eks from 'aws-cdk-lib/aws-eks'
+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'
@@ -505,3 +506,9 @@ export interface WafIPSetProps extends wafv2.CfnIPSetProps {}
  * @subcategory Properties
  */
 export interface WafWebACLProps extends wafv2.CfnWebACLProps {}
+
+/**
+ * @category cdk-utils.elasticache-manager
+ * @category Compute
+ */
+export interface ElastiCacheProps extends elasticache.CfnCacheClusterProps {}