@gradientedge/cdk-utils 4.0.13 → 4.1.2

package/src/lib/manager/acmManager.ts

@@ -19,9 +19,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.acmManager.createCertificate('MyCertificate', this)
+ *   }
  * }
  *
- * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-certificatemanager-readme.html}
+ * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
  */
 export class AcmManager {
   /**

package/src/lib/manager/apiManager.ts

@@ -19,9 +19,10 @@ import { createCfnOutput } from '../utils'
  *     this.props = props
  *     const lambdaFunction = this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
  *     this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
+ *   }
  * }
  *
- * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-apigateway-readme.html}
+ * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
  */
 export class ApiManager {
   /**

package/src/lib/manager/appConfigManager.ts

@@ -45,9 +45,10 @@ export const ArnsByRegion: { [key: string]: string } = {
  *     super(parent, id, props)
  *     this.props = props
  *     this.appConfigManager.createApplication('MyApplication', this)
+ *   }
  * }
  *
- * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-appconfig-readme.html}
+ * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
  */
 export class AppConfigManager {
   /**

package/src/lib/manager/cloudFrontManager.ts

@@ -32,9 +32,10 @@ import * as cr from 'aws-cdk-lib/custom-resources'
  *       originAccessIdentity,
  *       certificate
  *     )
+ *   }
  * }
  *
- * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cloudfront-readme.html}
+ * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 export class CloudFrontManager {
   public createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: s3.IBucket) {

package/src/lib/manager/cloudTrailManager.ts

@@ -26,9 +26,10 @@ import { createCfnOutput } from '../utils'
  *       logBucket,
  *       logBucketPolicy
  *     )
+ *   }
  * }
  *
- * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cloudtrail-readme.html}
+ * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
  */
 export class CloudTrailManager {
   /**

package/src/lib/manager/cloudWatchManager.ts

@@ -28,9 +28,10 @@ import { CloudWatchWidgetType, createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.cloudWatchManager.createAlarmForMetric('MyAlarm', this, metric)
+ *   }
  * }
  *
- * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-cloudwatch-readme.html}
+ * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
  */
 export class CloudWatchManager {
   /**

package/src/lib/manager/codeBuildManager.ts

@@ -3,7 +3,23 @@ import * as codebuild from 'aws-cdk-lib/aws-codebuild'
 import * as cdk from 'aws-cdk-lib'
 
 /**
+ * @stability stable
+ * @category Developer Tools
+ * @summary Provides operations on AWS Code Build.
+ * - A new instance of this class is injected into {@link CommonConstruct} constructor.
+ * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.codeBuildManager.createImageForCloudfrontInvalidation('MyInvalidation', this, './docker ')
+ *   }
+ * }
+ *
+ * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
  */
 export class CodeBuildManager {
   /**

package/src/lib/manager/ecrManager.ts

@@ -16,9 +16,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.ecrManager.createDockerImage('MyImage', this, dockerfilePath)
+ *   }
  * }
  *
- * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ecr-readme.html}
+ * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
  */
 export class EcrManager {
   /**

package/src/lib/manager/ecsManager.ts

@@ -20,9 +20,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.ecsManager.createEcsCluster('MyCluster', this, vpc)
+ *   }
  * }
  *
- * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ecs-readme.html}
+ * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
  */
 export class EcsManager {
   /**

package/src/lib/manager/eksManager.ts

@@ -19,9 +19,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.eksManager.createEksDeployment('MyEksDeployment', this, image, vpc)
+ *   }
  * }
  *
- * @see [CDK EKS Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-eks-readme.html}
+ * @see [CDK EKS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks-readme.html}
  */
 export class EksManager {
   /**

package/src/lib/manager/eventManager.ts

@@ -20,9 +20,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.eventManager.createLambdaRule('MyLambdaRule', this, lambdaFunction)
+ *   }
  * }
  *
- * @see [CDK EventBridge Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-events-readme.html}
+ * @see [CDK EventBridge Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events-readme.html}
  */
 export class EventManager {
   /**

package/src/lib/manager/iamManager.ts

@@ -20,9 +20,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.iamManager.createRoleForEcsEvent('MyEcsRole', this, cluster, task)
+ *   }
  * }
  *
- * @see [CDK IAM Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-iam-readme.html}
+ * @see [CDK IAM Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam-readme.html}
  */
 export class IamManager {
   /**

package/src/lib/manager/lambdaManager.ts

@@ -23,9 +23,10 @@ import { CloudFrontManager } from './cloudFrontManager'
  *     super(parent, id, props)
  *     this.props = props
  *     this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
+ *   }
  * }
  *
- * @see [CDK Lambda Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-readme.html}
+ * @see [CDK Lambda Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda-readme.html}
  */
 export class LambdaManager {
   /**

package/src/lib/manager/logManager.ts

@@ -18,9 +18,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.logsManager.createMetricFilter('MyMetricFilter', this, logGroup)
+ *   }
  * }
  *
- * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-logs-readme.html}
+ * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
  */
 export class LogManager {
   /**

package/src/lib/manager/route53Manager.ts

@@ -20,9 +20,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.route53Manager.createHostedZone('MyHostedZone', this)
+ *   }
  * }
  *
- * @see [CDK Route53 Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-route53-readme.html}
+ * @see [CDK Route53 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53-readme.html}
  */
 export class Route53Manager {
   /**

package/src/lib/manager/s3Manager.ts

@@ -4,7 +4,7 @@ import * as iam from 'aws-cdk-lib/aws-iam'
 import * as s3 from 'aws-cdk-lib/aws-s3'
 import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
 import { CommonConstruct } from '../common/commonConstruct'
-import { S3BucketProps } from '../types'
+import { LifecycleRule, S3BucketProps } from '../types'
 import { createCfnOutput } from '../utils'
 
 /**
@@ -21,11 +21,66 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.s3Manager.createS3Bucket('MyBucket', this)
+ *   }
  * }
  *
- * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-readme.html}
+ * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
  */
 export class S3Manager {
+  /**
+   * @summary Method to determine S3 Bucket lifecycle properties
+   * @param {S3BucketProps} props bucket properties
+   * @private
+   */
+  protected determineBucketLifecycleRules(props: S3BucketProps) {
+    if (!props.lifecycleRules) return undefined
+
+    const bucketLifecycleRules: LifecycleRule[] = []
+    props.lifecycleRules.forEach(lifecycleRule => {
+      bucketLifecycleRules.push({
+        id: lifecycleRule.id,
+        enabled: lifecycleRule.enabled,
+        abortIncompleteMultipartUploadAfter: lifecycleRule.abortIncompleteMultipartUploadAfter,
+        expirationDate: lifecycleRule.expirationDate,
+        expiration: lifecycleRule.expirationInDays ? cdk.Duration.days(lifecycleRule.expirationInDays) : undefined,
+        noncurrentVersionExpiration: lifecycleRule.noncurrentVersionExpirationInDays
+          ? cdk.Duration.days(lifecycleRule.noncurrentVersionExpirationInDays)
+          : undefined,
+        noncurrentVersionTransitions: lifecycleRule.noncurrentVersionTransitions,
+        transitions: lifecycleRule.transitions,
+        prefix: lifecycleRule.prefix,
+        tagFilters: lifecycleRule.tagFilters,
+        expiredObjectDeleteMarker: lifecycleRule.expiredObjectDeleteMarker,
+      })
+    })
+
+    return bucketLifecycleRules
+  }
+
+  /**
+   * @summary Method to determine the bucket name
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {S3BucketProps} props bucket properties
+   * @private
+   */
+  protected static determineBucketName(scope: CommonConstruct, props: S3BucketProps) {
+    return scope.isProductionStage()
+      ? `${props.bucketName}.${scope.fullyQualifiedDomainName}`
+      : `${props.bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
+  }
+
+  /**
+   * @summary Method to determine the log bucket name
+   * @param {CommonConstruct} scope scope in which this resource is defined
+   * @param {S3BucketProps} props bucket properties
+   * @private
+   */
+  protected static determineLogBucketName(scope: CommonConstruct, props: S3BucketProps) {
+    return scope.isProductionStage()
+      ? `${props.logBucketName}.${scope.fullyQualifiedDomainName}`
+      : `${props.logBucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
+  }
+
   /**
    * @summary Method to create a s3 bucket
    * @param {string} id scoped id of the resource
@@ -37,18 +92,14 @@ export class S3Manager {
 
     let bucket: s3.IBucket
 
-    const bucketName = scope.isProductionStage()
-      ? `${props.bucketName}.${scope.fullyQualifiedDomainName}`
-      : `${props.bucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
+    const bucketName = S3Manager.determineBucketName(scope, props)
 
     if (props.existingBucket && props.bucketName) {
       bucket = s3.Bucket.fromBucketName(scope, `${id}`, bucketName)
     } else {
       let logBucket
       if (props.logBucketName) {
-        const logBucketName = scope.isProductionStage()
-          ? `${props.logBucketName}.${scope.fullyQualifiedDomainName}`
-          : `${props.logBucketName}-${scope.props.stage}.${scope.fullyQualifiedDomainName}`
+        const logBucketName = S3Manager.determineLogBucketName(scope, props)
         logBucket = s3.Bucket.fromBucketName(scope, `${id}-logs`, logBucketName)
       }
 
@@ -60,7 +111,7 @@ export class S3Manager {
         cors: props.cors,
         encryption: props.encryption || s3.BucketEncryption.S3_MANAGED,
         encryptionKey: props.encryptionKey,
-        lifecycleRules: props.lifecycleRules,
+        lifecycleRules: this.determineBucketLifecycleRules(props),
         metrics: props.metrics,
         publicReadAccess: props.publicReadAccess,
         removalPolicy: props.removalPolicy || cdk.RemovalPolicy.RETAIN,
@@ -71,6 +122,13 @@ export class S3Manager {
         websiteRoutingRules: props.websiteRoutingRules,
         versioned: props.versioned,
       })
+
+      const cfnBucket = bucket.node.defaultChild as s3.CfnBucket
+      cfnBucket.notificationConfiguration = {
+        eventBridgeConfiguration: {
+          eventBridgeEnabled: props.enableEventBridge ?? false,
+        },
+      }
     }
 
     createCfnOutput(`${id}-bucketName`, scope, bucket.bucketName)

package/src/lib/manager/secretsManager.ts

@@ -18,10 +18,11 @@ const fs = require('fs')
  *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
- *     this.s3Manager.loadSecret('MySecretName', 'eu-west-1')
+ *     this.secretsManager.loadSecret('MySecretName', 'eu-west-1')
+ *   }
  * }
  *
- * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-secretsmanager-readme.html}
+ * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager-readme.html}
  */
 export class SecretsManager {
   /**

package/src/lib/manager/snsManager.ts

@@ -19,9 +19,10 @@ import { createCfnOutput } from '../utils'
  *     super(parent, id, props)
  *     this.props = props
  *     this.snsManager.createEmailNotificationService('MySns', 'eu-west-1', ['test@example.com'])
+ *   }
  * }
  *
- * @see [CDK Simple Notification Service Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-sns-readme.html}
+ * @see [CDK Simple Notification Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html}
  */
 export class SnsManager {
   /**

package/src/lib/manager/ssmManager.ts

@@ -18,9 +18,10 @@ import { SSMParameterReaderProps } from '../types'
  *     super(parent, id, props)
  *     this.props = props
  *     this.acmManager.writeStringToParameters('MyParameter', this, ...props)
+ *   }
  * }
  *
- * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ssm-readme.html}
+ * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
  */
 export class SsmManager {
   /**

package/src/lib/manager/vpcManager.ts

@@ -22,9 +22,10 @@ const CommonVpcIdentifier = 'CommonVpc'
  *     super(parent, id, props)
  *     this.props = props
  *     this.vpcManager.createVpc('MyVPC', this)
+ *   }
  * }
  *
- * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Vpc.html}
+ * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-ec2.Vpc.html}
  */
 export class VpcManager {
   /**

package/src/lib/manager/wafManager.ts

@@ -17,9 +17,10 @@ import { WafIPSetProps, WafWebACLProps } from '../types'
  *     super(parent, id, props)
  *     this.props = props
  *     this.wafManager.createWebAcl('MyWebAcl', this)
+ *   }
  * }
  *
- * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/latest/docs/aws-waf-readme.html}
+ * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
  */
 export class WafManager {
   /**

package/src/lib/types.ts

@@ -268,10 +268,17 @@ export interface Route53Props extends route53.HostedZoneProps {
   useExistingHostedZone?: boolean
 }
 
+export interface LifecycleRule extends s3.LifecycleRule {
+  expirationInDays?: number
+  noncurrentVersionExpirationInDays?: number
+}
+
 /**
  * @category Storage
  */
 export interface S3BucketProps extends s3.BucketProps {
+  enableEventBridge?: boolean
+  lifecycleRules?: LifecycleRule[]
   bucketName: string
   logBucketName?: string
   existingBucket?: boolean