@gradientedge/cdk-utils 8.80.0 → 8.81.0

package/dist/src/lib/common/construct.d.ts

@@ -35,6 +35,7 @@ export declare class CommonConstruct extends Construct {
     elasticacheManager: aws.ElastiCacheManager;
     eventManager: aws.EventManager;
     eventTargetManager: aws.EventTargetManager;
+    evidentlyManager: aws.EvidentlyManager;
     iamManager: aws.IamManager;
     kmsManager: aws.KmsManager;
     lambdaManager: aws.LambdaManager;

package/dist/src/lib/common/construct.js

@@ -60,6 +60,7 @@ class CommonConstruct extends constructs_1.Construct {
     elasticacheManager;
     eventManager;
     eventTargetManager;
+    evidentlyManager;
     iamManager;
     kmsManager;
     lambdaManager;
@@ -92,6 +93,7 @@ class CommonConstruct extends constructs_1.Construct {
         this.elasticacheManager = new aws.ElastiCacheManager();
         this.eventManager = new aws.EventManager();
         this.eventTargetManager = new aws.EventTargetManager();
+        this.evidentlyManager = new aws.EvidentlyManager();
         this.iamManager = new aws.IamManager();
         this.kmsManager = new aws.KmsManager();
         this.lambdaManager = new aws.LambdaManager();

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

@@ -0,0 +1,60 @@
+import * as evidently from 'aws-cdk-lib/aws-evidently';
+import * as common from '../../common';
+import * as types from '../../types/aws';
+/**
+ * @stability stable
+ * @category cdk-utils.evidently-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Evidently.
+ * - 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
+ * 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.evidentlyManager.createProject('MyNewProhect', this, props)
+ *   }
+ * }
+ *
+ * @see [CDK Evidently Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_evidently-readme.html}
+ */
+export declare class EvidentlyManager {
+    /**
+     * @summary Method to create a project
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyProjectProps} props the project properties
+     */
+    createProject(id: string, scope: common.CommonConstruct, props: types.EvidentlyProjectProps): evidently.CfnProject;
+    /**
+     * @summary Method to create a feature
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyFeatureProps} props the feature properties
+     */
+    createFeature(id: string, scope: common.CommonConstruct, props: types.EvidentlyFeatureProps): evidently.CfnFeature;
+    /**
+     * @summary Method to create a launch
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyLaunchProps} props the launch properties
+     */
+    createLaunch(id: string, scope: common.CommonConstruct, props: types.EvidentlyLaunchProps): evidently.CfnLaunch;
+    /**
+     * @summary Method to create an experiment
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyExperimentProps} props the experiment properties
+     */
+    createExperiment(id: string, scope: common.CommonConstruct, props: types.EvidentlyExperimentProps): evidently.CfnExperiment;
+    /**
+     * @summary Method to create a segment
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlySegmentProps} props the segment properties
+     */
+    createSegment(id: string, scope: common.CommonConstruct, props: types.EvidentlySegmentProps): evidently.CfnSegment;
+}

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

@@ -0,0 +1,127 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EvidentlyManager = void 0;
+const evidently = __importStar(require("aws-cdk-lib/aws-evidently"));
+const utils = __importStar(require("../../utils"));
+/**
+ * @stability stable
+ * @category cdk-utils.evidently-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Evidently.
+ * - 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
+ * 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.evidentlyManager.createProject('MyNewProhect', this, props)
+ *   }
+ * }
+ *
+ * @see [CDK Evidently Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_evidently-readme.html}
+ */
+class EvidentlyManager {
+    /**
+     * @summary Method to create a project
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyProjectProps} props the project properties
+     */
+    createProject(id, scope, props) {
+        const project = new evidently.CfnProject(scope, `${id}`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            description: `${props.description} ${scope.props.stage}`,
+        });
+        utils.createCfnOutput(`${id}-projectArn`, scope, project.attrArn);
+        utils.createCfnOutput(`${id}-projectName`, scope, project.name);
+        return project;
+    }
+    /**
+     * @summary Method to create a feature
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyFeatureProps} props the feature properties
+     */
+    createFeature(id, scope, props) {
+        const feature = new evidently.CfnFeature(scope, `${id}`, props);
+        utils.createCfnOutput(`${id}-featureArn`, scope, feature.attrArn);
+        utils.createCfnOutput(`${id}-featureName`, scope, feature.name);
+        return feature;
+    }
+    /**
+     * @summary Method to create a launch
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyLaunchProps} props the launch properties
+     */
+    createLaunch(id, scope, props) {
+        const launch = new evidently.CfnLaunch(scope, `${id}`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            description: `${props.description} ${scope.props.stage}`,
+        });
+        utils.createCfnOutput(`${id}-launchArn`, scope, launch.attrArn);
+        utils.createCfnOutput(`${id}-launchName`, scope, launch.name);
+        return launch;
+    }
+    /**
+     * @summary Method to create an experiment
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlyExperimentProps} props the experiment properties
+     */
+    createExperiment(id, scope, props) {
+        const experiment = new evidently.CfnExperiment(scope, `${id}`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            description: `${props.description} ${scope.props.stage}`,
+        });
+        utils.createCfnOutput(`${id}-experimentArn`, scope, experiment.attrArn);
+        utils.createCfnOutput(`${id}-experimentName`, scope, experiment.name);
+        return experiment;
+    }
+    /**
+     * @summary Method to create a segment
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {EvidentlySegmentProps} props the segment properties
+     */
+    createSegment(id, scope, props) {
+        const segment = new evidently.CfnSegment(scope, `${id}`, {
+            ...props,
+            name: `${props.name}-${scope.props.stage}`,
+            description: `${props.description} ${scope.props.stage}`,
+        });
+        utils.createCfnOutput(`${id}-segmentArn`, scope, segment.attrArn);
+        utils.createCfnOutput(`${id}-segmentName`, scope, segment.name);
+        return segment;
+    }
+}
+exports.EvidentlyManager = EvidentlyManager;

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

@@ -13,6 +13,7 @@ export * from './eks-manager';
 export * from './elasticache-manager';
 export * from './event-manager';
 export * from './event-target-manager';
+export * from './evidently-manager';
 export * from './iam-manager';
 export * from './kms-manager';
 export * from './lambda-manager';

package/dist/src/lib/manager/aws/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./eks-manager"), exports);
 __exportStar(require("./elasticache-manager"), exports);
 __exportStar(require("./event-manager"), exports);
 __exportStar(require("./event-target-manager"), exports);
+__exportStar(require("./evidently-manager"), exports);
 __exportStar(require("./iam-manager"), exports);
 __exportStar(require("./kms-manager"), exports);
 __exportStar(require("./lambda-manager"), exports);

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

@@ -30,6 +30,7 @@ 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';
+import * as evidently from 'aws-cdk-lib/aws-evidently';
 /**
  * @category cdk-utils.app-config-manager
  * @subcategory Properties
@@ -740,6 +741,36 @@ export interface EventRuleProps extends events.RuleProps {
  */
 export interface EventBusProps extends events.EventBusProps {
 }
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyProjectProps extends evidently.CfnProjectProps {
+}
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyFeatureProps extends evidently.CfnFeatureProps {
+}
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyLaunchProps extends evidently.CfnLaunchProps {
+}
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyExperimentProps extends evidently.CfnExperimentProps {
+}
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlySegmentProps extends evidently.CfnSegmentProps {
+}
 /**
  * @category cdk-utils.common-stack
  * @subcategory Properties

package/package.json

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

package/src/lib/common/construct.ts

@@ -37,6 +37,7 @@ export class CommonConstruct extends Construct {
   elasticacheManager: aws.ElastiCacheManager
   eventManager: aws.EventManager
   eventTargetManager: aws.EventTargetManager
+  evidentlyManager: aws.EvidentlyManager
   iamManager: aws.IamManager
   kmsManager: aws.KmsManager
   lambdaManager: aws.LambdaManager
@@ -71,6 +72,7 @@ export class CommonConstruct extends Construct {
     this.elasticacheManager = new aws.ElastiCacheManager()
     this.eventManager = new aws.EventManager()
     this.eventTargetManager = new aws.EventTargetManager()
+    this.evidentlyManager = new aws.EvidentlyManager()
     this.iamManager = new aws.IamManager()
     this.kmsManager = new aws.KmsManager()
     this.lambdaManager = new aws.LambdaManager()

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

@@ -0,0 +1,108 @@
+import * as evidently from 'aws-cdk-lib/aws-evidently'
+import * as common from '../../common'
+import * as types from '../../types/aws'
+import * as utils from '../../utils'
+import { EvidentlyExperimentProps, EvidentlySegmentProps } from '../../types'
+
+/**
+ * @stability stable
+ * @category cdk-utils.evidently-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Evidently.
+ * - 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
+ * 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.evidentlyManager.createProject('MyNewProhect', this, props)
+ *   }
+ * }
+ *
+ * @see [CDK Evidently Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_evidently-readme.html}
+ */
+export class EvidentlyManager {
+  /**
+   * @summary Method to create a project
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {EvidentlyProjectProps} props the project properties
+   */
+  public createProject(id: string, scope: common.CommonConstruct, props: types.EvidentlyProjectProps) {
+    const project = new evidently.CfnProject(scope, `${id}`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      description: `${props.description} ${scope.props.stage}`,
+    })
+    utils.createCfnOutput(`${id}-projectArn`, scope, project.attrArn)
+    utils.createCfnOutput(`${id}-projectName`, scope, project.name)
+    return project
+  }
+
+  /**
+   * @summary Method to create a feature
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {EvidentlyFeatureProps} props the feature properties
+   */
+  public createFeature(id: string, scope: common.CommonConstruct, props: types.EvidentlyFeatureProps) {
+    const feature = new evidently.CfnFeature(scope, `${id}`, props)
+    utils.createCfnOutput(`${id}-featureArn`, scope, feature.attrArn)
+    utils.createCfnOutput(`${id}-featureName`, scope, feature.name)
+    return feature
+  }
+
+  /**
+   * @summary Method to create a launch
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {EvidentlyLaunchProps} props the launch properties
+   */
+  public createLaunch(id: string, scope: common.CommonConstruct, props: types.EvidentlyLaunchProps) {
+    const launch = new evidently.CfnLaunch(scope, `${id}`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      description: `${props.description} ${scope.props.stage}`,
+    })
+    utils.createCfnOutput(`${id}-launchArn`, scope, launch.attrArn)
+    utils.createCfnOutput(`${id}-launchName`, scope, launch.name)
+    return launch
+  }
+
+  /**
+   * @summary Method to create an experiment
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {EvidentlyExperimentProps} props the experiment properties
+   */
+  public createExperiment(id: string, scope: common.CommonConstruct, props: types.EvidentlyExperimentProps) {
+    const experiment = new evidently.CfnExperiment(scope, `${id}`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      description: `${props.description} ${scope.props.stage}`,
+    })
+    utils.createCfnOutput(`${id}-experimentArn`, scope, experiment.attrArn)
+    utils.createCfnOutput(`${id}-experimentName`, scope, experiment.name)
+    return experiment
+  }
+
+  /**
+   * @summary Method to create a segment
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {EvidentlySegmentProps} props the segment properties
+   */
+  public createSegment(id: string, scope: common.CommonConstruct, props: types.EvidentlySegmentProps) {
+    const segment = new evidently.CfnSegment(scope, `${id}`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      description: `${props.description} ${scope.props.stage}`,
+    })
+    utils.createCfnOutput(`${id}-segmentArn`, scope, segment.attrArn)
+    utils.createCfnOutput(`${id}-segmentName`, scope, segment.name)
+    return segment
+  }
+}

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

@@ -13,6 +13,7 @@ export * from './eks-manager'
 export * from './elasticache-manager'
 export * from './event-manager'
 export * from './event-target-manager'
+export * from './evidently-manager'
 export * from './iam-manager'
 export * from './kms-manager'
 export * from './lambda-manager'

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

@@ -30,6 +30,8 @@ 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'
+import * as evidently from 'aws-cdk-lib/aws-evidently'
+import { CfnExperimentProps, CfnFeatureProps, CfnSegmentProps } from 'aws-cdk-lib/aws-evidently/lib/evidently.generated'
 
 /**
  * @category cdk-utils.app-config-manager
@@ -791,6 +793,36 @@ export interface EventRuleProps extends events.RuleProps {
  */
 export interface EventBusProps extends events.EventBusProps {}
 
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyProjectProps extends evidently.CfnProjectProps {}
+
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyFeatureProps extends evidently.CfnFeatureProps {}
+
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyLaunchProps extends evidently.CfnLaunchProps {}
+
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlyExperimentProps extends evidently.CfnExperimentProps {}
+
+/**
+ * @category cdk-utils.evidently-manager
+ * @subcategory Properties
+ */
+export interface EvidentlySegmentProps extends evidently.CfnSegmentProps {}
+
 /**
  * @category cdk-utils.common-stack
  * @subcategory Properties