@gradientedge/cdk-utils-aws 1.0.1 → 2.1.0

package/dist/src/services/api-gateway/main.js

@@ -3,7 +3,7 @@ import { Cors, Deployment, DomainName, EndpointType, LambdaRestApi, LogGroupLogD
 import _ from 'lodash';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS API Gateway.
+ * Provides operations on AWS API Gateway.
  * - 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 API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
+ * @category Service
  */
 export class ApiManager {
     /**
@@ -29,9 +30,9 @@ export class ApiManager {
      */
     createLambdaRestApi(id, scope, props, lambdaFunction) {
         if (!props)
-            throw `Api props undefined for ${id}`;
+            throw new Error(`Api props undefined for ${id}`);
         if (!props.restApiName)
-            throw `Api restApiName undefined for ${id}`;
+            throw new Error(`Api restApiName undefined for ${id}`);
         const restApiName = scope.resourceNameFormatter.format(props.restApiName, scope.props.resourceNameOptions?.apigateway);
         const restApiAccessLogName = scope.resourceNameFormatter.format(`${props.restApiName}-access`, scope.props.resourceNameOptions?.apigateway);
         const accessLogGroup = scope.logManager.createLogGroup(`${id}-rest-api-access-log`, scope, {

package/dist/src/services/api-gateway/types.d.ts

@@ -2,9 +2,11 @@ import { LambdaRestApiProps as LambdaRestApigProps, RestApiProps } from 'aws-cdk
 import { TagProps } from '../../types/index.js';
 /**
  */
+/** @category Interface */
 export interface LambdaRestApiProps extends LambdaRestApigProps {
     tags?: TagProps[];
     minCompressionSizeInBytes?: number;
 }
+/** @category Interface */
 export interface RestApigProps extends RestApiProps {
 }

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

@@ -1,12 +1,14 @@
 /**
  * @returns { Map<string, string> } AppConfig extension ARN by region for x84
  */
+/** @category Constant */
 export declare const ArnsByRegionForX86_64: {
     [region: string]: string;
 };
 /**
  * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
  */
+/** @category Constant */
 export declare const ArnsByRegionForArm64: {
     [region: string]: string;
 };

package/dist/src/services/appconfig/constants.js

@@ -1,6 +1,7 @@
 /**
  * @returns { Map<string, string> } AppConfig extension ARN by region for x84
  */
+/** @category Constant */
 export const ArnsByRegionForX86_64 = {
     'af-south-1': 'arn:aws:lambda:af-south-1:574348263942:layer:AWS-AppConfig-Extension:116',
     'ap-east-1': 'arn:aws:lambda:ap-east-1:630222743974:layer:AWS-AppConfig-Extension:106',
@@ -37,6 +38,7 @@ export const ArnsByRegionForX86_64 = {
 /**
  * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
  */
+/** @category Constant */
 export const ArnsByRegionForArm64 = {
     'ap-northeast-1': 'arn:aws:lambda:ap-northeast-1:980059726660:layer:AWS-AppConfig-Extension-Arm64:72',
     'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension-Arm64:81',

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

@@ -3,7 +3,7 @@ import { CommonConstruct } from '../../common/index.js';
 import { Architecture } from '../constants.js';
 import { AppConfigProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS
+ * Provides operations on AWS
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { AppConfigProps } from './types.js';
  *   }
  * }
  * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
+ * @category Service
  */
 export declare class AppConfigManager {
     /**

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

@@ -4,7 +4,7 @@ import { createCfnOutput } from '../../utils/index.js';
 import { Architecture } from '../constants.js';
 import { ArnsByRegionForArm64, ArnsByRegionForX86_64 } from './constants.js';
 /**
- * @classdesc Provides operations on AWS
+ * Provides operations on AWS
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -18,6 +18,7 @@ import { ArnsByRegionForArm64, ArnsByRegionForX86_64 } from './constants.js';
  *   }
  * }
  * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
+ * @category Service
  */
 export class AppConfigManager {
     /**
@@ -32,7 +33,7 @@ export class AppConfigManager {
             case Architecture.X86_64:
                 return ArnsByRegionForX86_64[scope.props.region];
             default:
-                throw `Invalid type ${type} specified`;
+                throw new Error(`Invalid type ${type} specified`);
         }
     }
     /**
@@ -44,7 +45,7 @@ export class AppConfigManager {
      */
     createApplication(id, scope, props) {
         if (!props)
-            throw `AppConfig props undefined for ${id}`;
+            throw new Error(`AppConfig props undefined for ${id}`);
         const application = new CfnApplication(scope, `${id}`, {
             ...props.application,
             name: scope.resourceNameFormatter.format(props.application.name, scope.props.resourceNameOptions?.appconfig),
@@ -63,7 +64,7 @@ export class AppConfigManager {
      */
     createEnvironment(id, scope, applicationId, props) {
         if (!props)
-            throw `AppConfig props undefined for ${id}`;
+            throw new Error(`AppConfig props undefined for ${id}`);
         const environment = new CfnEnvironment(scope, `${id}`, {
             ...props.environment,
             applicationId,
@@ -84,7 +85,7 @@ export class AppConfigManager {
      */
     createConfigurationProfile(id, scope, applicationId, props) {
         if (!props)
-            throw `AppConfig props undefined for ${id}`;
+            throw new Error(`AppConfig props undefined for ${id}`);
         const profile = new CfnConfigurationProfile(scope, `${id}`, {
             ...props.configurationProfile,
             applicationId,
@@ -104,9 +105,9 @@ export class AppConfigManager {
      */
     createDeploymentStrategy(id, scope, props) {
         if (!props)
-            throw `AppConfig props undefined for ${id}`;
+            throw new Error(`AppConfig props undefined for ${id}`);
         if (!props.deploymentStrategy)
-            throw `AppConfig deploymentStrategy props undefined for ${id}`;
+            throw new Error(`AppConfig deploymentStrategy props undefined for ${id}`);
         const deploymentStrategy = new DeploymentStrategy(scope, `${id}`, {
             ...props,
             deploymentStrategyName: scope.resourceNameFormatter.format(props.deploymentStrategy.deploymentStrategyName ?? 'common-deployment-strategy', scope.props.resourceNameOptions?.appconfig),

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

@@ -2,11 +2,13 @@ import { CfnApplicationProps, CfnConfigurationProfileProps, CfnDeploymentProps,
 /**
  *
  */
+/** @category Interface */
 export interface AppConfigDeploymentStrategyProps extends DeploymentStrategyProps {
     deploymentStrategyArn?: string;
 }
 /**
  */
+/** @category Interface */
 export interface AppConfigProps {
     application: CfnApplicationProps;
     configurationProfile: CfnConfigurationProfileProps;

package/dist/src/services/certificate-manager/main.d.ts

@@ -3,7 +3,7 @@ import { IHostedZone } from 'aws-cdk-lib/aws-route53';
 import { CommonConstruct } from '../../common/index.js';
 import { AcmProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS Certificates.
+ * Provides operations on AWS Certificates.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { AcmProps } from './types.js';
  *   }
  * }
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
+ * @category Service
  */
 export declare class AcmManager {
     /**
@@ -26,16 +27,17 @@ export declare class AcmManager {
      * @param props certificate props
      * @param hostedZone optional hosted zone to perform DNS validation
      * @returns the resolved certificate
-     * @mermaid
-     *   graph LR;
-     *     A((Start)) --> B{Valid Properties?};
-     *     B -- Yes --> C(Fetch By ARN);
-     *     B -- No --> D[Throw Error];
-     *     D --> G((Stop));
-     *     C --> E{Valid ARN?};
-     *     E -- Yes --> F(Return Certificate);
-     *     E -- No --> D;
-     *     F --> G;
+     * ```mermaid
+     * graph LR;
+     *   A((Start)) --> B{Valid Properties?};
+     *   B -- Yes --> C(Fetch By ARN);
+     *   B -- No --> D[Throw Error];
+     *   D --> G((Stop));
+     *   C --> E{Valid ARN?};
+     *   E -- Yes --> F(Return Certificate);
+     *   E -- No --> D;
+     *   F --> G;
+     * ```
      */
     resolveCertificate(id: string, scope: CommonConstruct, props: AcmProps, hostedZone?: IHostedZone): ICertificate;
 }

package/dist/src/services/certificate-manager/main.js

@@ -2,7 +2,7 @@ import { Stack } from 'aws-cdk-lib';
 import { Certificate, CertificateValidation } from 'aws-cdk-lib/aws-certificatemanager';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS Certificates.
+ * Provides operations on AWS Certificates.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -16,6 +16,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_certificatemanager-readme.html}
+ * @category Service
  */
 export class AcmManager {
     /**
@@ -25,20 +26,21 @@ export class AcmManager {
      * @param props certificate props
      * @param hostedZone optional hosted zone to perform DNS validation
      * @returns the resolved certificate
-     * @mermaid
-     *   graph LR;
-     *     A((Start)) --> B{Valid Properties?};
-     *     B -- Yes --> C(Fetch By ARN);
-     *     B -- No --> D[Throw Error];
-     *     D --> G((Stop));
-     *     C --> E{Valid ARN?};
-     *     E -- Yes --> F(Return Certificate);
-     *     E -- No --> D;
-     *     F --> G;
+     * ```mermaid
+     * graph LR;
+     *   A((Start)) --> B{Valid Properties?};
+     *   B -- Yes --> C(Fetch By ARN);
+     *   B -- No --> D[Throw Error];
+     *   D --> G((Stop));
+     *   C --> E{Valid ARN?};
+     *   E -- Yes --> F(Return Certificate);
+     *   E -- No --> D;
+     *   F --> G;
+     * ```
      */
     resolveCertificate(id, scope, props, hostedZone) {
         if (!props)
-            throw `Certificate props undefined for ${id}`;
+            throw new Error(`Certificate props undefined for ${id}`);
         let certificate;
         if (props.useExistingCertificate) {
             let certificateArn = props.certificateArn;

package/dist/src/services/certificate-manager/types.d.ts

@@ -1,6 +1,7 @@
 import { CertificateProps } from 'aws-cdk-lib/aws-certificatemanager';
 /**
  */
+/** @category Interface */
 export interface AcmProps extends CertificateProps {
     certificateAccount?: string;
     certificateArn?: string;

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

@@ -11,7 +11,7 @@ import { CommonConstruct } from '../../common/index.js';
 import { LambdaEdgeProps } from '../lambda/index.js';
 import { CloudfrontFunctionProps, DistributionProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS
+ * Provides operations on AWS
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -32,6 +32,7 @@ import { CloudfrontFunctionProps, DistributionProps } from './types.js';
  *   }
  * }
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
+ * @category Service
  */
 export declare class CloudFrontManager {
     createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: IBucket): cf.OriginAccessIdentity;

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

@@ -8,7 +8,7 @@ import _ from 'lodash';
 import { CommonStack } from '../../common/index.js';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS
+ * Provides operations on AWS
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -29,6 +29,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
+ * @category Service
  */
 export class CloudFrontManager {
     createOriginAccessIdentity(id, scope, accessBucket) {
@@ -146,9 +147,9 @@ export class CloudFrontManager {
      */
     createEdgeFunction(id, scope, props, layers, code, role, environment, vpc, securityGroups, accessPoint, mountPath) {
         if (!props)
-            throw `EdgeFunction props undefined for ${id}`;
+            throw new Error(`EdgeFunction props undefined for ${id}`);
         if (!props.functionName)
-            throw `EdgeFunction functionName undefined for ${id}`;
+            throw new Error(`EdgeFunction functionName undefined for ${id}`);
         const functionName = scope.resourceNameFormatter.format(props.functionName, scope.props.resourceNameOptions?.cloudfront);
         const edgeFunction = new cf.experimental.EdgeFunction(scope, `${id}`, {
             code: code,
@@ -213,9 +214,9 @@ export class CloudFrontManager {
      */
     createCloudfrontFunction(id, scope, props) {
         if (!props)
-            throw `CloudFront Function props undefined for ${id}`;
+            throw new Error(`CloudFront Function props undefined for ${id}`);
         if (!props.functionName)
-            throw `CloudFront Function functionName undefined for ${id}`;
+            throw new Error(`CloudFront Function functionName undefined for ${id}`);
         const cloudfrontFunction = new Function(scope, `${id}`, {
             ...props,
             code: FunctionCode.fromFile({

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

@@ -2,11 +2,13 @@ import { DistributionProps as CfDistributionProps, FunctionProps } from 'aws-cdk
 import { TagProps } from '../../types/index.js';
 /**
  */
+/** @category Interface */
 export interface DistributionProps extends CfDistributionProps {
     tags?: TagProps[];
 }
 /**
  */
+/** @category Interface */
 export interface CloudfrontFunctionProps extends FunctionProps {
     eventType: string;
     functionFilePath: string;

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

@@ -4,7 +4,7 @@ import { CfnBucketPolicy, IBucket } from 'aws-cdk-lib/aws-s3';
 import { CommonConstruct } from '../../common/index.js';
 import { CloudTrailProps } from './types.js';
 /**
- * @classdesc Provides operations on AWS CloudTrail.
+ * Provides operations on AWS CloudTrail.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -25,6 +25,7 @@ import { CloudTrailProps } from './types.js';
  *   }
  * }
  * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
+ * @category Service
  */
 export declare class CloudTrailManager {
     /**

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

@@ -1,7 +1,7 @@
 import { CfnTrail } from 'aws-cdk-lib/aws-cloudtrail';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * @classdesc Provides operations on AWS CloudTrail.
+ * Provides operations on AWS CloudTrail.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -22,6 +22,7 @@ import { createCfnOutput } from '../../utils/index.js';
  *   }
  * }
  * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
+ * @category Service
  */
 export class CloudTrailManager {
     /**
@@ -36,9 +37,9 @@ export class CloudTrailManager {
      */
     createCloudTrail(id, scope, props, logGroup, dataBucket, logBucket, logBucketPolicy) {
         if (!props)
-            throw `CloudTrail props undefined for ${id}`;
+            throw new Error(`CloudTrail props undefined for ${id}`);
         if (!props.trailName)
-            throw `CloudTrail trailName undefined for ${id}`;
+            throw new Error(`CloudTrail trailName undefined for ${id}`);
         const role = scope.iamManager.createRoleForCloudTrail(`${id}Role`, scope, logGroup);
         const cloudTrail = new CfnTrail(scope, `${id}`, {
             ...props,

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

@@ -1,5 +1,6 @@
 import { CfnTrailProps } from 'aws-cdk-lib/aws-cloudtrail';
 /**
  */
+/** @category Interface */
 export interface CloudTrailProps extends CfnTrailProps {
 }

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

@@ -3,7 +3,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import { CommonConstruct } from '../../common/index.js';
 import { LogProps, MetricFilterProps } from './types.js';
 /**
- * @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
@@ -17,6 +17,7 @@ import { LogProps, MetricFilterProps } from './types.js';
  *   }
  * }
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
+ * @category Service
  */
 export declare class LogManager {
     /**

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

@@ -3,7 +3,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import _ from 'lodash';
 import * as utils from '../../utils/index.js';
 /**
- * @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
@@ -17,6 +17,7 @@ import * as utils from '../../utils/index.js';
  *   }
  * }
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
+ * @category Service
  */
 export class LogManager {
     /**
@@ -28,7 +29,7 @@ export class LogManager {
      */
     createMetricFilter(id, scope, props, logGroup) {
         if (!props)
-            throw `MetricFilter props undefined for ${id}`;
+            throw new Error(`MetricFilter props undefined for ${id}`);
         const metricFilter = new logs.MetricFilter(scope, `${id}`, {
             defaultValue: props.defaultValue,
             filterPattern: props.filterPattern,
@@ -54,9 +55,9 @@ export class LogManager {
      */
     createCfnLogGroup(id, scope, props) {
         if (!props)
-            throw `Logs props undefined for ${id}`;
+            throw new Error(`Logs props undefined for ${id}`);
         if (!props.logGroupName)
-            throw `Logs logGroupName undefined for ${id}`;
+            throw new Error(`Logs logGroupName undefined for ${id}`);
         const logGroup = new logs.CfnLogGroup(scope, `${id}`, {
             ...props,
             logGroupName: props.logGroupName,
@@ -78,9 +79,9 @@ export class LogManager {
      */
     createLogGroup(id, scope, props) {
         if (!props)
-            throw `Logs props undefined for ${id}`;
+            throw new Error(`Logs props undefined for ${id}`);
         if (!props.logGroupName)
-            throw `Logs logGroupName undefined for ${id}`;
+            throw new Error(`Logs logGroupName undefined for ${id}`);
         const logGroup = new logs.LogGroup(scope, `${id}`, {
             ...props,
             logGroupName: props.logGroupName,

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

@@ -4,7 +4,7 @@ import { IMetric } from 'aws-cdk-lib/aws-cloudwatch';
 import { CommonConstruct } from '../../common/index.js';
 import { AlarmProps, AlarmStatusWidgetProps, DashboardProps, GraphWidgetProps, GuageWidgetProps, LogQueryWidgetProps, NumericWidgetProps, TextWidgetProps } from './types.js';
 /**
- * @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
@@ -18,6 +18,7 @@ import { AlarmProps, AlarmStatusWidgetProps, DashboardProps, GraphWidgetProps, G
  *   }
  * }
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
+ * @category Service
  */
 export declare class CloudWatchManager {
     /**