@gradientedge/cdk-utils 4.3.1 → 4.4.2

package/src/lib/construct/{siteWithEcsBackend.ts → site-with-ecs-backend/main.ts}

@@ -12,13 +12,14 @@ import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager'
 import { Construct } from 'constructs'
-import { CommonConstruct } from '../common/commonConstruct'
-import { SiteWithEcsBackendProps } from '../types'
+import { CommonConstruct } from '../../common'
+import { SiteWithEcsBackendProps } from '../../types'
 
 /**
  * @stability stable
- * @category Constructs
- * @summary Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
+ * @category cdk-utils.site-with-ecs-backend
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
  *
  * @example
  * import { SiteWithEcsBackend, SiteWithEcsBackendProps } '@gradientedge/cdk-utils'
@@ -32,12 +33,6 @@ import { SiteWithEcsBackendProps } from '../types'
  *     this.initResources()
  *   }
  * }
- *
- * @mermaid
- *   graph LR;
- *     A[StaticSite]-.->|extends|B(CommonConstruct);
- *     B(CommonConstruct)-->|extends|C(Construct);
- *     C(Construct)-->|implements|D(IConstruct);
  */
 export class SiteWithEcsBackend extends CommonConstruct {
   /* site properties */
@@ -50,7 +45,7 @@ export class SiteWithEcsBackend extends CommonConstruct {
   siteEcsPolicy: iam.PolicyDocument
   siteEcsRole: iam.Role
   siteEcsEnvironment: { [key: string]: string }
-  siteVpc: ec2.Vpc
+  siteVpc: ec2.IVpc
   siteSecrets: any
   siteEcsCluster: ecs.Cluster
   siteEcsLogGroup: logs.LogGroup
@@ -71,12 +66,6 @@ export class SiteWithEcsBackend extends CommonConstruct {
   siteCloudfrontFunction: cloudfront.Function
   siteFunctionAssociations: cloudfront.FunctionAssociation[]
 
-  /**
-   * @summary Constructor to initialise the SiteWithEcsBackend Construct
-   * @param {Construct} parent
-   * @param {string} id
-   * @param {SiteWithEcsBackendProps} props
-   */
   constructor(parent: Construct, id: string, props: SiteWithEcsBackendProps) {
     super(parent, id, props)
 

package/src/lib/construct/static-site/index.ts

@@ -0,0 +1 @@
+export * from './main'

package/src/lib/construct/{staticSite.ts → static-site/main.ts}

@@ -4,13 +4,14 @@ import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
 import * as route53 from 'aws-cdk-lib/aws-route53'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import { Construct } from 'constructs'
-import { CommonConstruct } from '../common/commonConstruct'
-import { StaticSiteProps } from '../types'
+import { CommonConstruct } from '../../common'
+import { StaticSiteProps } from '../../types'
 
 /**
  * @stability stable
- * @category Constructs
- * @summary Provides a construct to create and deploy a s3 hosted static site
+ * @category cdk-utils.static-site
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy a s3 hosted static site
  *
  * @example
  * import { StaticSite, StaticSiteProps } '@gradientedge/cdk-utils'
@@ -24,12 +25,6 @@ import { StaticSiteProps } from '../types'
  *     this.initResources()
  *   }
  * }
- *
- * @mermaid
- *   graph LR;
- *     A[StaticSite]-.->|extends|B(CommonConstruct);
- *     B(CommonConstruct)-->|extends|C(Construct);
- *     C(Construct)-->|implements|D(IConstruct);
  */
 export class StaticSite extends CommonConstruct {
   /* static site properties */
@@ -49,12 +44,6 @@ export class StaticSite extends CommonConstruct {
   siteCloudfrontFunction: cloudfront.Function
   siteFunctionAssociations: cloudfront.FunctionAssociation[]
 
-  /**
-   * @summary Constructor to initialise the StaticSite Construct
-   * @param {Construct} parent
-   * @param {string} id
-   * @param {StaticSiteProps} props
-   */
   constructor(parent: Construct, id: string, props: StaticSiteProps) {
     super(parent, id, props)
 

package/src/lib/manager/aws/{acmManager.ts → acm-manager.ts}

@@ -7,8 +7,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Security, Identity & Compliance
- * @summary Provides operations on AWS Certificates.
+ * @category cdk-utils.acm-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Certificates.
  * - 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/{apiManager.ts → api-manager.ts}

@@ -6,8 +6,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Networking & Content Delivery
- * @summary Provides operations on AWS API Gateway.
+ * @category cdk-utils.api-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS API Gateway.
  * - 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
@@ -29,7 +30,7 @@ export class ApiManager {
    * @summary Method to create a Rest API with Lambda backend/target
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
-   * @param {AcmProps} props lambda rest api props
+   * @param {AcmProps} props lambda rest restApi props
    * @param lambdaFunction
    */
   public createLambdaRestApi(
@@ -80,11 +81,11 @@ export class ApiManager {
   }
 
   /**
-   * @summary Method to create custom api domain
+   * @summary Method to create custom restApi domain
    * @param {string} id scoped id of the resource
    * @param {common.CommonConstruct} scope scope in which this resource is defined
    * @param domainName the domain name to use
-   * @param certificate the certificate used for custom api domain
+   * @param certificate the certificate used for custom restApi domain
    */
   public createApiDomain(id: string, scope: common.CommonConstruct, domainName: string, certificate: acm.ICertificate) {
     const apiDomain = new apig.DomainName(scope, `${id}`, {

package/src/lib/manager/aws/{appConfigManager.ts → app-config-manager.ts}

@@ -6,7 +6,8 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Utils
+ * @category cdk-utils.app-config-manager
+ * @subcategory Construct
  * @returns { Map<string, string> } ArnsByRegion
  */
 export const ArnsByRegion: { [key: string]: string } = {
@@ -33,8 +34,9 @@ export const ArnsByRegion: { [key: string]: string } = {
 }
 
 /**
- * @category Management & Governance
- * @summary Provides operations on AWS AppConfig.
+ * @category cdk-utils.app-config-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS AppConfig.
  * - 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/{cloudFrontManager.ts → cloudfront-manager.ts}

@@ -13,8 +13,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Networking & Content Delivery
- * @summary Provides operations on AWS CloudFront.
+ * @category cdk-utils.cloudfront-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS CloudFront.
  * - 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/{cloudTrailManager.ts → cloudtrail-manager.ts}

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

@@ -6,7 +6,8 @@ import * as types from '../../types'
 import * as utils from '../../utils'
 
 /**
- * @category Utils
+ * @category cdk-utils.cloudwatch-manager
+ * @subcategory Construct
  */
 enum CloudWatchWidgetType {
   Text = 'Text',
@@ -18,8 +19,9 @@ enum CloudWatchWidgetType {
 
 /**
  * @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/{codeBuildManager.ts → codebuild-manager.ts}

@@ -4,8 +4,9 @@ import * as common from '../../common'
 
 /**
  * @stability stable
- * @category Developer Tools
- * @summary Provides operations on AWS Code Build.
+ * @category cdk-utils.codebuild-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Code Build.
  * - 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/{dynamodbManager.ts → dynamodb-manager.ts}

@@ -5,8 +5,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Storage
- * @summary Provides operations on AWS DynamoDB.
+ * @category cdk-utils.dynamodb-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS DynamoDB.
  * - 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/{ecrManager.ts → ecr-manager.ts}

@@ -4,8 +4,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Containers
- * @summary Provides operations on AWS Elastic Container Registry.
+ * @category cdk-utils.ecr-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Elastic Container Registry.
  * - 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/{ecsManager.ts → ecs-manager.ts}

@@ -8,8 +8,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Containers
- * @summary Provides operations on AWS Elastic Container Service.
+ * @category cdk-utils.ecs-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Elastic Container 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/{eksManager.ts → eks-manager.ts}

@@ -7,8 +7,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Containers
- * @summary Provides operations on AWS Elastic Kubernetes Service.
+ * @category cdk-utils.eks-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS Elastic Kubernetes 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/{eventManager.ts → event-manager.ts}

@@ -8,8 +8,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Application Integration
- * @summary Provides operations on AWS EventBridge.
+ * @category cdk-utils.event-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS EventBridge.
  * - 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
@@ -26,6 +27,60 @@ import * as utils from '../../utils'
  * @see [CDK EventBridge Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events-readme.html}
  */
 export class EventManager {
+  /**
+   * Method to create an event bus
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.EventBusProps} props event bus properties
+   */
+  public createEventBus(id: string, scope: common.CommonConstruct, props: types.EventBusProps) {
+    if (!props) throw 'EventBus props undefined'
+
+    const eventBus = new events.EventBus(scope, `${id}`, {
+      eventBusName: `${props.eventBusName}-${scope.props.stage}`,
+    })
+
+    utils.createCfnOutput(`${id}-eventBusName`, scope, eventBus.eventBusName)
+    utils.createCfnOutput(`${id}-eventBusArn`, scope, eventBus.eventBusArn)
+
+    return eventBus
+  }
+
+  /**
+   * Method to create an event rule
+   * @param {string} id scoped id of the resource
+   * @param {common.CommonConstruct} scope scope in which this resource is defined
+   * @param {types.EventRuleProps} props event rule properties
+   * @param {events.IEventBus?} eventBus optional custom event bus
+   * @param {events.IRuleTarget[]?} targets optional event targets
+   */
+  public createRule(
+    id: string,
+    scope: common.CommonConstruct,
+    props: types.EventRuleProps,
+    eventBus?: events.IEventBus,
+    targets?: events.IRuleTarget[]
+  ) {
+    if (!props) throw `EventRule props undefined`
+
+    const rule = new events.Rule(scope, `${id}`, {
+      eventBus: eventBus,
+      description: props.description,
+      ruleName: `${props.ruleName}-${scope.props.stage}`,
+      eventPattern: props.eventPattern,
+    })
+
+    if (targets && targets.length > 0) {
+      targets.forEach(target => {
+        rule.addTarget(target)
+      })
+    }
+
+    utils.createCfnOutput(`${id}-ruleArn`, scope, rule.ruleArn)
+    utils.createCfnOutput(`${id}-ruleName`, scope, rule.ruleName)
+
+    return rule
+  }
   /**
    * @summary Method to create an eventbridge rule with lambda target
    * @param {string} id scoped id of the resource

package/src/lib/manager/aws/{iamManager.ts → iam-manager.ts}

@@ -8,8 +8,9 @@ import * as utils from '../../utils'
 
 /**
  * @stability stable
- * @category Security, Identity & Compliance
- * @summary Provides operations on AWS IAM.
+ * @category cdk-utils.iam-manager
+ * @subcategory Construct
+ * @classdesc Provides operations on AWS IAM.
  * - 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
@@ -38,11 +39,21 @@ export class IamManager {
     })
   }
 
+  /**
+   * @summary Method to create iam statement to put events
+   */
+  public statementForPutEvents() {
+    return new iam.PolicyStatement({
+      effect: iam.Effect.ALLOW,
+      actions: ['events:PutEvents'],
+      resources: ['*'],
+    })
+  }
+
   /**
    * @summary Method to create iam statement to read app config
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForReadAnyAppConfig(scope: common.CommonConstruct) {
+  public statementForReadAnyAppConfig() {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: [
@@ -78,9 +89,8 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to list all s3 buckets
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForListAllMyBuckets(scope: common.CommonConstruct) {
+  public statementForListAllMyBuckets() {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['s3:ListAllMyBuckets'],
@@ -129,9 +139,8 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to pass iam role
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForPassRole(scope: common.CommonConstruct) {
+  public statementForPassRole() {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['iam:PassRole'],
@@ -141,9 +150,8 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to invalidate cloudfront cache
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForCloudfrontInvalidation(scope: common.CommonConstruct) {
+  public statementForCloudfrontInvalidation() {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['cloudfront:GetInvalidation', 'cloudfront:CreateInvalidation'],
@@ -153,14 +161,13 @@ export class IamManager {
 
   /**
    * @summary Method to create iam policy to invalidate cloudfront cache
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public policyForCloudfrontInvalidation(scope: common.CommonConstruct) {
+  public policyForCloudfrontInvalidation() {
     return new iam.PolicyDocument({
       statements: [
         this.statementForCreateAnyLogStream(),
         this.statementForPutAnyLogEvent(),
-        this.statementForCloudfrontInvalidation(scope),
+        this.statementForCloudfrontInvalidation(),
         new iam.PolicyStatement({
           effect: iam.Effect.ALLOW,
           actions: [
@@ -184,7 +191,7 @@ export class IamManager {
     return new iam.Role(scope, `${id}-install-deps-project-role`, {
       assumedBy: new iam.ServicePrincipal('codebuild.amazonaws.com'),
       inlinePolicies: {
-        codeBuildPolicy: this.policyForCloudfrontInvalidation(scope),
+        codeBuildPolicy: this.policyForCloudfrontInvalidation(),
       },
     })
   }
@@ -204,9 +211,8 @@ export class IamManager {
 
   /**
    * @summary Method to create iam statement to pass ecs role
-   * @param {common.CommonConstruct} scope scope in which this resource is defined
    */
-  public statementForEcsPassRole(scope: common.CommonConstruct) {
+  public statementForEcsPassRole() {
     return new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ['iam:PassRole'],
@@ -331,7 +337,7 @@ export class IamManager {
     task: ecs.ITaskDefinition
   ) {
     const policy = new iam.PolicyDocument({
-      statements: [this.statementForRunEcsTask(scope, cluster, task), this.statementForEcsPassRole(scope)],
+      statements: [this.statementForRunEcsTask(scope, cluster, task), this.statementForEcsPassRole()],
     })
 
     const role = new iam.Role(scope, `${id}`, {

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

@@ -1,22 +1,22 @@
-export * from './acmManager'
-export * from './apiManager'
-export * from './appConfigManager'
-export * from './cloudFrontManager'
-export * from './cloudTrailManager'
-export * from './cloudWatchManager'
-export * from './codeBuildManager'
-export * from './dynamodbManager'
-export * from './ecrManager'
-export * from './ecsManager'
-export * from './eksManager'
-export * from './eventManager'
-export * from './iamManager'
-export * from './lambdaManager'
-export * from './logManager'
-export * from './route53Manager'
-export * from './s3Manager'
-export * from './secretsManager'
-export * from './snsManager'
-export * from './ssmManager'
-export * from './vpcManager'
-export * from './wafManager'
+export * from './acm-manager'
+export * from './api-manager'
+export * from './app-config-manager'
+export * from './cloudfront-manager'
+export * from './cloudtrail-manager'
+export * from './cloudwatch-manager'
+export * from './codebuild-manager'
+export * from './dynamodb-manager'
+export * from './ecr-manager'
+export * from './ecs-manager'
+export * from './eks-manager'
+export * from './event-manager'
+export * from './iam-manager'
+export * from './lambda-manager'
+export * from './log-manager'
+export * from './route53-manager'
+export * from './s3-manager'
+export * from './secrets-manager'
+export * from './sns-manager'
+export * from './ssm-manager'
+export * from './vpc-manager'
+export * from './waf-manager'