@gradientedge/cdk-utils 8.91.0 → 8.92.0

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

@@ -11,9 +11,6 @@ import { CommonConstruct } from '../../../common';
 import { CloudfrontFunctionProps, CloudFrontProps, DistributionProps } from './types';
 import { LambdaEdgeProps } from '../lambda';
 /**
- * @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 CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -34,64 +31,62 @@ import { LambdaEdgeProps } from '../lambda';
  *     )
  *   }
  * }
- *
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 export declare class CloudFrontManager {
     createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: s3.IBucket): cdk.aws_cloudfront.OriginAccessIdentity;
     /**
      * @summary Method to create a cloudfront distribution
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {CloudFrontProps} props distribution properties
-     * @param {s3.IBucket?} siteBucket
-     * @param {s3.IBucket?} logBucket
-     * @param {cloudfront.OriginAccessIdentity?} oai
-     * @param {acm.ICertificate?} certificate
-     * @param {string[]?} aliases
+     * @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
      */
     createCloudFrontDistribution(id: string, scope: CommonConstruct, props: CloudFrontProps, siteBucket?: s3.IBucket, logBucket?: s3.IBucket, oai?: cloudfront.OriginAccessIdentity, certificate?: acm.ICertificate, aliases?: string[]): cdk.aws_cloudfront.CloudFrontWebDistribution;
     /**
      * Method to create a CloudFront distribution with S3 Origin
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props distribution properties
+     * @param origin
+     * @param siteBucket
+     * @param logBucket
+     * @param oai
+     * @param certificate
+     * @param aliases
+     * @param defaultFunctionAssociations
      */
     createDistributionWithS3Origin(id: string, scope: CommonConstruct, props: DistributionProps, origin: origins.S3Origin, siteBucket: s3.IBucket, logBucket?: s3.IBucket, oai?: cloudfront.OriginAccessIdentity, certificate?: acm.ICertificate, aliases?: string[], defaultFunctionAssociations?: cloudfront.FunctionAssociation[]): cdk.aws_cloudfront.Distribution;
     /**
      * Method to create a CloudFront distribution with HTTP Origin
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {DistributionProps} props distribution properties
-     * @param {origins.S3Origin} origin
-     * @param {string[]} domainNames
-     * @param {s3.IBucket?} logBucket
-     * @param {acm.ICertificate?} certificate
-     * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
-     * @param {cloudfront.IResponseHeadersPolicy?} responseHeadersPolicy
+     * @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
      */
     createDistributionWithHttpOrigin(id: string, scope: CommonConstruct, props: DistributionProps, origin: origins.HttpOrigin, domainNames: string[], logBucket?: s3.IBucket, certificate?: acm.ICertificate, defaultFunctionAssociations?: cloudfront.FunctionAssociation[], responseHeadersPolicy?: cloudfront.IResponseHeadersPolicy): cdk.aws_cloudfront.Distribution;
     /**
      * @summary Method to provision a Lambda@Edge function
-     *
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LambdaEdgeProps} props lambda@edge properties
-     * @param {lambda.ILayerVersion[]} layers
-     * @param {lambda.AssetCode} code
-     * @param {iam.Role} role
-     * @param {Map<string, string>} environment
-     * @param {ec2.IVpc} vpc
-     * @param {ec2.ISecurityGroup[]} securityGroups
-     * @param {efs.IAccessPoint} accessPoint
-     * @param {string} mountPath
+     * @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
      */
     createEdgeFunction(id: string, scope: CommonConstruct, props: LambdaEdgeProps, layers: lambda.ILayerVersion[], code: lambda.AssetCode, role: iam.Role, environment?: any, vpc?: ec2.IVpc, securityGroups?: ec2.ISecurityGroup[], accessPoint?: efs.IAccessPoint, mountPath?: string): cdk.aws_cloudfront.experimental.EdgeFunction;
     /**
@@ -105,10 +100,9 @@ export declare class CloudFrontManager {
     invalidateCache(id: string, scope: CommonConstruct, dockerFilePath: string, distributionId: string, paths?: string): void;
     /**
      * @summary Method to provision a Cloudfront function
-     *
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {CloudfrontFunctionProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createCloudfrontFunction(id: string, scope: CommonConstruct, props: CloudfrontFunctionProps): cdk.aws_cloudfront.Function;
 }

package/dist/src/lib/services/aws/cloudfront/main.js

@@ -31,9 +31,6 @@ const cr = __importStar(require("aws-cdk-lib/custom-resources"));
 const common_1 = require("../../../common");
 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 CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -54,7 +51,6 @@ const utils = __importStar(require("../../../utils"));
  *     )
  *   }
  * }
- *
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
  */
 class CloudFrontManager {
@@ -68,14 +64,14 @@ class CloudFrontManager {
     }
     /**
      * @summary Method to create a cloudfront distribution
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {CloudFrontProps} props distribution properties
-     * @param {s3.IBucket?} siteBucket
-     * @param {s3.IBucket?} logBucket
-     * @param {cloudfront.OriginAccessIdentity?} oai
-     * @param {acm.ICertificate?} certificate
-     * @param {string[]?} aliases
+     * @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
      */
     createCloudFrontDistribution(id, scope, props, siteBucket, logBucket, oai, certificate, aliases) {
         if (!siteBucket)
@@ -87,8 +83,8 @@ class CloudFrontManager {
         const distribution = new cloudfront.CloudFrontWebDistribution(scope, `${id}`, {
             comment: `${id} - ${scope.props.stage} stage`,
             defaultRootObject: props.defaultRootObject,
-            enabled: props.enabled ?? true,
             enableIpV6: props.enableIpV6,
+            enabled: props.enabled ?? true,
             errorConfigurations: props.errorConfigurations,
             geoRestriction: props.geoRestriction,
             httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
@@ -98,11 +94,11 @@ class CloudFrontManager {
             },
             originConfigs: [
                 {
+                    behaviors: [{ isDefaultBehavior: true }],
                     s3OriginSource: {
-                        s3BucketSource: siteBucket,
                         originAccessIdentity: oai,
+                        s3BucketSource: siteBucket,
                     },
-                    behaviors: [{ isDefaultBehavior: true }],
                 },
             ],
             priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
@@ -124,41 +120,41 @@ class CloudFrontManager {
     }
     /**
      * Method to create a CloudFront distribution with S3 Origin
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {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
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props distribution properties
+     * @param origin
+     * @param siteBucket
+     * @param logBucket
+     * @param oai
+     * @param certificate
+     * @param aliases
+     * @param defaultFunctionAssociations
      */
     createDistributionWithS3Origin(id, scope, props, origin, siteBucket, logBucket, oai, certificate, aliases, defaultFunctionAssociations) {
         const distribution = new cloudfront.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,
-                functionAssociations: defaultFunctionAssociations ?? undefined,
                 viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
-                edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
             },
-            additionalBehaviors: props.additionalBehaviors,
             defaultRootObject: props.defaultRootObject,
             domainNames: aliases,
-            enabled: props.enabled ?? true,
             enableIpv6: props.enableIpv6,
             enableLogging: props.enableLogging ?? true,
+            enabled: props.enabled ?? true,
             errorResponses: props.errorResponses,
             geoRestriction: props.geoRestriction,
             httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
             logBucket: logBucket,
-            logIncludesCookies: props.logIncludesCookies ?? true,
             logFilePrefix: props.logFilePrefix ?? `edge/`,
+            logIncludesCookies: props.logIncludesCookies ?? true,
             minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
             priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
             webAclId: props.webAclId,
@@ -174,41 +170,41 @@ class CloudFrontManager {
     }
     /**
      * Method to create a CloudFront distribution with HTTP Origin
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {DistributionProps} props distribution properties
-     * @param {origins.S3Origin} origin
-     * @param {string[]} domainNames
-     * @param {s3.IBucket?} logBucket
-     * @param {acm.ICertificate?} certificate
-     * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
-     * @param {cloudfront.IResponseHeadersPolicy?} responseHeadersPolicy
+     * @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
      */
     createDistributionWithHttpOrigin(id, scope, props, origin, domainNames, logBucket, certificate, defaultFunctionAssociations, responseHeadersPolicy) {
         const distribution = new cloudfront.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,
-                functionAssociations: defaultFunctionAssociations ?? undefined,
-                viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
                 responseHeadersPolicy: responseHeadersPolicy ?? undefined,
-                edgeLambdas: props.defaultBehavior ? props.defaultBehavior.edgeLambdas : undefined,
+                viewerProtocolPolicy: props.defaultBehavior ? props.defaultBehavior.viewerProtocolPolicy : undefined,
             },
-            additionalBehaviors: props.additionalBehaviors,
             defaultRootObject: props.defaultRootObject,
             domainNames: domainNames,
-            enabled: props.enabled ?? true,
             enableIpv6: props.enableIpv6,
             enableLogging: props.enableLogging ?? true,
+            enabled: props.enabled ?? true,
             errorResponses: props.errorResponses,
             geoRestriction: props.geoRestriction,
             httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
             logBucket: logBucket,
-            logIncludesCookies: props.logIncludesCookies ?? true,
             logFilePrefix: props.logFilePrefix ?? `edge/`,
+            logIncludesCookies: props.logIncludesCookies ?? true,
             minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
             priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
             webAclId: props.webAclId,
@@ -224,18 +220,17 @@ class CloudFrontManager {
     }
     /**
      * @summary Method to provision a Lambda@Edge function
-     *
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LambdaEdgeProps} props lambda@edge properties
-     * @param {lambda.ILayerVersion[]} layers
-     * @param {lambda.AssetCode} code
-     * @param {iam.Role} role
-     * @param {Map<string, string>} environment
-     * @param {ec2.IVpc} vpc
-     * @param {ec2.ISecurityGroup[]} securityGroups
-     * @param {efs.IAccessPoint} accessPoint
-     * @param {string} mountPath
+     * @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
      */
     createEdgeFunction(id, scope, props, layers, code, role, environment, vpc, securityGroups, accessPoint, mountPath) {
         if (!props)
@@ -281,22 +276,21 @@ class CloudFrontManager {
     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'),
+                service: 'CodeBuild',
             },
             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 {CommonConstruct} scope scope in which this resource is defined
-     * @param {CloudfrontFunctionProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createCloudfrontFunction(id, scope, props) {
         const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {

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

@@ -2,24 +2,18 @@ import { TagProps } from '../../../types';
 import * as cf from 'aws-cdk-lib/aws-cloudfront';
 import { CloudFrontWebDistributionProps, FunctionProps } from 'aws-cdk-lib/aws-cloudfront';
 /**
- * @category cdk-utils.cloudfront-manager
- * @subcategory Properties
  */
 export interface CloudFrontProps extends CloudFrontWebDistributionProps {
     tags?: TagProps[];
 }
 /**
- * @category cdk-utils.cloudfront-manager
- * @subcategory Properties
  */
 export interface DistributionProps extends cf.DistributionProps {
     tags?: TagProps[];
 }
 /**
- * @category cdk-utils.cloudfront-manager
- * @subcategory Properties
  */
 export interface CloudfrontFunctionProps extends FunctionProps {
-    functionFilePath: string;
     eventType: string;
+    functionFilePath: string;
 }

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

@@ -4,9 +4,6 @@ import * as s3 from 'aws-cdk-lib/aws-s3';
 import { CommonConstruct } from '../../../common';
 import { CloudTrailProps } 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 CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -27,22 +24,21 @@ import { CloudTrailProps } from './types';
  *     )
  *   }
  * }
- *
  * @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 {CommonConstruct} scope scope in which this resource is defined
-     * @param {CloudTrailProps} props
-     * @param {logs.CfnLogGroup} logGroup
-     * @param {s3.IBucket} dataBucket
-     * @param {s3.IBucket} logBucket
-     * @param {s3.CfnBucketPolicy} logBucketPolicy
+     * @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
      */
     createCloudTrail(id: string, scope: CommonConstruct, props: CloudTrailProps, logGroup: logs.CfnLogGroup, dataBucket: s3.IBucket, logBucket: s3.IBucket, logBucketPolicy: s3.CfnBucketPolicy): {
-        cloudTrailRole: import("aws-cdk-lib/aws-iam").CfnRole;
         cloudTrail: cloudtrail.CfnTrail;
+        cloudTrailRole: import("aws-cdk-lib/aws-iam").CfnRole;
     };
 }

package/dist/src/lib/services/aws/cloudtrail/main.js

@@ -27,9 +27,6 @@ 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 CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -50,19 +47,18 @@ const utils = __importStar(require("../../../utils"));
  *     )
  *   }
  * }
- *
  * @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 {CommonConstruct} scope scope in which this resource is defined
-     * @param {CloudTrailProps} props
-     * @param {logs.CfnLogGroup} logGroup
-     * @param {s3.IBucket} dataBucket
-     * @param {s3.IBucket} logBucket
-     * @param {s3.CfnBucketPolicy} logBucketPolicy
+     * @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
      */
     createCloudTrail(id, scope, props, logGroup, dataBucket, logBucket, logBucketPolicy) {
         if (!props)
@@ -97,7 +93,7 @@ class CloudTrailManager {
         cloudTrail.addDependency(role);
         utils.createCfnOutput(`${id}-trailName`, scope, cloudTrail.trailName);
         utils.createCfnOutput(`${id}-trailArn`, scope, cloudTrail.attrArn);
-        return { cloudTrailRole: role, cloudTrail };
+        return { cloudTrail, cloudTrailRole: role };
     }
 }
 exports.CloudTrailManager = CloudTrailManager;

package/dist/src/lib/services/aws/cloudtrail/types.d.ts

@@ -1,7 +1,5 @@
 import { CfnTrailProps } from 'aws-cdk-lib/aws-cloudtrail';
 /**
- * @category cdk-utils.cloudtrail-manager
- * @subcategory Properties
  */
 export interface CloudTrailProps extends CfnTrailProps {
 }

package/dist/src/lib/services/aws/cloudwatch/logs.d.ts

@@ -3,9 +3,6 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import { CommonConstruct } from '../../../common';
 import { LogProps, MetricFilterProps } 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 CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -19,33 +16,32 @@ import { LogProps, MetricFilterProps } from './types';
  *     this.logsManager.createMetricFilter('MyMetricFilter', this, logGroup)
  *   }
  * }
- *
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
  */
 export declare class LogManager {
     /**
      * @summary Method to create a cloudwatch metric filter
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {MetricFilterProps} props
-     * @param {logs.ILogGroup} logGroup
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param logGroup
      */
     createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup): {
-        metricFilter: cdk.aws_logs.MetricFilter;
         metric: cdk.aws_cloudwatch.Metric;
+        metricFilter: cdk.aws_logs.MetricFilter;
     };
     /**
      * @summary Method to create a cloudwatch log group (cfn)
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LogProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps): cdk.aws_logs.CfnLogGroup;
     /**
      * @summary Method to create a cloudwatch log group
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LogProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createLogGroup(id: string, scope: CommonConstruct, props: LogProps): cdk.aws_logs.LogGroup;
 }

package/dist/src/lib/services/aws/cloudwatch/logs.js

@@ -28,9 +28,6 @@ const cdk = __importStar(require("aws-cdk-lib"));
 const logs = __importStar(require("aws-cdk-lib/aws-logs"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @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 CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
@@ -44,42 +41,41 @@ const utils = __importStar(require("../../../utils"));
  *     this.logsManager.createMetricFilter('MyMetricFilter', this, logGroup)
  *   }
  * }
- *
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
  */
 class LogManager {
     /**
      * @summary Method to create a cloudwatch metric filter
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {MetricFilterProps} props
-     * @param {logs.ILogGroup} logGroup
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @param logGroup
      */
     createMetricFilter(id, scope, props, logGroup) {
         if (!props)
             throw `MetricFilter props undefined for ${id}`;
         const metricFilter = new logs.MetricFilter(scope, `${id}`, {
+            defaultValue: props.defaultValue,
+            filterPattern: props.filterPattern,
             logGroup: logGroup,
             metricName: props.metricName,
             metricNamespace: props.metricNamespace,
             metricValue: props.metricValue,
-            defaultValue: props.defaultValue,
-            filterPattern: props.filterPattern,
         });
         const metric = props.options
             ? metricFilter.metric({
                 dimensionsMap: props.options.dimensionsMap,
-                statistic: props.options.statistic,
                 period: props.periodInSecs ? cdk.Duration.seconds(props.periodInSecs) : cdk.Duration.minutes(5),
+                statistic: props.options.statistic,
             })
             : metricFilter.metric();
-        return { metricFilter, metric };
+        return { metric, metricFilter };
     }
     /**
      * @summary Method to create a cloudwatch log group (cfn)
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LogProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createCfnLogGroup(id, scope, props) {
         if (!props)
@@ -99,9 +95,9 @@ class LogManager {
     }
     /**
      * @summary Method to create a cloudwatch log group
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {LogProps} props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
      */
     createLogGroup(id, scope, props) {
         if (!props)
@@ -109,8 +105,8 @@ class LogManager {
         const logGroup = new logs.LogGroup(scope, `${id}`, {
             ...props,
             logGroupName: `${props.logGroupName}-${scope.props.stage}`,
-            retention: props.retention,
             removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
+            retention: props.retention,
         });
         if (props.tags && props.tags.length > 0) {
             props.tags.forEach(tag => {