@gradientedge/cdk-utils 4.4.7 → 4.5.1

package/dist/src/lib/manager/aws/cloudfront-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudfront-manager.d.ts","sourceRoot":"","sources":["../../../../../src/lib/manager/aws/cloudfront-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,aAAa,CAAA;AAClC,OAAO,KAAK,GAAG,MAAM,oCAAoC,CAAA;AACzD,OAAO,KAAK,UAAU,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,OAAO,MAAM,oCAAoC,CAAA;AAC7D,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAA;AAC1C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAA;AAChD,OAAO,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAExC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA;AAGpC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,iBAAiB;IACrB,0BAA0B,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,EAAE,CAAC,OAAO;IAStG;;;;;;;;;;;;OAYG;IACI,4BAA4B,CACjC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,eAAe,EAC5B,UAAU,CAAC,EAAE,EAAE,CAAC,OAAO,EACvB,SAAS,CAAC,EAAE,EAAE,CAAC,OAAO,EACtB,GAAG,CAAC,EAAE,UAAU,CAAC,oBAAoB,EACrC,WAAW,CAAC,EAAE,GAAG,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,MAAM,EAAE;IA0CpB;;;;;;;;;;;;OAYG;IACI,8BAA8B,CACnC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,iBAAiB,EAC9B,MAAM,EAAE,OAAO,CAAC,QAAQ,EACxB,UAAU,EAAE,EAAE,CAAC,OAAO,EACtB,SAAS,CAAC,EAAE,EAAE,CAAC,OAAO,EACtB,GAAG,CAAC,EAAE,UAAU,CAAC,oBAAoB,EACrC,WAAW,CAAC,EAAE,GAAG,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,2BAA2B,CAAC,EAAE,UAAU,CAAC,mBAAmB,EAAE;IAkChE;;;;;;;;;;OAUG;IACI,gCAAgC,CACrC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,iBAAiB,EAC9B,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,WAAW,EAAE,MAAM,EAAE,EACrB,SAAS,CAAC,EAAE,EAAE,CAAC,OAAO,EACtB,WAAW,CAAC,EAAE,GAAG,CAAC,YAAY,EAC9B,2BAA2B,CAAC,EAAE,UAAU,CAAC,mBAAmB,EAAE;IAkChE;;;;;;;;;;;;;OAaG;IACI,kBAAkB,CACvB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,eAAe,EAC5B,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE,EAC9B,IAAI,EAAE,MAAM,CAAC,SAAS,EACtB,WAAW,CAAC,EAAE,GAAG,EACjB,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,EACd,cAAc,CAAC,EAAE,GAAG,CAAC,cAAc,EAAE,EACrC,WAAW,CAAC,EAAE,GAAG,CAAC,YAAY,EAC9B,SAAS,CAAC,EAAE,MAAM;IA8BpB;;;;;;;OAOG;IACI,eAAe,CACpB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,EACtB,KAAK,CAAC,EAAE,MAAM;IAqBhB;;;;;;OAMG;IACI,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,eAAe,EAAE,KAAK,EAAE,KAAK,CAAC,uBAAuB;CAchH"}

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

@@ -0,0 +1,283 @@
+"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 __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.CloudFrontManager = void 0;
+const cdk = __importStar(require("aws-cdk-lib"));
+const cloudfront = __importStar(require("aws-cdk-lib/aws-cloudfront"));
+const lambda = __importStar(require("aws-cdk-lib/aws-lambda"));
+const cr = __importStar(require("aws-cdk-lib/custom-resources"));
+const utils = __importStar(require("../../utils"));
+/**
+ * @stability stable
+ * @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
+ * 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.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}
+ */
+class CloudFrontManager {
+    createOriginAccessIdentity(id, scope, accessBucket) {
+        const oai = new cloudfront.OriginAccessIdentity(scope, `${id}`, {
+            comment: `${id} - ${scope.props.stage} stage`,
+        });
+        if (accessBucket)
+            accessBucket.grantRead(oai);
+        return oai;
+    }
+    /**
+     * @deprecated Use `createDistributionWithS3Origin` instead
+     *
+     * @summary Method to create a cloudfront distribution
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.CloudFrontProps} props distribution properties
+     * @param {s3.IBucket?} siteBucket
+     * @param {s3.IBucket?} logBucket
+     * @param {cloudfront.OriginAccessIdentity?} oai
+     * @param {acm.ICertificate?} certificate
+     * @param {string[]?} aliases
+     */
+    createCloudFrontDistribution(id, scope, props, siteBucket, logBucket, oai, certificate, aliases) {
+        if (!siteBucket)
+            throw `SiteBucket not defined`;
+        if (!certificate)
+            throw `Certificate not defined`;
+        if (!props)
+            throw `CloudFront props undefined`;
+        const distribution = new cloudfront.CloudFrontWebDistribution(scope, `${id}`, {
+            comment: `${id} - ${scope.props.stage} stage`,
+            defaultRootObject: props.defaultRootObject,
+            enabled: props.enabled ?? true,
+            enableIpV6: props.enableIpV6,
+            errorConfigurations: props.errorConfigurations,
+            geoRestriction: props.geoRestriction,
+            httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
+            loggingConfig: {
+                bucket: logBucket,
+                prefix: 'cloudfront/',
+            },
+            originConfigs: [
+                {
+                    s3OriginSource: {
+                        s3BucketSource: siteBucket,
+                        originAccessIdentity: oai,
+                    },
+                    behaviors: [{ isDefaultBehavior: true }],
+                },
+            ],
+            priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
+            viewerCertificate: cloudfront.ViewerCertificate.fromAcmCertificate(certificate, {
+                aliases: aliases ? [...aliases, ...[siteBucket.bucketName]] : [siteBucket.bucketName],
+                securityPolicy: cloudfront.SecurityPolicyProtocol.TLS_V1_1_2016,
+                sslMethod: cloudfront.SSLMethod.SNI,
+            }),
+            webACLId: props.webACLId,
+        });
+        utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId);
+        utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName);
+        return distribution;
+    }
+    /**
+     * Method to create a CloudFront distribution with S3 Origin
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.DistributionProps} props distribution properties
+     * @param {origins.S3Origin} origin
+     * @param {s3.IBucket} siteBucket
+     * @param {s3.IBucket?} logBucket
+     * @param {cloudfront.OriginAccessIdentity?} oai
+     * @param {acm.ICertificate?} certificate
+     * @param {string[]?} aliases
+     * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
+     */
+    createDistributionWithS3Origin(id, scope, props, origin, siteBucket, logBucket, oai, certificate, aliases, defaultFunctionAssociations) {
+        const distribution = new cloudfront.Distribution(scope, `${id}`, {
+            certificate: certificate,
+            comment: `${id} - ${scope.props.stage} stage`,
+            defaultBehavior: {
+                cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
+                origin: origin,
+                originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
+                functionAssociations: defaultFunctionAssociations ?? undefined,
+            },
+            additionalBehaviors: props.additionalBehaviors,
+            defaultRootObject: props.defaultRootObject,
+            domainNames: aliases ? [...aliases, ...[siteBucket.bucketName]] : [siteBucket.bucketName],
+            enabled: props.enabled ?? true,
+            enableIpv6: props.enableIpv6,
+            enableLogging: props.enableLogging ?? true,
+            errorResponses: props.errorResponses,
+            geoRestriction: props.geoRestriction,
+            httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
+            logBucket: logBucket,
+            logIncludesCookies: props.logIncludesCookies ?? true,
+            logFilePrefix: props.logFilePrefix ?? `edge/`,
+            minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
+            priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
+            webAclId: props.webAclId,
+        });
+        utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId);
+        utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName);
+        return distribution;
+    }
+    /**
+     * Method to create a CloudFront distribution with HTTP Origin
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.DistributionProps} props distribution properties
+     * @param {origins.S3Origin} origin
+     * @param {string[]} domainNames
+     * @param {s3.IBucket?} logBucket
+     * @param {acm.ICertificate?} certificate
+     * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
+     */
+    createDistributionWithHttpOrigin(id, scope, props, origin, domainNames, logBucket, certificate, defaultFunctionAssociations) {
+        const distribution = new cloudfront.Distribution(scope, `${id}`, {
+            certificate: certificate,
+            comment: `${id} - ${scope.props.stage} stage`,
+            defaultBehavior: {
+                cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
+                origin: origin,
+                originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
+                functionAssociations: defaultFunctionAssociations ?? undefined,
+            },
+            additionalBehaviors: props.additionalBehaviors,
+            defaultRootObject: props.defaultRootObject,
+            domainNames: domainNames,
+            enabled: props.enabled ?? true,
+            enableIpv6: props.enableIpv6,
+            enableLogging: props.enableLogging ?? true,
+            errorResponses: props.errorResponses,
+            geoRestriction: props.geoRestriction,
+            httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
+            logBucket: logBucket,
+            logIncludesCookies: props.logIncludesCookies ?? true,
+            logFilePrefix: props.logFilePrefix ?? `edge/`,
+            minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
+            priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
+            webAclId: props.webAclId,
+        });
+        utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId);
+        utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName);
+        return distribution;
+    }
+    /**
+     * @summary Method to provision a Lambda@Edge function
+     *
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LambdaEdgeProps} props lambda@edge properties
+     * @param {lambda.ILayerVersion[]} layers
+     * @param {lambda.AssetCode} code
+     * @param {Map<string, string>} environment
+     * @param {ec2.IVpc} vpc
+     * @param {ec2.ISecurityGroup[]} securityGroups
+     * @param {efs.IAccessPoint} accessPoint
+     * @param {string} mountPath
+     */
+    createEdgeFunction(id, scope, props, layers, code, environment, vpc, securityGroups, accessPoint, mountPath) {
+        if (!props)
+            throw 'EdgeFunction props undefined';
+        const edgeFunction = new cloudfront.experimental.EdgeFunction(scope, `${id}`, {
+            code: code,
+            environment: {
+                ...environment,
+            },
+            filesystem: accessPoint ? lambda.FileSystem.fromEfsAccessPoint(accessPoint, mountPath ?? '/mnt/msg') : undefined,
+            functionName: `${props.functionName}-${scope.props.stage}`,
+            handler: props.handler ?? 'index.handler',
+            layers: layers,
+            logRetention: props.logRetention,
+            memorySize: props.memorySize,
+            reservedConcurrentExecutions: props.reservedConcurrentExecutions,
+            runtime: props.runtime ?? lambda.Runtime.NODEJS_14_X,
+            securityGroups: securityGroups,
+            stackId: `${id}-stack-id-${scope.props.stage}`,
+            timeout: props.timeoutInSecs ? cdk.Duration.seconds(props.timeoutInSecs) : cdk.Duration.minutes(1),
+            vpc: vpc,
+        });
+        utils.createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn);
+        utils.createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn);
+        utils.createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName);
+        return edgeFunction;
+    }
+    /**
+     *
+     * @param id
+     * @param scope
+     * @param dockerFilePath
+     * @param distributionId
+     * @param paths
+     */
+    invalidateCache(id, scope, dockerFilePath, distributionId, paths) {
+        new cr.AwsCustomResource(scope, `${id}-trigger-codebuild-${new Date().getTime()}`, {
+            onCreate: {
+                service: 'CodeBuild',
+                action: 'startBuild',
+                parameters: {
+                    projectName: scope.codeBuildManager.createProjectForCloudfrontInvalidation(id, scope, dockerFilePath, distributionId, paths).projectName,
+                },
+                physicalResourceId: cr.PhysicalResourceId.fromResponse('build.id'),
+            },
+            policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE }),
+        });
+    }
+    /**
+     * @summary Method to provision a Cloudfront function
+     *
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.CloudfrontFunctionProps} props
+     */
+    createCloudfrontFunction(id, scope, props) {
+        const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {
+            code: cloudfront.FunctionCode.fromFile({
+                filePath: props.functionFilePath,
+            }),
+            comment: props.comment,
+            functionName: `${props.functionName}-${scope.props.stage}`,
+        });
+        utils.createCfnOutput(`${id}-functionArn`, scope, cloudfrontFunction.functionArn);
+        utils.createCfnOutput(`${id}-functionName`, scope, cloudfrontFunction.functionName);
+        return cloudfrontFunction;
+    }
+}
+exports.CloudFrontManager = CloudFrontManager;
+//# sourceMappingURL=cloudfront-manager.js.map

package/dist/src/lib/manager/aws/cloudfront-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudfront-manager.js","sourceRoot":"","sources":["../../../../../src/lib/manager/aws/cloudfront-manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAkC;AAElC,uEAAwD;AAIxD,+DAAgD;AAEhD,iEAAkD;AAGlD,mDAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,iBAAiB;IACrB,0BAA0B,CAAC,EAAU,EAAE,KAA6B,EAAE,YAAyB;QACpG,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;SAC9C,CAAC,CAAA;QACF,IAAI,YAAY;YAAE,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAE7C,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,4BAA4B,CACjC,EAAU,EACV,KAA6B,EAC7B,KAA4B,EAC5B,UAAuB,EACvB,SAAsB,EACtB,GAAqC,EACrC,WAA8B,EAC9B,OAAkB;QAElB,IAAI,CAAC,UAAU;YAAE,MAAM,wBAAwB,CAAA;QAC/C,IAAI,CAAC,WAAW;YAAE,MAAM,yBAAyB,CAAA;QACjD,IAAI,CAAC,KAAK;YAAE,MAAM,4BAA4B,CAAA;QAE9C,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAC5E,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;YAC7C,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;YAC1C,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,mBAAmB,EAAE,KAAK,CAAC,mBAAmB;YAC9C,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,KAAK;YAC9D,aAAa,EAAE;gBACb,MAAM,EAAE,SAAS;gBACjB,MAAM,EAAE,aAAa;aACtB;YACD,aAAa,EAAE;gBACb;oBACE,cAAc,EAAE;wBACd,cAAc,EAAE,UAAU;wBAC1B,oBAAoB,EAAE,GAAG;qBAC1B;oBACD,SAAS,EAAE,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;iBACzC;aACF;YACD,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,eAAe;YACrE,iBAAiB,EAAE,UAAU,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,WAAW,EAAE;gBAC9E,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;gBACrF,cAAc,EAAE,UAAU,CAAC,sBAAsB,CAAC,aAAa;gBAC/D,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,GAAG;aACpC,CAAC;YACF,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAA;QAEF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,CAAA;QACjF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,EAAE,YAAY,CAAC,sBAAsB,CAAC,CAAA;QAEjG,OAAO,YAAY,CAAA;IACrB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,8BAA8B,CACnC,EAAU,EACV,KAA6B,EAC7B,KAA8B,EAC9B,MAAwB,EACxB,UAAsB,EACtB,SAAsB,EACtB,GAAqC,EACrC,WAA8B,EAC9B,OAAkB,EAClB,2BAA8D;QAE9D,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAC/D,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;YAC7C,eAAe,EAAE;gBACf,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAClF,MAAM,EAAE,MAAM;gBACd,mBAAmB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS;gBAClG,oBAAoB,EAAE,2BAA2B,IAAI,SAAS;aAC/D;YACD,mBAAmB,EAAE,KAAK,CAAC,mBAAmB;YAC9C,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;YAC1C,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;YACzF,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,IAAI;YAC1C,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,KAAK;YAC9D,SAAS,EAAE,SAAS;YACpB,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,IAAI,IAAI;YACpD,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,OAAO;YAC7C,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,IAAI,UAAU,CAAC,sBAAsB,CAAC,aAAa;YACvG,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,eAAe;YACrE,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAA;QAEF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,CAAA;QACjF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,EAAE,YAAY,CAAC,sBAAsB,CAAC,CAAA;QAEjG,OAAO,YAAY,CAAA;IACrB,CAAC;IAED;;;;;;;;;;OAUG;IACI,gCAAgC,CACrC,EAAU,EACV,KAA6B,EAC7B,KAA8B,EAC9B,MAA0B,EAC1B,WAAqB,EACrB,SAAsB,EACtB,WAA8B,EAC9B,2BAA8D;QAE9D,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAC/D,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;YAC7C,eAAe,EAAE;gBACf,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAClF,MAAM,EAAE,MAAM;gBACd,mBAAmB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS;gBAClG,oBAAoB,EAAE,2BAA2B,IAAI,SAAS;aAC/D;YACD,mBAAmB,EAAE,KAAK,CAAC,mBAAmB;YAC9C,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;YAC1C,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,IAAI;YAC1C,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,KAAK;YAC9D,SAAS,EAAE,SAAS;YACpB,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,IAAI,IAAI;YACpD,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,OAAO;YAC7C,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,IAAI,UAAU,CAAC,sBAAsB,CAAC,aAAa;YACvG,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,eAAe;YACrE,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAA;QAEF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,CAAA;QACjF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,EAAE,YAAY,CAAC,sBAAsB,CAAC,CAAA;QAEjG,OAAO,YAAY,CAAA;IACrB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,kBAAkB,CACvB,EAAU,EACV,KAA6B,EAC7B,KAA4B,EAC5B,MAA8B,EAC9B,IAAsB,EACtB,WAAiB,EACjB,GAAc,EACd,cAAqC,EACrC,WAA8B,EAC9B,SAAkB;QAElB,IAAI,CAAC,KAAK;YAAE,MAAM,8BAA8B,CAAA;QAEhD,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YAC5E,IAAI,EAAE,IAAI;YACV,WAAW,EAAE;gBACX,GAAG,WAAW;aACf;YACD,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,WAAW,EAAE,SAAS,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;YAChH,YAAY,EAAE,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;YAC1D,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,eAAe;YACzC,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,4BAA4B,EAAE,KAAK,CAAC,4BAA4B;YAChE,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW;YACpD,cAAc,EAAE,cAAc;YAC9B,OAAO,EAAE,GAAG,EAAE,aAAa,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;YAC9C,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAClG,GAAG,EAAE,GAAG;SACT,CAAC,CAAA;QAEF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,CAAA;QACnE,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;QAC/E,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,mBAAmB,EAAE,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,CAAA;QAEjF,OAAO,YAAY,CAAA;IACrB,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CACpB,EAAU,EACV,KAA6B,EAC7B,cAAsB,EACtB,cAAsB,EACtB,KAAc;QAEd,IAAI,EAAE,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,sBAAsB,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE;YACjF,QAAQ,EAAE;gBACR,OAAO,EAAE,WAAW;gBACpB,MAAM,EAAE,YAAY;gBACpB,UAAU,EAAE;oBACV,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,sCAAsC,CACxE,EAAE,EACF,KAAK,EACL,cAAc,EACd,cAAc,EACd,KAAK,CACN,CAAC,WAAW;iBACd;gBACD,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,YAAY,CAAC,UAAU,CAAC;aACnE;YACD,MAAM,EAAE,EAAE,CAAC,uBAAuB,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,uBAAuB,CAAC,YAAY,EAAE,CAAC;SACxG,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAAC,EAAU,EAAE,KAA6B,EAAE,KAAoC;QAC7G,MAAM,kBAAkB,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YACjE,IAAI,EAAE,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC;gBACrC,QAAQ,EAAE,KAAK,CAAC,gBAAgB;aACjC,CAAC;YACF,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,YAAY,EAAE,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;SAC3D,CAAC,CAAA;QAEF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAA;QACjF,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAA;QAEnF,OAAO,kBAAkB,CAAA;IAC3B,CAAC;CACF;AApSD,8CAoSC"}

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

@@ -0,0 +1,49 @@
+import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail';
+import * as logs from 'aws-cdk-lib/aws-logs';
+import * as s3 from 'aws-cdk-lib/aws-s3';
+import * as common from '../../common';
+import * as types from '../../types';
+/**
+ * @stability stable
+ * @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
+ * 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.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 declare class CloudTrailManager {
+    /**
+     * @summary Method to create a cloud trail
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.CloudTrailProps} props
+     * @param {logs.CfnLogGroup} logGroup
+     * @param {s3.IBucket} dataBucket
+     * @param {s3.IBucket} logBucket
+     * @param {s3.CfnBucketPolicy} logBucketPolicy
+     */
+    createCloudTrail(id: string, scope: common.CommonConstruct, props: types.CloudTrailProps, logGroup: logs.CfnLogGroup, dataBucket: s3.IBucket, logBucket: s3.IBucket, logBucketPolicy: s3.CfnBucketPolicy): {
+        cloudTrailRole: import("aws-cdk-lib/aws-iam").CfnRole;
+        cloudTrail: cloudtrail.CfnTrail;
+    };
+}
+//# sourceMappingURL=cloudtrail-manager.d.ts.map

package/dist/src/lib/manager/aws/cloudtrail-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudtrail-manager.d.ts","sourceRoot":"","sources":["../../../../../src/lib/manager/aws/cloudtrail-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,IAAI,MAAM,sBAAsB,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,oBAAoB,CAAA;AACxC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA;AAGpC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,iBAAiB;IAC5B;;;;;;;;;OASG;IACI,gBAAgB,CACrB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,eAAe,EAC5B,QAAQ,EAAE,IAAI,CAAC,WAAW,EAC1B,UAAU,EAAE,EAAE,CAAC,OAAO,EACtB,SAAS,EAAE,EAAE,CAAC,OAAO,EACrB,eAAe,EAAE,EAAE,CAAC,eAAe;;;;CAwCtC"}

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

@@ -0,0 +1,100 @@
+"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 __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.CloudTrailManager = void 0;
+const cloudtrail = __importStar(require("aws-cdk-lib/aws-cloudtrail"));
+const utils = __importStar(require("../../utils"));
+/**
+ * @stability stable
+ * @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
+ * 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.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}
+ */
+class CloudTrailManager {
+    /**
+     * @summary Method to create a cloud trail
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.CloudTrailProps} props
+     * @param {logs.CfnLogGroup} logGroup
+     * @param {s3.IBucket} dataBucket
+     * @param {s3.IBucket} logBucket
+     * @param {s3.CfnBucketPolicy} logBucketPolicy
+     */
+    createCloudTrail(id, scope, props, logGroup, dataBucket, logBucket, logBucketPolicy) {
+        if (!props)
+            throw `CloudTrail props undefined`;
+        const role = scope.iamManager.createRoleForCloudTrail(`${id}Role`, scope, logGroup);
+        const cloudTrail = new cloudtrail.CfnTrail(scope, `${id}`, {
+            cloudWatchLogsLogGroupArn: logGroup.attrArn,
+            cloudWatchLogsRoleArn: role.attrArn,
+            enableLogFileValidation: props.enableLogFileValidation,
+            eventSelectors: [
+                {
+                    dataResources: [
+                        {
+                            type: 'AWS::S3::Object',
+                            values: [dataBucket.arnForObjects('')],
+                        },
+                    ],
+                    includeManagementEvents: false,
+                    readWriteType: 'WriteOnly',
+                },
+            ],
+            includeGlobalServiceEvents: props.includeGlobalServiceEvents,
+            isLogging: props.isLogging,
+            isMultiRegionTrail: props.isMultiRegionTrail,
+            s3BucketName: logBucket.bucketName,
+            s3KeyPrefix: `logs-${props.trailName}`,
+            tags: [{ key: 'service', value: scope.props.name }],
+            trailName: `${props.trailName}-${scope.props.stage}`,
+        });
+        cloudTrail.addDependsOn(logBucketPolicy);
+        cloudTrail.addDependsOn(logGroup);
+        cloudTrail.addDependsOn(role);
+        utils.createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName);
+        utils.createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn);
+        return { cloudTrailRole: role, cloudTrail };
+    }
+}
+exports.CloudTrailManager = CloudTrailManager;
+//# sourceMappingURL=cloudtrail-manager.js.map

package/dist/src/lib/manager/aws/cloudtrail-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudtrail-manager.js","sourceRoot":"","sources":["../../../../../src/lib/manager/aws/cloudtrail-manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,uEAAwD;AAKxD,mDAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,iBAAiB;IAC5B;;;;;;;;;OASG;IACI,gBAAgB,CACrB,EAAU,EACV,KAA6B,EAC7B,KAA4B,EAC5B,QAA0B,EAC1B,UAAsB,EACtB,SAAqB,EACrB,eAAmC;QAEnC,IAAI,CAAC,KAAK;YAAE,MAAM,4BAA4B,CAAA;QAE9C,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;QAEnF,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;YACzD,yBAAyB,EAAE,QAAQ,CAAC,OAAO;YAC3C,qBAAqB,EAAE,IAAI,CAAC,OAAO;YACnC,uBAAuB,EAAE,KAAK,CAAC,uBAAuB;YACtD,cAAc,EAAE;gBACd;oBACE,aAAa,EAAE;wBACb;4BACE,IAAI,EAAE,iBAAiB;4BACvB,MAAM,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;yBACvC;qBACF;oBACD,uBAAuB,EAAE,KAAK;oBAC9B,aAAa,EAAE,WAAW;iBAC3B;aACF;YACD,0BAA0B,EAAE,KAAK,CAAC,0BAA0B;YAC5D,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;YAC5C,YAAY,EAAE,SAAS,CAAC,UAAU;YAClC,WAAW,EAAE,QAAQ,KAAK,CAAC,SAAS,EAAE;YACtC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACnD,SAAS,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;SACrD,CAAC,CAAA;QAEF,UAAU,CAAC,YAAY,CAAC,eAAe,CAAC,CAAA;QACxC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QACjC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAE7B,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;QACrE,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,CAAA;QAElE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;IAC7C,CAAC;CACF;AA1DD,8CA0DC"}

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

@@ -0,0 +1,122 @@
+import * as cdk from 'aws-cdk-lib';
+import * as watch from 'aws-cdk-lib/aws-cloudwatch';
+import { IMetric } from 'aws-cdk-lib/aws-cloudwatch';
+import * as common from '../../common';
+import * as types from '../../types';
+/**
+ * @stability stable
+ * @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
+ * 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.cloudWatchManager.createAlarmForMetric('MyAlarm', this, metric)
+ *   }
+ * }
+ *
+ * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
+ */
+export declare class CloudWatchManager {
+    /**
+     * @summary Method to create a cloudwatch alarm for a given expression
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.AlarmProps} props
+     */
+    createAlarmForExpression(id: string, scope: common.CommonConstruct, props: types.AlarmProps): cdk.aws_cloudwatch.Alarm;
+    /**
+     * @summary Method to create a cloudwatch alarm for a given metric
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.AlarmProps} props
+     * @param metric
+     */
+    createAlarmForMetric(id: string, scope: common.CommonConstruct, props: types.AlarmProps, metric: watch.Metric): cdk.aws_cloudwatch.Alarm;
+    /**
+     * @summary Method to create a cloudwatch dashboard
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.DashboardProps} props
+     * @param widgets
+     */
+    createDashboard(id: string, scope: common.CommonConstruct, props: types.DashboardProps, widgets?: watch.IWidget[][]): cdk.aws_cloudwatch.Dashboard;
+    /**
+     * @summary Method to create cloudwatch widgets
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param props
+     */
+    createWidgets(scope: common.CommonConstruct, props: any[]): any;
+    /**
+     * @summary Method to create a cloudwatch widget
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param props
+     */
+    createWidget(id: string, scope: common.CommonConstruct, props: any): cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.LogQueryWidget | cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create a cloudwatch text widget
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.TextWidgetProps} props
+     */
+    createTextWidget(id: string, scope: common.CommonConstruct, props: types.TextWidgetProps): cdk.aws_cloudwatch.TextWidget;
+    /**
+     * @summary Method to create a cloudwatch numeric widget
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.NumericWidgetProps} props
+     * @param metrics
+     */
+    createSingleValueWidget(id: string, scope: common.CommonConstruct, props: types.NumericWidgetProps, metrics: IMetric[]): cdk.aws_cloudwatch.SingleValueWidget;
+    /**
+     * @summary Method to create a cloudwatch graph widget
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.GraphWidgetProps} props
+     * @param leftYMetrics
+     * @param rightYMetrics
+     */
+    createGraphWidget(id: string, scope: common.CommonConstruct, props: types.GraphWidgetProps, leftYMetrics?: IMetric[], rightYMetrics?: IMetric[]): cdk.aws_cloudwatch.GraphWidget;
+    /**
+     * @summary Method to create a cloudwatch alarm status widget
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.AlarmStatusWidgetProps} props
+     * @param {watch.IAlarm[]} alarms
+     */
+    createAlarmStatusWidget(id: string, scope: common.CommonConstruct, props: types.AlarmStatusWidgetProps, alarms: watch.IAlarm[]): cdk.aws_cloudwatch.AlarmStatusWidget;
+    /**
+     * @summary Method to create a cloudwatch log query widget
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.LogQueryWidgetProps} props
+     * @param {string[]} logGroupNames
+     */
+    createLogQueryWidget(id: string, scope: common.CommonConstruct, props: types.LogQueryWidgetProps, logGroupNames: string[]): cdk.aws_cloudwatch.LogQueryWidget;
+    /**
+     * @summary Utility method to determine the metrics and dimensions
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {types.MetricProps[]} metricProps
+     */
+    private determineMetrics;
+    /**
+     * @summary Utility method to determine the time range
+     * @param {string?} range
+     */
+    private static determineTimeRange;
+    /**
+     * @summary Utility method to determine the configured alarms
+     * @param {string} id scoped id of the resource
+     * @param {common.CommonConstruct} scope scope in which this resource is defined
+     * @param {watch.AlarmProps[]} alarmProps
+     */
+    private determineAlarms;
+}
+//# sourceMappingURL=cloudwatch-manager.d.ts.map

package/dist/src/lib/manager/aws/cloudwatch-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudwatch-manager.d.ts","sourceRoot":"","sources":["../../../../../src/lib/manager/aws/cloudwatch-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,aAAa,CAAA;AAClC,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA;AAepC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,iBAAiB;IAC5B;;;;;OAKG;IACI,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,eAAe,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU;IAgClG;;;;;;OAMG;IACI,oBAAoB,CACzB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,UAAU,EACvB,MAAM,EAAE,KAAK,CAAC,MAAM;IAoBtB;;;;;;OAMG;IACI,eAAe,CACpB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,cAAc,EAC3B,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE;IAiB7B;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,eAAe,EAAE,KAAK,EAAE,GAAG,EAAE;IAShE;;;;;OAKG;IACI,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,eAAe,EAAE,KAAK,EAAE,GAAG;IAwBzE;;;;;OAKG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,eAAe,EAAE,KAAK,EAAE,KAAK,CAAC,eAAe;IAY/F;;;;;;OAMG;IACI,uBAAuB,CAC5B,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,kBAAkB,EAC/B,OAAO,EAAE,OAAO,EAAE;IAgBpB;;;;;;;OAOG;IACI,iBAAiB,CACtB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,gBAAgB,EAC7B,YAAY,CAAC,EAAE,OAAO,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,EAAE;IAuB3B;;;;;;OAMG;IACI,uBAAuB,CAC5B,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,sBAAsB,EACnC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;IAcxB;;;;;;OAMG;IACI,oBAAoB,CACzB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,CAAC,eAAe,EAC7B,KAAK,EAAE,KAAK,CAAC,mBAAmB,EAChC,aAAa,EAAE,MAAM,EAAE;IAiBzB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAoCxB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAajC;;;;;OAKG;IACH,OAAO,CAAC,eAAe;CAexB"}