@gradientedge/cdk-utils-aws 1.0.1 → 2.1.0

package/dist/src/services/cloudwatch/main.js

@@ -14,7 +14,7 @@ var CloudWatchWidgetType;
     CloudWatchWidgetType["LogQuery"] = "LogQuery";
 })(CloudWatchWidgetType || (CloudWatchWidgetType = {}));
 /**
- * @classdesc Provides operations on AWS CloudWatch.
+ * 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.
  * @example
@@ -28,6 +28,7 @@ var CloudWatchWidgetType;
  *   }
  * }
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
+ * @category Service
  */
 export class CloudWatchManager {
     /**
@@ -38,11 +39,11 @@ export class CloudWatchManager {
      */
     createAlarmForExpression(id, scope, props) {
         if (!props)
-            throw `Alarm props undefined for ${id}`;
+            throw new Error(`Alarm props undefined for ${id}`);
         if (!props.expression)
-            throw `Could not find expression for Alarm props for id:${id}`;
+            throw new Error(`Could not find expression for Alarm props for id:${id}`);
         if (!props.metricProps)
-            throw `Could not find metricProps for Alarm props for id:${id}`;
+            throw new Error(`Could not find metricProps for Alarm props for id:${id}`);
         const metrics = {};
         _.map(this.determineMetrics(scope, props.metricProps), (metric, index) => {
             metrics[`m${index}`] = metric;
@@ -69,7 +70,7 @@ export class CloudWatchManager {
      */
     createAlarmForMetric(id, scope, props, metric) {
         if (!props)
-            throw `Alarm props undefined for ${id}`;
+            throw new Error(`Alarm props undefined for ${id}`);
         const alarm = metric.createAlarm(scope, `${id}`, {
             ...props,
         });
@@ -86,9 +87,9 @@ export class CloudWatchManager {
      */
     createDashboard(id, scope, props, widgets) {
         if (!props)
-            throw `Dashboard props undefined for ${id}`;
+            throw new Error(`Dashboard props undefined for ${id}`);
         if (!props.dashboardName)
-            throw `Dashboard dashboardName undefined for ${id}`;
+            throw new Error(`Dashboard dashboardName undefined for ${id}`);
         const dashboard = new watch.Dashboard(scope, `${id}`, {
             ...props,
             dashboardName: scope.resourceNameFormatter.format(props.dashboardName, scope.props.resourceNameOptions?.cloudwatch),
@@ -105,8 +106,8 @@ export class CloudWatchManager {
      * @param props
      */
     createWidgets(scope, props) {
-        if (!props || props.length == 0)
-            throw `Widget props undefined`;
+        if (!props || props.length === 0)
+            throw new Error(`Widget props undefined`);
         const widgets = [];
         _.forEach(props, (widgetProps) => {
             widgets.push(this.createWidget(widgetProps.id, scope, widgetProps));
@@ -121,7 +122,7 @@ export class CloudWatchManager {
      */
     createWidget(id, scope, props) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metrics = this.determineMetrics(scope, props.metricProps);
         let alarms, logGroupNames = [];
         switch (props.type) {
@@ -140,7 +141,7 @@ export class CloudWatchManager {
                 logGroupNames = props.logGroupNames.map((name) => `${name}-${scope.props.stage}`);
                 return this.createLogQueryWidget(id, scope, props, logGroupNames);
             default:
-                throw `Unsupported widget type ${props.type}`;
+                throw new Error(`Unsupported widget type ${props.type}`);
         }
     }
     /**
@@ -152,7 +153,7 @@ export class CloudWatchManager {
      */
     createCloudfrontDistributionWidget(id, scope, props, distributionId) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -168,7 +169,7 @@ export class CloudWatchManager {
      */
     createStateWidget(id, scope, props, stateMachineArn) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -185,7 +186,7 @@ export class CloudWatchManager {
      */
     createEventWidget(id, scope, props, eventBusName, ruleName) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -201,7 +202,7 @@ export class CloudWatchManager {
      */
     createApiGatewayWidget(id, scope, props, apiName) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -217,7 +218,7 @@ export class CloudWatchManager {
      */
     createLambdaWidget(id, scope, props, functionName) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -233,7 +234,7 @@ export class CloudWatchManager {
      */
     createCustomWidget(id, scope, props, service) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -249,7 +250,7 @@ export class CloudWatchManager {
      */
     createEcsClusterWidget(id, scope, props, clusterName) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -266,7 +267,7 @@ export class CloudWatchManager {
      */
     createEcsServiceWidget(id, scope, props, clusterName, serviceName) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -282,7 +283,7 @@ export class CloudWatchManager {
      */
     createElbWidget(id, scope, props, loadBalancer) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -298,7 +299,7 @@ export class CloudWatchManager {
      */
     createCacheWidget(id, scope, props, cacheClusterId) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const metricProps = props.metricProps;
         return this.createWidget(id, scope, {
             ...props,
@@ -313,7 +314,7 @@ export class CloudWatchManager {
      */
     createTextWidget(id, scope, props) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const widget = new watch.TextWidget({
             ...props,
         });
@@ -330,7 +331,7 @@ export class CloudWatchManager {
      */
     createSingleValueWidget(id, scope, props, metrics) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const widget = new watch.SingleValueWidget({
             ...props,
             metrics,
@@ -349,7 +350,7 @@ export class CloudWatchManager {
      */
     createGuageWidget(id, scope, props, metrics) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const widget = new watch.GaugeWidget({
             ...props,
             metrics,
@@ -369,7 +370,7 @@ export class CloudWatchManager {
      */
     createGraphWidget(id, scope, props, leftYMetrics, rightYMetrics) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const widget = new watch.GraphWidget({
             ...props,
             left: leftYMetrics,
@@ -389,7 +390,7 @@ export class CloudWatchManager {
      */
     createAlarmStatusWidget(id, scope, props, alarms) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const widget = new watch.AlarmStatusWidget({
             ...props,
             alarms,
@@ -407,7 +408,7 @@ export class CloudWatchManager {
      */
     createLogQueryWidget(id, scope, props, logGroupNames) {
         if (!props)
-            throw `Widget props undefined for ${id}`;
+            throw new Error(`Widget props undefined for ${id}`);
         const widget = new watch.LogQueryWidget({
             ...props,
             logGroupNames,
@@ -541,7 +542,7 @@ export class CloudWatchManager {
         if (alarmProps) {
             _.forEach(alarmProps, (alarmProp) => {
                 if (!alarmProp.alarmName)
-                    throw `Alarm name undefined for ${id}`;
+                    throw new Error(`Alarm name undefined for ${id}`);
                 const alarmArn = `arn:aws:cloudwatch:${cdk.Stack.of(scope).region}:${cdk.Stack.of(scope).account}:alarm:${alarmProp.alarmName}`;
                 const alarm = watch.Alarm.fromAlarmArn(scope, `${alarmProp.alarmName}`, alarmArn);
                 alarms.push(alarm);

package/dist/src/services/cloudwatch/types.d.ts

@@ -3,6 +3,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import { TagProps } from '../../types/index.js';
 /**
  */
+/** @category Interface */
 export interface AlarmProps extends watch.AlarmProps {
     expression?: string;
     metricProps?: MetricProps[];
@@ -10,10 +11,12 @@ export interface AlarmProps extends watch.AlarmProps {
 }
 /**
  */
+/** @category Interface */
 export interface DashboardProps extends watch.DashboardProps {
 }
 /**
  */
+/** @category Interface */
 export interface MetricProps extends watch.MetricProps {
     apiName?: string;
     cacheClusterId?: string;
@@ -32,6 +35,7 @@ export interface MetricProps extends watch.MetricProps {
 }
 /**
  */
+/** @category Interface */
 export interface TextWidgetProps extends watch.TextWidgetProps {
     positionX: number;
     positionY: number;
@@ -39,6 +43,7 @@ export interface TextWidgetProps extends watch.TextWidgetProps {
 }
 /**
  */
+/** @category Interface */
 export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
     metricProps: watch.MetricProps[];
     positionX: number;
@@ -47,6 +52,7 @@ export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
 }
 /**
  */
+/** @category Interface */
 export interface GuageWidgetProps extends watch.GaugeWidgetProps {
     metricProps: watch.MetricProps[];
     positionX: number;
@@ -55,6 +61,7 @@ export interface GuageWidgetProps extends watch.GaugeWidgetProps {
 }
 /**
  */
+/** @category Interface */
 export interface GraphWidgetProps extends watch.GraphWidgetProps {
     metricProps: MetricProps[];
     positionX: number;
@@ -63,6 +70,7 @@ export interface GraphWidgetProps extends watch.GraphWidgetProps {
 }
 /**
  */
+/** @category Interface */
 export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
     alarmProps: watch.AlarmProps[];
     positionX: number;
@@ -71,6 +79,7 @@ export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
 }
 /**
  */
+/** @category Interface */
 export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
     positionX: number;
     positionY: number;
@@ -78,12 +87,14 @@ export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
 }
 /**
  */
+/** @category Interface */
 export interface MetricFilterProps extends logs.MetricFilterProps {
     options: watch.MetricOptions;
     periodInSecs: number;
 }
 /**
  */
+/** @category Interface */
 export interface LogProps extends logs.LogGroupProps {
     tags?: TagProps[];
 }

package/dist/src/services/codebuild/main.d.ts

@@ -1,7 +1,7 @@
 import { Project } from 'aws-cdk-lib/aws-codebuild';
 import { CommonConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides operations on AWS Code Build.
+ * Provides operations on AWS Code Build.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { CommonConstruct } from '../../common/index.js';
  *   }
  * }
  * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
+ * @category Service
  */
 export declare class CodeBuildManager {
     /**

package/dist/src/services/codebuild/main.js

@@ -1,7 +1,7 @@
 import { Duration } from 'aws-cdk-lib';
 import { BuildSpec, ComputeType, LinuxBuildImage, Project } from 'aws-cdk-lib/aws-codebuild';
 /**
- * @classdesc Provides operations on AWS Code Build.
+ * Provides operations on AWS Code Build.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { BuildSpec, ComputeType, LinuxBuildImage, Project } from 'aws-cdk-lib/aw
  *   }
  * }
  * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
+ * @category Service
  */
 export class CodeBuildManager {
     /**

package/dist/src/services/constants.d.ts

@@ -1,3 +1,4 @@
+/** @category Enum */
 export declare enum Architecture {
     ARM_64 = "ARM_64",
     X86_64 = "X86_64"

package/dist/src/services/constants.js

@@ -1,3 +1,4 @@
+/** @category Enum */
 export var Architecture;
 (function (Architecture) {
     Architecture["ARM_64"] = "ARM_64";

package/dist/src/services/dynamodb/main.d.ts

@@ -2,7 +2,7 @@ import { Table, TableV2 } from 'aws-cdk-lib/aws-dynamodb';
 import { CommonConstruct } from '../../common/index.js';
 import { TableProps, TablePropsV2 } from './types.js';
 /**
- * @classdesc Provides operations on AWS DynamoDB
+ * Provides operations on AWS DynamoDB
  * - 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
@@ -16,6 +16,7 @@ import { TableProps, TablePropsV2 } from './types.js';
  *   }
  * }
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
+ * @category Service
  */
 export declare class DynamodbManager {
     /**

package/dist/src/services/dynamodb/main.js

@@ -3,7 +3,7 @@ import { BillingMode, Table, TableV2, TableEncryption } from 'aws-cdk-lib/aws-dy
 import _ from 'lodash';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS DynamoDB
+ * Provides operations on AWS DynamoDB
  * - 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
@@ -17,6 +17,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
+ * @category Service
  */
 export class DynamodbManager {
     /**
@@ -27,9 +28,9 @@ export class DynamodbManager {
      */
     createTable(id, scope, props) {
         if (!props)
-            throw `Table props undefined for ${id}`;
+            throw new Error(`Table props undefined for ${id}`);
         if (!props.tableName)
-            throw `Table tableName undefined for ${id}`;
+            throw new Error(`Table tableName undefined for ${id}`);
         const table = new Table(scope, `${id}`, {
             ...props,
             billingMode: props.billingMode ?? BillingMode.PAY_PER_REQUEST,
@@ -53,9 +54,9 @@ export class DynamodbManager {
      */
     createTableV2(id, scope, props) {
         if (!props)
-            throw `Table props undefined for ${id}`;
+            throw new Error(`Table props undefined for ${id}`);
         if (!props.tableName)
-            throw `Table tableName undefined for ${id}`;
+            throw new Error(`Table tableName undefined for ${id}`);
         const table = new TableV2(scope, `${id}`, {
             ...props,
             tableName: scope.resourceNameFormatter.format(props.tableName, scope.props.resourceNameOptions?.table),

package/dist/src/services/dynamodb/types.d.ts

@@ -2,9 +2,11 @@ import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 import { TagProps } from '../../types/index.js';
 /**
  */
+/** @category Interface */
 export interface TableProps extends dynamodb.TableProps {
     tags?: TagProps[];
 }
+/** @category Interface */
 export interface TablePropsV2 extends dynamodb.TablePropsV2 {
     tags?: TagProps[];
 }

package/dist/src/services/elastic-container-registry/main.d.ts

@@ -1,7 +1,7 @@
 import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
 import { CommonConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides operations on AWS Elastic Container Registry.
+ * Provides operations on AWS Elastic Container Registry.
  * - 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
@@ -15,6 +15,7 @@ import { CommonConstruct } from '../../common/index.js';
  *   }
  * }
  * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
+ * @category Service
  */
 export declare class EcrManager {
     /**

package/dist/src/services/elastic-container-registry/main.js

@@ -1,7 +1,7 @@
 import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS Elastic Container Registry.
+ * Provides operations on AWS Elastic Container Registry.
  * - 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
@@ -15,6 +15,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
+ * @category Service
  */
 export class EcrManager {
     /**

package/dist/src/services/elastic-container-service/main.d.ts

@@ -6,7 +6,7 @@ import { ILogGroup } from 'aws-cdk-lib/aws-logs';
 import { CommonConstruct } from '../../common/index.js';
 import { EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EcsTaskProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS Elastic Container Service.
+ * Provides operations on AWS Elastic Container Service.
  * - 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
@@ -20,6 +20,7 @@ import { EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EcsTask
  *   }
  * }
  * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
+ * @category Service
  */
 export declare class EcsManager {
     /**

package/dist/src/services/elastic-container-service/main.js

@@ -4,7 +4,7 @@ import { ApplicationLoadBalancedFargateService } from 'aws-cdk-lib/aws-ecs-patte
 import _ from 'lodash';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS Elastic Container Service.
+ * Provides operations on AWS Elastic Container Service.
  * - 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
@@ -18,6 +18,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
+ * @category Service
  */
 export class EcsManager {
     /**
@@ -29,7 +30,7 @@ export class EcsManager {
      */
     createEcsCluster(id, scope, props, vpc) {
         if (!props)
-            throw `Ecs Cluster props undefined for ${id}`;
+            throw new Error(`Ecs Cluster props undefined for ${id}`);
         const ecsCluster = new Cluster(scope, `${id}`, {
             ...props,
             clusterName: `${props.clusterName}-${scope.props.stage}`,
@@ -59,7 +60,7 @@ export class EcsManager {
      */
     createEcsFargateTask(id, scope, props, cluster, role, logGroup, containerImage, environment, secrets, command) {
         if (!props)
-            throw `EcsTask props undefined for ${id}`;
+            throw new Error(`EcsTask props undefined for ${id}`);
         const ecsTask = new TaskDefinition(scope, `${id}`, {
             ...props,
             compatibility: Compatibility.FARGATE,
@@ -106,13 +107,13 @@ export class EcsManager {
      */
     createLoadBalancedFargateService(id, scope, props, cluster, logGroup) {
         if (!props)
-            throw `Ecs Load balanced Fargate Service props undefined for ${id}`;
+            throw new Error(`Ecs Load balanced Fargate Service props undefined for ${id}`);
         if (!props.loadBalancerName)
-            throw `Ecs loadBalancerName undefined for ${id}`;
+            throw new Error(`Ecs loadBalancerName undefined for ${id}`);
         if (!props.serviceName)
-            throw `Ecs serviceName undefined for ${id}`;
+            throw new Error(`Ecs serviceName undefined for ${id}`);
         if (!props.taskImageOptions)
-            throw `TaskImageOptions for Ecs Load balanced Fargate Service props undefined for ${id}`;
+            throw new Error(`TaskImageOptions for Ecs Load balanced Fargate Service props undefined for ${id}`);
         const fargateService = new ApplicationLoadBalancedFargateService(scope, `${id}-ecs-service`, {
             ...props,
             assignPublicIp: props.assignPublicIp ?? true,

package/dist/src/services/elastic-container-service/types.d.ts

@@ -5,15 +5,18 @@ import { HealthCheck as ElbHealthCheck } from 'aws-cdk-lib/aws-elasticloadbalanc
 import { TagProps } from '../../types/index.js';
 /**
  */
+/** @category Interface */
 export interface EcsClusterProps extends ClusterProps {
     tags?: TagProps[];
 }
 /**
  */
+/** @category Interface */
 export interface EcsTaskProps extends TaskDefinitionProps {
     logging?: AwsLogDriverProps;
     tags?: TagProps[];
 }
+/** @category Interface */
 export interface EcsScalingProps {
     maxCapacity?: number;
     minCapacity?: number;
@@ -24,6 +27,7 @@ export interface EcsScalingProps {
 }
 /**
  */
+/** @category Interface */
 export interface HealthCheck extends ElbHealthCheck {
     intervalInSecs: number;
     timeoutInSecs: number;
@@ -31,12 +35,14 @@ export interface HealthCheck extends ElbHealthCheck {
 /**
  *
  */
+/** @category Interface */
 export interface EcsApplicationLoadBalancedFargateServiceHealthCheck extends FargateHealthCheck {
     intervalInSecs: number;
     timeoutInSecs: number;
 }
 /**
  */
+/** @category Interface */
 export interface EcsApplicationLoadBalancedFargateServiceProps extends ApplicationLoadBalancedFargateServiceProps {
     healthCheck?: EcsApplicationLoadBalancedFargateServiceHealthCheck;
     logging?: AwsLogDriverProps;

package/dist/src/services/elastic-file-system/main.d.ts

@@ -2,17 +2,19 @@ import { ISecurityGroup, IVpc, SubnetSelection } from 'aws-cdk-lib/aws-ec2';
 import { FileSystem } from 'aws-cdk-lib/aws-efs';
 import { CommonConstruct } from '../../common/index.js';
 import { EfsAccessPointOptions, EfsFileSystemProps } from './types.js';
+/** @category Constant */
 export declare const DEFAULT_CREATE_ACL: {
     ownerGid: string;
     ownerUid: string;
     permissions: string;
 };
+/** @category Constant */
 export declare const DEFAULT_POSIX_USER: {
     gid: string;
     uid: string;
 };
 /**
- * @classdesc Provides operations on AWS Elastic File System.
+ * Provides operations on AWS Elastic File System.
  * - 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
@@ -26,6 +28,7 @@ export declare const DEFAULT_POSIX_USER: {
  *   }
  * }
  * @see [CDK EFS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_efs-readme.html}
+ * @category Service
  */
 export declare class EfsManager {
     /**

package/dist/src/services/elastic-file-system/main.js

@@ -2,17 +2,19 @@ import { RemovalPolicy } from 'aws-cdk-lib';
 import { FileSystem, LifecyclePolicy, OutOfInfrequentAccessPolicy, PerformanceMode } from 'aws-cdk-lib/aws-efs';
 import _ from 'lodash';
 import { createCfnOutput } from '../../utils/index.js';
+/** @category Constant */
 export const DEFAULT_CREATE_ACL = {
     ownerGid: '1000',
     ownerUid: '1000',
     permissions: '755',
 };
+/** @category Constant */
 export const DEFAULT_POSIX_USER = {
     gid: '1000',
     uid: '1000',
 };
 /**
- * @classdesc Provides operations on AWS Elastic File System.
+ * Provides operations on AWS Elastic File System.
  * - 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
@@ -26,6 +28,7 @@ export const DEFAULT_POSIX_USER = {
  *   }
  * }
  * @see [CDK EFS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_efs-readme.html}
+ * @category Service
  */
 export class EfsManager {
     /**
@@ -40,9 +43,9 @@ export class EfsManager {
      */
     createFileSystem(id, scope, props, vpc, accessPointOptions, securityGroup, vpcSubnets) {
         if (!props)
-            throw `EFS props undefined for ${id}`;
+            throw new Error(`EFS props undefined for ${id}`);
         if (!props.fileSystemName)
-            throw `EFS fileSystemName undefined for ${id}`;
+            throw new Error(`EFS fileSystemName undefined for ${id}`);
         const fileSystemId = props.provisionNewOnDeployment ? `${id}-${new Date().getMilliseconds()}` : `${id}`;
         const fileSystem = new FileSystem(scope, `${fileSystemId}`, {
             ...props,
@@ -61,7 +64,7 @@ export class EfsManager {
         if (accessPointOptions && !_.isEmpty(accessPointOptions)) {
             for (const [index, accessPointOption] of accessPointOptions.entries()) {
                 if (!accessPointOption.path)
-                    throw `Undefined access point path for option: [${accessPointOption}], id: [${id}]`;
+                    throw new Error(`Undefined access point path for option: [${accessPointOption}], id: [${id}]`);
                 const accessPoint = fileSystem.addAccessPoint(`${id}-ap-${index}`, {
                     createAcl: accessPointOption.createAcl ?? DEFAULT_CREATE_ACL,
                     path: accessPointOption.path,

package/dist/src/services/elastic-file-system/types.d.ts

@@ -2,6 +2,7 @@ import { AuthorizationConfig } from 'aws-cdk-lib/aws-ecs';
 import { AccessPointOptions, FileSystemProps } from 'aws-cdk-lib/aws-efs';
 /**
  */
+/** @category Interface */
 export interface EfsFileSystemProps extends FileSystemProps {
     authorizationConfig?: AuthorizationConfig;
     provisionNewOnDeployment?: boolean;
@@ -11,5 +12,6 @@ export interface EfsFileSystemProps extends FileSystemProps {
 }
 /**
  */
+/** @category Interface */
 export interface EfsAccessPointOptions extends AccessPointOptions {
 }