@gradientedge/cdk-utils-aws 2.5.0 → 2.7.0

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

@@ -25,36 +25,36 @@ export declare class CloudWatchManager {
      * @summary Method to create a cloudwatch alarm for a given expression
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the alarm properties including the math expression and metrics
      */
     createAlarmForExpression(id: string, scope: CommonConstruct, props: AlarmProps): cdk.aws_cloudwatch.Alarm;
     /**
      * @summary Method to create a cloudwatch alarm for a given metric
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param metric
+     * @param props the alarm properties
+     * @param metric the CloudWatch metric to create the alarm for
      */
     createAlarmForMetric(id: string, scope: CommonConstruct, props: AlarmProps, metric: watch.Metric): cdk.aws_cloudwatch.Alarm;
     /**
      * @summary Method to create a cloudwatch dashboard
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param widgets
+     * @param props the dashboard properties
+     * @param widgets optional 2D array of widgets to add to the dashboard
      */
     createDashboard(id: string, scope: CommonConstruct, props: DashboardProps, widgets?: watch.IWidget[][]): cdk.aws_cloudwatch.Dashboard;
     /**
      * @summary Method to create cloudwatch widgets
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props array of widget properties
      */
     createWidgets(scope: CommonConstruct, props: any[]): any;
     /**
-     * @summary Method to create a cloudwatch widget
+     * @summary Method to create a cloudwatch widget based on type
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the widget properties including the type discriminator
      */
     createWidget(id: string, scope: CommonConstruct, props: any): cdk.aws_cloudwatch.TextWidget | cdk.aws_cloudwatch.SingleValueWidget | cdk.aws_cloudwatch.GaugeWidget | cdk.aws_cloudwatch.GraphWidget | cdk.aws_cloudwatch.AlarmStatusWidget | cdk.aws_cloudwatch.LogQueryWidget;
     /**
@@ -143,66 +143,66 @@ export declare class CloudWatchManager {
      * @summary Method to create a cloudwatch text widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the text widget properties
      */
     createTextWidget(id: string, scope: CommonConstruct, props: TextWidgetProps): cdk.aws_cloudwatch.TextWidget;
     /**
      * @summary Method to create a cloudwatch numeric widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param metrics
+     * @param props the numeric widget properties
+     * @param metrics the metrics to display in the widget
      */
     createSingleValueWidget(id: string, scope: CommonConstruct, props: NumericWidgetProps, metrics: IMetric[]): cdk.aws_cloudwatch.SingleValueWidget;
     /**
-     * @summary Method to create a cloudwatch guage widget
+     * @summary Method to create a cloudwatch gauge widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param metrics
+     * @param props the gauge widget properties
+     * @param metrics the metrics to display in the widget
      */
     createGuageWidget(id: string, scope: CommonConstruct, props: GuageWidgetProps, metrics: IMetric[]): cdk.aws_cloudwatch.GaugeWidget;
     /**
      * @summary Method to create a cloudwatch graph widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param leftYMetrics
-     * @param rightYMetrics
+     * @param props the graph widget properties
+     * @param leftYMetrics optional metrics to display on the left Y axis
+     * @param rightYMetrics optional metrics to display on the right Y axis
      */
     createGraphWidget(id: string, scope: CommonConstruct, props: GraphWidgetProps, leftYMetrics?: IMetric[], rightYMetrics?: IMetric[]): cdk.aws_cloudwatch.GraphWidget;
     /**
      * @summary Method to create a cloudwatch alarm status widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param alarms
+     * @param props the alarm status widget properties
+     * @param alarms the alarms to display status for
      */
     createAlarmStatusWidget(id: string, scope: CommonConstruct, props: AlarmStatusWidgetProps, alarms: watch.IAlarm[]): cdk.aws_cloudwatch.AlarmStatusWidget;
     /**
      * @summary Method to create a cloudwatch log query widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param logGroupNames
+     * @param props the log query widget properties
+     * @param logGroupNames the log group names to query
      */
     createLogQueryWidget(id: string, scope: CommonConstruct, props: LogQueryWidgetProps, logGroupNames: string[]): cdk.aws_cloudwatch.LogQueryWidget;
     /**
      * @summary Utility method to determine the metrics and dimensions
      * @param scope scope in which this resource is defined
-     * @param metricProps
+     * @param metricProps array of metric properties to resolve into CloudWatch metrics
      */
     private determineMetrics;
     /**
      * @summary Utility method to determine the time range
-     * @param range
+     * @param range a time range string (e.g. 'START_TODAY', 'END_TODAY') or a custom value
      */
     private static determineTimeRange;
     /**
      * @summary Utility method to determine the configured alarms
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param alarmProps
+     * @param alarmProps array of alarm properties to resolve into alarm references
      */
     private determineAlarms;
 }

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

@@ -3,6 +3,7 @@ import * as watch from 'aws-cdk-lib/aws-cloudwatch';
 import _ from 'lodash';
 import * as utils from '../../utils/index.js';
 /**
+ * Supported CloudWatch dashboard widget types.
  */
 var CloudWatchWidgetType;
 (function (CloudWatchWidgetType) {
@@ -35,7 +36,7 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch alarm for a given expression
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the alarm properties including the math expression and metrics
      */
     createAlarmForExpression(id, scope, props) {
         if (!props)
@@ -67,8 +68,8 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch alarm for a given metric
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param metric
+     * @param props the alarm properties
+     * @param metric the CloudWatch metric to create the alarm for
      */
     createAlarmForMetric(id, scope, props, metric) {
         if (!props)
@@ -84,8 +85,8 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch dashboard
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param widgets
+     * @param props the dashboard properties
+     * @param widgets optional 2D array of widgets to add to the dashboard
      */
     createDashboard(id, scope, props, widgets) {
         if (!props)
@@ -105,7 +106,7 @@ export class CloudWatchManager {
     /**
      * @summary Method to create cloudwatch widgets
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props array of widget properties
      */
     createWidgets(scope, props) {
         if (!props || props.length === 0)
@@ -117,10 +118,10 @@ export class CloudWatchManager {
         return widgets;
     }
     /**
-     * @summary Method to create a cloudwatch widget
+     * @summary Method to create a cloudwatch widget based on type
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the widget properties including the type discriminator
      */
     createWidget(id, scope, props) {
         if (!props)
@@ -312,7 +313,7 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch text widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the text widget properties
      */
     createTextWidget(id, scope, props) {
         if (!props)
@@ -328,8 +329,8 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch numeric widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param metrics
+     * @param props the numeric widget properties
+     * @param metrics the metrics to display in the widget
      */
     createSingleValueWidget(id, scope, props, metrics) {
         if (!props)
@@ -344,11 +345,11 @@ export class CloudWatchManager {
         return widget;
     }
     /**
-     * @summary Method to create a cloudwatch guage widget
+     * @summary Method to create a cloudwatch gauge widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param metrics
+     * @param props the gauge widget properties
+     * @param metrics the metrics to display in the widget
      */
     createGuageWidget(id, scope, props, metrics) {
         if (!props)
@@ -366,9 +367,9 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch graph widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param leftYMetrics
-     * @param rightYMetrics
+     * @param props the graph widget properties
+     * @param leftYMetrics optional metrics to display on the left Y axis
+     * @param rightYMetrics optional metrics to display on the right Y axis
      */
     createGraphWidget(id, scope, props, leftYMetrics, rightYMetrics) {
         if (!props)
@@ -387,8 +388,8 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch alarm status widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param alarms
+     * @param props the alarm status widget properties
+     * @param alarms the alarms to display status for
      */
     createAlarmStatusWidget(id, scope, props, alarms) {
         if (!props)
@@ -405,8 +406,8 @@ export class CloudWatchManager {
      * @summary Method to create a cloudwatch log query widget
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param logGroupNames
+     * @param props the log query widget properties
+     * @param logGroupNames the log group names to query
      */
     createLogQueryWidget(id, scope, props, logGroupNames) {
         if (!props)
@@ -423,7 +424,7 @@ export class CloudWatchManager {
     /**
      * @summary Utility method to determine the metrics and dimensions
      * @param scope scope in which this resource is defined
-     * @param metricProps
+     * @param metricProps array of metric properties to resolve into CloudWatch metrics
      */
     determineMetrics(scope, metricProps) {
         const metrics = [];
@@ -527,7 +528,7 @@ export class CloudWatchManager {
     }
     /**
      * @summary Utility method to determine the time range
-     * @param range
+     * @param range a time range string (e.g. 'START_TODAY', 'END_TODAY') or a custom value
      */
     static determineTimeRange(range) {
         const moment = require('moment');
@@ -544,7 +545,7 @@ export class CloudWatchManager {
      * @summary Utility method to determine the configured alarms
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param alarmProps
+     * @param alarmProps array of alarm properties to resolve into alarm references
      */
     determineAlarms(id, scope, alarmProps) {
         const alarms = [];

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

@@ -2,99 +2,165 @@ import * as watch from 'aws-cdk-lib/aws-cloudwatch';
 import * as logs from 'aws-cdk-lib/aws-logs';
 import { TagProps } from '../../types/index.js';
 /**
+ * Props for creating a CloudWatch alarm, supporting both metric-based and math-expression-based alarms.
+ * @see {@link CloudWatchManager.createAlarmForMetric}
+ * @see {@link CloudWatchManager.createAlarmForExpression}
  */
 /** @category Interface */
 export interface AlarmProps extends watch.AlarmProps {
+    /** A math expression string referencing metrics (e.g. "m0 + m1") */
     expression?: string;
+    /** Array of metric properties used in a math expression alarm */
     metricProps?: MetricProps[];
+    /** The evaluation period in seconds (defaults to 5 minutes) */
     periodInSecs?: number;
 }
 /**
+ * Props for creating a CloudWatch dashboard.
+ * @see {@link CloudWatchManager.createDashboard}
  */
 /** @category Interface */
 export interface DashboardProps extends watch.DashboardProps {
 }
 /**
+ * Props for defining a CloudWatch metric with service-specific dimension support.
+ * @see {@link CloudWatchManager}
  */
 /** @category Interface */
 export interface MetricProps extends watch.MetricProps {
+    /** The API Gateway API name dimension */
     apiName?: string;
+    /** The ElastiCache cluster ID dimension */
     cacheClusterId?: string;
+    /** The ECS cluster name dimension */
     clusterName?: string;
+    /** The RDS DB cluster identifier dimension */
     dbClusterIdentifier?: string;
+    /** The CloudFront distribution ID dimension */
     distributionId?: string;
+    /** The EventBridge event bus name dimension */
     eventBusName?: string;
+    /** The Lambda function name dimension */
     functionName?: string;
+    /** The ELB load balancer reference dimension */
     loadBalancer?: string;
+    /** The metric period in seconds (defaults to 5 minutes) */
     periodInSecs?: number;
+    /** The EventBridge rule name dimension */
     ruleName?: string;
+    /** A custom service identifier dimension */
     service?: string;
+    /** The ECS service name dimension */
     serviceName?: string;
+    /** Whether to append the deployment stage to the metric name and namespace */
     stageSuffix: boolean;
+    /** The Step Functions state machine ARN dimension */
     stateMachineArn?: string;
 }
 /**
+ * Props for creating a CloudWatch text widget with positioning.
+ * @see {@link CloudWatchManager.createTextWidget}
  */
 /** @category Interface */
 export interface TextWidgetProps extends watch.TextWidgetProps {
+    /** The X position of the widget on the dashboard grid */
     positionX: number;
+    /** The Y position of the widget on the dashboard grid */
     positionY: number;
+    /** The widget type identifier */
     type: string;
 }
 /**
+ * Props for creating a CloudWatch single-value numeric widget with positioning.
+ * @see {@link CloudWatchManager.createSingleValueWidget}
  */
 /** @category Interface */
 export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
+    /** Array of metric properties to display in the widget */
     metricProps: watch.MetricProps[];
+    /** The X position of the widget on the dashboard grid */
     positionX: number;
+    /** The Y position of the widget on the dashboard grid */
     positionY: number;
+    /** The widget type identifier */
     type: string;
 }
 /**
+ * Props for creating a CloudWatch gauge widget with positioning.
+ * @see {@link CloudWatchManager.createGuageWidget}
  */
 /** @category Interface */
 export interface GuageWidgetProps extends watch.GaugeWidgetProps {
+    /** Array of metric properties to display in the widget */
     metricProps: watch.MetricProps[];
+    /** The X position of the widget on the dashboard grid */
     positionX: number;
+    /** The Y position of the widget on the dashboard grid */
     positionY: number;
+    /** The widget type identifier */
     type: string;
 }
 /**
+ * Props for creating a CloudWatch graph widget with positioning.
+ * @see {@link CloudWatchManager.createGraphWidget}
  */
 /** @category Interface */
 export interface GraphWidgetProps extends watch.GraphWidgetProps {
+    /** Array of metric properties to plot on the graph */
     metricProps: MetricProps[];
+    /** The X position of the widget on the dashboard grid */
     positionX: number;
+    /** The Y position of the widget on the dashboard grid */
     positionY: number;
+    /** The widget type identifier */
     type: string;
 }
 /**
+ * Props for creating a CloudWatch alarm status widget with positioning.
+ * @see {@link CloudWatchManager.createAlarmStatusWidget}
  */
 /** @category Interface */
 export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
+    /** Array of alarm properties to display in the widget */
     alarmProps: watch.AlarmProps[];
+    /** The X position of the widget on the dashboard grid */
     positionX: number;
+    /** The Y position of the widget on the dashboard grid */
     positionY: number;
+    /** The widget type identifier */
     type: string;
 }
 /**
+ * Props for creating a CloudWatch log query widget with positioning.
+ * @see {@link CloudWatchManager.createLogQueryWidget}
  */
 /** @category Interface */
 export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
+    /** The X position of the widget on the dashboard grid */
     positionX: number;
+    /** The Y position of the widget on the dashboard grid */
     positionY: number;
+    /** The widget type identifier */
     type: string;
 }
 /**
+ * Props for creating a CloudWatch metric filter with metric options.
+ * @see {@link LogManager.createMetricFilter}
  */
 /** @category Interface */
 export interface MetricFilterProps extends logs.MetricFilterProps {
+    /** The metric options applied when retrieving the metric from the filter */
     options: watch.MetricOptions;
+    /** The metric period in seconds (defaults to 5 minutes) */
     periodInSecs: number;
 }
 /**
+ * Props for creating a CloudWatch log group with optional tags.
+ * @see {@link LogManager.createLogGroup}
+ * @see {@link LogManager.createCfnLogGroup}
  */
 /** @category Interface */
 export interface LogProps extends logs.LogGroupProps {
+    /** Optional tags to apply to the log group */
     tags?: TagProps[];
 }

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

@@ -15,7 +15,7 @@ import { TableProps, TablePropsV2 } from './types.js';
  *     this.dynamodbManager.createTable('MyTable', this, tableProps)
  *   }
  * }
- * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
+ * @see [CDK DynamoDB Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
  * @category Service
  */
 export declare class DynamodbManager {
@@ -27,7 +27,7 @@ export declare class DynamodbManager {
      */
     createTable(id: string, scope: CommonConstruct, props: TableProps): Table;
     /**
-     * @summary Method to create a table
+     * @summary Method to create a table (v2) using the TableV2 construct
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props table props

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

@@ -16,7 +16,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *     this.dynamodbManager.createTable('MyTable', this, tableProps)
  *   }
  * }
- * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
+ * @see [CDK DynamoDB Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
  * @category Service
  */
 export class DynamodbManager {
@@ -47,7 +47,7 @@ export class DynamodbManager {
         return table;
     }
     /**
-     * @summary Method to create a table
+     * @summary Method to create a table (v2) using the TableV2 construct
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props table props

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

@@ -1,12 +1,20 @@
 import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
 import { TagProps } from '../../types/index.js';
 /**
+ * Props for creating a DynamoDB table (v1) with optional tags.
+ * @see {@link DynamodbManager.createTable}
  */
 /** @category Interface */
 export interface TableProps extends dynamodb.TableProps {
+    /** Optional tags to apply to the table */
     tags?: TagProps[];
 }
+/**
+ * Props for creating a DynamoDB table (v2) with optional tags.
+ * @see {@link DynamodbManager.createTableV2}
+ */
 /** @category Interface */
 export interface TablePropsV2 extends dynamodb.TablePropsV2 {
+    /** Optional tags to apply to the table */
     tags?: TagProps[];
 }

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

@@ -22,7 +22,7 @@ export declare class EcrManager {
      * @summary Method to create a docker image in ecr
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param dockerfilePath
+     * @param dockerfilePath the path to the directory containing the Dockerfile
      */
     createDockerImage(id: string, scope: CommonConstruct, dockerfilePath: string): DockerImageAsset;
 }

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

@@ -22,7 +22,7 @@ export class EcrManager {
      * @summary Method to create a docker image in ecr
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param dockerfilePath
+     * @param dockerfilePath the path to the directory containing the Dockerfile
      */
     createDockerImage(id, scope, dockerfilePath) {
         const asset = new DockerImageAsset(scope, `${id}`, {

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

@@ -27,31 +27,31 @@ export declare class EcsManager {
      * @summary Method to create an ecs cluster
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param vpc
+     * @param props the ECS cluster properties
+     * @param vpc the VPC in which the cluster will be created
      */
     createEcsCluster(id: string, scope: CommonConstruct, props: EcsClusterProps, vpc: IVpc): Cluster;
     /**
      * @summary Method to create an ecs fargate task
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param cluster
-     * @param role
-     * @param logGroup
-     * @param containerImage
-     * @param environment
-     * @param secrets
-     * @param command
+     * @param props the ECS task definition properties
+     * @param cluster the ECS cluster to associate with the task
+     * @param role the IAM role for task execution and task role
+     * @param logGroup the CloudWatch log group for container logging
+     * @param containerImage the container image to use for the task
+     * @param environment optional environment variables for the container
+     * @param secrets optional secret values to inject into the container
+     * @param command optional command to override the container entrypoint
      */
     createEcsFargateTask(id: string, scope: CommonConstruct, props: EcsTaskProps, cluster: ICluster, role: Role, logGroup: ILogGroup, containerImage: ContainerImage, environment?: any, secrets?: any, command?: string[]): TaskDefinition;
     /**
      * @summary Method to create an application load balanced ecs fargate task
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param cluster
-     * @param logGroup
+     * @param props the Application Load Balanced Fargate service properties
+     * @param cluster the ECS cluster to deploy the service into
+     * @param logGroup the CloudWatch log group for container logging
      */
     createLoadBalancedFargateService(id: string, scope: CommonConstruct, props: EcsApplicationLoadBalancedFargateServiceProps, cluster: ICluster, logGroup: ILogGroup): ApplicationLoadBalancedFargateService;
 }

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

@@ -25,8 +25,8 @@ export class EcsManager {
      * @summary Method to create an ecs cluster
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param vpc
+     * @param props the ECS cluster properties
+     * @param vpc the VPC in which the cluster will be created
      */
     createEcsCluster(id, scope, props, vpc) {
         if (!props)
@@ -49,18 +49,19 @@ export class EcsManager {
      * @summary Method to create an ecs fargate task
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param cluster
-     * @param role
-     * @param logGroup
-     * @param containerImage
-     * @param environment
-     * @param secrets
-     * @param command
+     * @param props the ECS task definition properties
+     * @param cluster the ECS cluster to associate with the task
+     * @param role the IAM role for task execution and task role
+     * @param logGroup the CloudWatch log group for container logging
+     * @param containerImage the container image to use for the task
+     * @param environment optional environment variables for the container
+     * @param secrets optional secret values to inject into the container
+     * @param command optional command to override the container entrypoint
      */
     createEcsFargateTask(id, scope, props, cluster, role, logGroup, containerImage, environment, secrets, command) {
         if (!props)
             throw new Error(`EcsTask props undefined for ${id}`);
+        /* Create a Fargate-compatible task definition with AWS VPC networking */
         const ecsTask = new TaskDefinition(scope, `${id}`, {
             ...props,
             compatibility: Compatibility.FARGATE,
@@ -73,6 +74,7 @@ export class EcsManager {
             },
             taskRole: role,
         });
+        /* Add the primary container to the task definition with logging and resource limits */
         ecsTask.addContainer('EcsContainer', {
             command,
             cpu: props.cpu ? parseInt(props.cpu) : undefined,
@@ -101,9 +103,9 @@ export class EcsManager {
      * @summary Method to create an application load balanced ecs fargate task
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param cluster
-     * @param logGroup
+     * @param props the Application Load Balanced Fargate service properties
+     * @param cluster the ECS cluster to deploy the service into
+     * @param logGroup the CloudWatch log group for container logging
      */
     createLoadBalancedFargateService(id, scope, props, cluster, logGroup) {
         if (!props)
@@ -138,6 +140,7 @@ export class EcsManager {
                     }),
             },
         });
+        /* Configure target group health check if specified, converting seconds to Duration */
         if (props.healthCheck) {
             fargateService.targetGroup.configureHealthCheck({
                 ...props.healthCheck,