@gradientedge/cdk-utils 10.7.0 → 11.0.0

package/src/lib/aws/services/appconfig/main.ts

@@ -1,155 +0,0 @@
-import { Fn } from 'aws-cdk-lib'
-import {
-  CfnApplication,
-  CfnConfigurationProfile,
-  CfnEnvironment,
-  DeploymentStrategy,
-  RolloutStrategy,
-} from 'aws-cdk-lib/aws-appconfig'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { Architecture } from '../constants.js'
-import { ArnsByRegionForArm64, ArnsByRegionForX86_64 } from './constants.js'
-import { AppConfigProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS
- * - 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: Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.appConfigManager.createApplication('MyApplication', this)
- *   }
- * }
- * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
- */
-export class AppConfigManager {
-  /**
-   * Method to get static ARNs for AppConfig extensions
-   * @param scope scope in which this resource is defined
-   * @param type type of the architecture
-   */
-  public getArnForAppConfigExtension(scope: CommonConstruct, type: Architecture) {
-    switch (type) {
-      case Architecture.ARM_64:
-        return ArnsByRegionForArm64[scope.props.region]
-      case Architecture.X86_64:
-        return ArnsByRegionForX86_64[scope.props.region]
-      default:
-        throw `Invalid type ${type} specified`
-    }
-  }
-
-  /**
-   * @summary Method to create an AppConfig Application
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   * @returns the appconfig application
-   */
-  public createApplication(id: string, scope: CommonConstruct, props: AppConfigProps): CfnApplication {
-    if (!props) throw `AppConfig props undefined for ${id}`
-
-    const application = new CfnApplication(scope, `${id}`, {
-      ...props.application,
-      name: scope.resourceNameFormatter.format(props.application.name, scope.props.resourceNameOptions?.appconfig),
-    })
-
-    createCfnOutput(`${id}-ApplicationId`, scope, Fn.ref(application.logicalId))
-    createCfnOutput(`${id}-ApplicationName`, scope, application.name)
-
-    return application
-  }
-
-  /**
-   * @summary Method to create an AppConfig Environment for a given application
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param applicationId id of the application
-   * @param props
-   * @returns the appconfig environment
-   */
-  public createEnvironment(
-    id: string,
-    scope: CommonConstruct,
-    applicationId: string,
-    props: AppConfigProps
-  ): CfnEnvironment {
-    if (!props) throw `AppConfig props undefined for ${id}`
-
-    const environment = new CfnEnvironment(scope, `${id}`, {
-      ...props.environment,
-      applicationId,
-      name: props.environment.name ?? scope.props.stage,
-    })
-
-    createCfnOutput(`${id}-configurationEnvironmentId`, scope, Fn.ref(environment.logicalId))
-    createCfnOutput(`${id}-configurationEnvironmentName`, scope, environment.name)
-
-    return environment
-  }
-
-  /**
-   * @summary Method to create an AppConfig Configuration Profile for a given application
-   * - The <b>locationUri</b> is defaulted to <i>hosted</i> if undefined</p>
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param applicationId id of the application
-   * @param props
-   * @returns the appconfig configuration profile
-   */
-  public createConfigurationProfile(
-    id: string,
-    scope: CommonConstruct,
-    applicationId: string,
-    props: AppConfigProps
-  ): CfnConfigurationProfile {
-    if (!props) throw `AppConfig props undefined for ${id}`
-
-    const profile = new CfnConfigurationProfile(scope, `${id}`, {
-      ...props.configurationProfile,
-      applicationId,
-      locationUri: props.configurationProfile.locationUri || 'hosted',
-      name: scope.resourceNameFormatter.format(
-        props.configurationProfile.name,
-        scope.props.resourceNameOptions?.appconfig
-      ),
-    })
-
-    createCfnOutput(`${id}-configurationProfileId`, scope, Fn.ref(profile.logicalId))
-    createCfnOutput(`${id}-configurationProfileName`, scope, profile.name)
-
-    return profile
-  }
-
-  /**
-   * @summary Method to create an AppConfig Deployment Strategy
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   * @returns the appconfig deployment strategy
-   */
-  public createDeploymentStrategy(id: string, scope: CommonConstruct, props: AppConfigProps): DeploymentStrategy {
-    if (!props) throw `AppConfig props undefined for ${id}`
-    if (!props.deploymentStrategy) throw `AppConfig deploymentStrategy props undefined for ${id}`
-
-    const deploymentStrategy = new DeploymentStrategy(scope, `${id}`, {
-      ...props,
-      deploymentStrategyName: scope.resourceNameFormatter.format(
-        props.deploymentStrategy.deploymentStrategyName ?? 'common-deployment-strategy',
-        scope.props.resourceNameOptions?.appconfig
-      ),
-      rolloutStrategy: props.deploymentStrategy.rolloutStrategy ?? RolloutStrategy.ALL_AT_ONCE,
-    })
-
-    createCfnOutput(`${id}-deploymentStrategyId`, scope, deploymentStrategy.deploymentStrategyId)
-    createCfnOutput(`${id}-deploymentStrategyArn`, scope, deploymentStrategy.deploymentStrategyArn)
-
-    return deploymentStrategy
-  }
-}

package/src/lib/aws/services/appconfig/types.ts

@@ -1,25 +0,0 @@
-import {
-  CfnApplicationProps,
-  CfnConfigurationProfileProps,
-  CfnDeploymentProps,
-  CfnEnvironmentProps,
-  DeploymentStrategyProps,
-} from 'aws-cdk-lib/aws-appconfig'
-
-/**
- *
- */
-export interface AppConfigDeploymentStrategyProps extends DeploymentStrategyProps {
-  deploymentStrategyArn?: string
-}
-
-/**
- */
-export interface AppConfigProps {
-  application: CfnApplicationProps
-  configurationProfile: CfnConfigurationProfileProps
-  deployment: CfnDeploymentProps
-  deploymentStrategy: AppConfigDeploymentStrategyProps
-  environment: CfnEnvironmentProps
-  id: string
-}

package/src/lib/aws/services/certificate-manager/index.ts

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

package/src/lib/aws/services/certificate-manager/main.ts

@@ -1,73 +0,0 @@
-import { Stack } from 'aws-cdk-lib'
-import { Certificate, CertificateValidation, ICertificate } from 'aws-cdk-lib/aws-certificatemanager'
-import { IHostedZone } from 'aws-cdk-lib/aws-route53'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { AcmProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS Certificates.
- * - 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: Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.acmManager.createCertificate('MyCertificate', this)
- *   }
- * }
- * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
- */
-export class AcmManager {
-  /**
-   * @summary Method to create/import a certificate
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props certificate props
-   * @param hostedZone optional hosted zone to perform DNS validation
-   * @returns the resolved certificate
-   * @mermaid
-   *   graph LR;
-   *     A((Start)) --> B{Valid Properties?};
-   *     B -- Yes --> C(Fetch By ARN);
-   *     B -- No --> D[Throw Error];
-   *     D --> G((Stop));
-   *     C --> E{Valid ARN?};
-   *     E -- Yes --> F(Return Certificate);
-   *     E -- No --> D;
-   *     F --> G;
-   */
-  public resolveCertificate(
-    id: string,
-    scope: CommonConstruct,
-    props: AcmProps,
-    hostedZone?: IHostedZone
-  ): ICertificate {
-    if (!props) throw `Certificate props undefined for ${id}`
-
-    let certificate
-
-    if (props.useExistingCertificate) {
-      let certificateArn = props.certificateArn
-      if (!certificateArn) {
-        const certificateAccount = props.certificateAccount ? props.certificateAccount : Stack.of(scope).account
-        const certificateRegion = props.certificateRegion ? props.certificateRegion : Stack.of(scope).region
-        certificateArn = `arn:aws:acm:${certificateRegion}:${certificateAccount}:certificate/${props.certificateId}`
-      }
-      certificate = Certificate.fromCertificateArn(scope, `${id}`, certificateArn)
-    } else {
-      certificate = new Certificate(scope, `${id}`, {
-        domainName: props.domainName,
-        subjectAlternativeNames: props.subjectAlternativeNames,
-        validation: CertificateValidation.fromDns(hostedZone),
-      })
-    }
-
-    createCfnOutput(`${id}-certificateArn`, scope, certificate.certificateArn)
-
-    return certificate
-  }
-}

package/src/lib/aws/services/certificate-manager/types.ts

@@ -1,12 +0,0 @@
-import { CertificateProps } from 'aws-cdk-lib/aws-certificatemanager'
-
-/**
- */
-export interface AcmProps extends CertificateProps {
-  certificateAccount?: string
-  certificateArn?: string
-  certificateId?: string
-  certificateRegion?: string
-  certificateSsmName?: string
-  useExistingCertificate: boolean
-}

package/src/lib/aws/services/cloudfront/index.ts

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

package/src/lib/aws/services/cloudfront/main.ts

@@ -1,315 +0,0 @@
-import { Duration, RemovalPolicy, Tags } from 'aws-cdk-lib'
-import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager'
-import * as cf from 'aws-cdk-lib/aws-cloudfront'
-import {
-  Distribution,
-  DistributionAttributes,
-  Function,
-  FunctionAssociation,
-  FunctionCode,
-  HttpVersion,
-  IDistribution,
-  IResponseHeadersPolicyRef,
-  OriginAccessIdentity,
-  PriceClass,
-  SecurityPolicyProtocol,
-} from 'aws-cdk-lib/aws-cloudfront'
-import { HttpOrigin, S3BucketOrigin } from 'aws-cdk-lib/aws-cloudfront-origins'
-import { ISecurityGroup, IVpc } from 'aws-cdk-lib/aws-ec2'
-import { IAccessPoint } from 'aws-cdk-lib/aws-efs'
-import { Role } from 'aws-cdk-lib/aws-iam'
-import { AssetCode, FileSystem, ILayerVersion } from 'aws-cdk-lib/aws-lambda'
-import { IBucket } from 'aws-cdk-lib/aws-s3'
-import { AwsCustomResource, AwsCustomResourcePolicy, PhysicalResourceId } from 'aws-cdk-lib/custom-resources'
-import _ from 'lodash'
-import { CommonConstruct, CommonStack } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { LambdaEdgeProps } from '../lambda/index.js'
-import { CloudfrontFunctionProps, DistributionProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS
- * - 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: Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.cloudFrontManager.createCloudFrontDistribution(
- *       'MyDistribution',
- *       this,
- *       siteBucket,
- *       logBucket,
- *       originAccessIdentity,
- *       certificate
- *     )
- *   }
- * }
- * @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?: IBucket) {
-    const oai = new OriginAccessIdentity(scope, `${id}`, {
-      comment: `${id} - ${scope.props.stage} stage`,
-    })
-    if (accessBucket) accessBucket.grantRead(oai)
-
-    return oai
-  }
-
-  /**
-   * Method to create a CloudFront distribution with S3 Origin
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props distribution properties
-   * @param siteBucket
-   * @param logBucket
-   * @param oai
-   * @param certificate
-   * @param aliases
-   * @param defaultFunctionAssociations
-   */
-  public createDistributionWithS3Origin(
-    id: string,
-    scope: CommonConstruct,
-    props: DistributionProps,
-    siteBucket: IBucket,
-    logBucket?: IBucket,
-    oai?: OriginAccessIdentity,
-    certificate?: ICertificate,
-    aliases?: string[],
-    defaultFunctionAssociations?: FunctionAssociation[]
-  ) {
-    const distribution = new Distribution(scope, `${id}`, {
-      ...props,
-      certificate,
-      comment: `${id} - ${scope.props.stage} stage`,
-      defaultBehavior: {
-        ...props.defaultBehavior,
-        functionAssociations: defaultFunctionAssociations ?? undefined,
-        origin: S3BucketOrigin.withOriginAccessIdentity(siteBucket, { originAccessIdentity: oai }),
-      },
-      domainNames: aliases,
-      enableLogging: props.enableLogging ?? true,
-      enabled: props.enabled ?? true,
-      httpVersion: props.httpVersion ?? HttpVersion.HTTP2,
-      logBucket,
-      logFilePrefix: props.logFilePrefix ?? `edge/`,
-      logIncludesCookies: props.logIncludesCookies ?? true,
-      minimumProtocolVersion: props.minimumProtocolVersion ?? SecurityPolicyProtocol.TLS_V1_2_2021,
-      priceClass: props.priceClass ?? PriceClass.PRICE_CLASS_ALL,
-    })
-
-    if (props.tags && !_.isEmpty(props.tags)) {
-      _.forEach(props.tags, tag => {
-        Tags.of(distribution).add(tag.key, tag.value)
-      })
-    }
-
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
-
-    return distribution
-  }
-
-  /**
-   * Method to create a CloudFront distribution with HTTP Origin
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props distribution properties
-   * @param origin
-   * @param domainNames
-   * @param logBucket
-   * @param certificate
-   * @param defaultFunctionAssociations
-   * @param responseHeadersPolicy
-   */
-  public createDistributionWithHttpOrigin(
-    id: string,
-    scope: CommonConstruct,
-    props: DistributionProps,
-    origin: HttpOrigin,
-    domainNames: string[],
-    logBucket?: IBucket,
-    certificate?: ICertificate,
-    defaultFunctionAssociations?: FunctionAssociation[],
-    responseHeadersPolicy?: IResponseHeadersPolicyRef
-  ) {
-    const distribution = new Distribution(scope, `${id}`, {
-      additionalBehaviors: props.additionalBehaviors,
-      certificate: certificate,
-      comment: `${id} - ${scope.props.stage} stage`,
-      defaultBehavior: {
-        cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
-        edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
-        functionAssociations: defaultFunctionAssociations ?? undefined,
-        origin: origin,
-        originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
-        responseHeadersPolicy: responseHeadersPolicy ?? undefined,
-        viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
-      },
-      defaultRootObject: props.defaultRootObject,
-      domainNames: domainNames,
-      enableIpv6: props.enableIpv6,
-      enableLogging: props.enableLogging ?? true,
-      enabled: props.enabled ?? true,
-      errorResponses: props.errorResponses,
-      geoRestriction: props.geoRestriction,
-      httpVersion: props.httpVersion ?? HttpVersion.HTTP2,
-      logBucket: logBucket,
-      logFilePrefix: props.logFilePrefix ?? `edge/`,
-      logIncludesCookies: props.logIncludesCookies ?? true,
-      minimumProtocolVersion: props.minimumProtocolVersion ?? SecurityPolicyProtocol.TLS_V1_2_2021,
-      priceClass: props.priceClass ?? PriceClass.PRICE_CLASS_ALL,
-      webAclId: props.webAclId,
-    })
-
-    if (props.tags && !_.isEmpty(props.tags)) {
-      _.forEach(props.tags, tag => {
-        Tags.of(distribution).add(tag.key, tag.value)
-      })
-    }
-
-    createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
-    createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
-
-    return distribution
-  }
-
-  /**
-   * @summary Method to provision a Lambda@Edge function
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props lambda@edge properties
-   * @param layers
-   * @param code
-   * @param role
-   * @param environment
-   * @param vpc
-   * @param securityGroups
-   * @param accessPoint
-   * @param mountPath
-   */
-  public createEdgeFunction(
-    id: string,
-    scope: CommonConstruct,
-    props: LambdaEdgeProps,
-    layers: ILayerVersion[],
-    code: AssetCode,
-    role: Role,
-    environment?: any,
-    vpc?: IVpc,
-    securityGroups?: ISecurityGroup[],
-    accessPoint?: IAccessPoint,
-    mountPath?: string
-  ) {
-    if (!props) throw `EdgeFunction props undefined for ${id}`
-    if (!props.functionName) throw `EdgeFunction functionName undefined for ${id}`
-
-    const functionName = scope.resourceNameFormatter.format(
-      props.functionName,
-      scope.props.resourceNameOptions?.cloudfront
-    )
-    const edgeFunction = new cf.experimental.EdgeFunction(scope, `${id}`, {
-      code: code,
-      description: props.description,
-      environment: {
-        ...environment,
-      },
-      filesystem: accessPoint ? FileSystem.fromEfsAccessPoint(accessPoint, mountPath ?? '/mnt/msg') : undefined,
-      functionName,
-      handler: props.handler ?? 'index.handler',
-      layers: layers,
-      logGroup: scope.logManager.createLogGroup(`${id}-log-group`, scope, {
-        logGroupName: functionName,
-        removalPolicy: RemovalPolicy.DESTROY,
-        retention: scope.props.logRetention,
-      }),
-      memorySize: props.memorySize,
-      reservedConcurrentExecutions: props.reservedConcurrentExecutions,
-      role: role,
-      runtime: props.runtime ?? scope.props.nodejsRuntime ?? CommonStack.NODEJS_RUNTIME,
-      securityGroups: securityGroups,
-      stackId: `${id}-stack-id-${scope.props.stage}`,
-      timeout: props.timeoutInSecs ? Duration.seconds(props.timeoutInSecs) : Duration.minutes(1),
-      vpc: vpc,
-    })
-
-    if (props.tags && !_.isEmpty(props.tags)) {
-      props.tags.forEach(tag => {
-        Tags.of(edgeFunction).add(tag.key, tag.value)
-      })
-    }
-
-    createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn)
-    createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn)
-    createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName)
-
-    return edgeFunction
-  }
-
-  /**
-   *
-   * @param id
-   * @param scope
-   * @param dockerFilePath
-   * @param distributionId
-   * @param paths
-   */
-  public invalidateCache(
-    id: string,
-    scope: CommonConstruct,
-    dockerFilePath: string,
-    distributionId: string,
-    paths?: string
-  ) {
-    new AwsCustomResource(scope, `${id}-trigger-codebuild-${new Date().getTime()}`, {
-      onCreate: {
-        action: 'startBuild',
-        parameters: {
-          projectName: scope.codeBuildManager.createProjectForCloudfrontInvalidation(
-            id,
-            scope,
-            dockerFilePath,
-            distributionId,
-            paths
-          ).projectName,
-        },
-        physicalResourceId: PhysicalResourceId.fromResponse('build.id'),
-        service: 'CodeBuild',
-      },
-      policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE }),
-    })
-  }
-
-  /**
-   * @summary Method to provision a Cloudfront function
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   */
-  public createCloudfrontFunction(id: string, scope: CommonConstruct, props: CloudfrontFunctionProps) {
-    if (!props) throw `CloudFront Function props undefined for ${id}`
-    if (!props.functionName) throw `CloudFront Function functionName undefined for ${id}`
-
-    const cloudfrontFunction = new Function(scope, `${id}`, {
-      ...props,
-      code: FunctionCode.fromFile({
-        filePath: props.functionFilePath,
-      }),
-      functionName: scope.resourceNameFormatter.format(props.functionName, scope.props.resourceNameOptions?.cloudfront),
-    })
-
-    createCfnOutput(`${id}-functionArn`, scope, cloudfrontFunction.functionArn)
-    createCfnOutput(`${id}-functionName`, scope, cloudfrontFunction.functionName)
-
-    return cloudfrontFunction
-  }
-
-  public resolveDistribution(scope: CommonConstruct, props: DistributionAttributes): IDistribution {
-    return Distribution.fromDistributionAttributes(scope, `${scope.node.id}-sa-distribution`, props)
-  }
-}

package/src/lib/aws/services/cloudfront/types.ts

@@ -1,15 +0,0 @@
-import { DistributionProps as CfDistributionProps, FunctionProps } from 'aws-cdk-lib/aws-cloudfront'
-import { TagProps } from '../../types/index.js'
-
-/**
- */
-export interface DistributionProps extends CfDistributionProps {
-  tags?: TagProps[]
-}
-
-/**
- */
-export interface CloudfrontFunctionProps extends FunctionProps {
-  eventType: string
-  functionFilePath: string
-}

package/src/lib/aws/services/cloudtrail/index.ts

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

package/src/lib/aws/services/cloudtrail/main.ts

@@ -1,87 +0,0 @@
-import { CfnTrail } from 'aws-cdk-lib/aws-cloudtrail'
-import { CfnLogGroup } from 'aws-cdk-lib/aws-logs'
-import { CfnBucketPolicy, IBucket } from 'aws-cdk-lib/aws-s3'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { CloudTrailProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS CloudTrail.
- * - 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.cloudTrailManager.createCloudTrail(
- *       'MyTrail',
- *       this,
- *       logGroup,
- *       dataBucket,
- *       logBucket,
- *       logBucketPolicy
- *     )
- *   }
- * }
- * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
- */
-export class CloudTrailManager {
-  /**
-   * @summary Method to create a cloud trail
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   * @param logGroup
-   * @param dataBucket
-   * @param logBucket
-   * @param logBucketPolicy
-   */
-  public createCloudTrail(
-    id: string,
-    scope: CommonConstruct,
-    props: CloudTrailProps,
-    logGroup: CfnLogGroup,
-    dataBucket: IBucket,
-    logBucket: IBucket,
-    logBucketPolicy: CfnBucketPolicy
-  ) {
-    if (!props) throw `CloudTrail props undefined for ${id}`
-    if (!props.trailName) throw `CloudTrail trailName undefined for ${id}`
-
-    const role = scope.iamManager.createRoleForCloudTrail(`${id}Role`, scope, logGroup)
-
-    const cloudTrail = new CfnTrail(scope, `${id}`, {
-      ...props,
-      cloudWatchLogsLogGroupArn: logGroup.attrArn,
-      cloudWatchLogsRoleArn: role.attrArn,
-      eventSelectors: [
-        {
-          dataResources: [
-            {
-              type: 'AWS::S3::Object',
-              values: [dataBucket.arnForObjects('')],
-            },
-          ],
-          includeManagementEvents: false,
-          readWriteType: 'WriteOnly',
-        },
-      ],
-      s3BucketName: logBucket.bucketName,
-      s3KeyPrefix: `logs-${props.trailName}`,
-      tags: [{ key: 'service', value: scope.props.name }],
-      trailName: scope.resourceNameFormatter.format(props.trailName, scope.props.resourceNameOptions?.cloudtrail),
-    })
-
-    cloudTrail.addDependency(logBucketPolicy)
-    cloudTrail.addDependency(logGroup)
-    cloudTrail.addDependency(role)
-
-    createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName)
-    createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn)
-
-    return { cloudTrail, cloudTrailRole: role }
-  }
-}