@gradientedge/cdk-utils-aws 2.0.0 → 2.1.0

package/dist/src/construct/piped-event-handler/main.d.ts

@@ -3,7 +3,7 @@ import { Construct } from 'constructs';
 import { EventHandler } from '../event-handler/index.js';
 import { PipedEventHandlerProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy an EventBridge Piped Event Handler
+ * Provides a construct to create and deploy an EventBridge Piped Event Handler
  * @example
  * import { PipedEventHandler, PipedEventHandlerProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -16,6 +16,7 @@ import { PipedEventHandlerProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class PipedEventHandler extends EventHandler {
     props: PipedEventHandlerProps;

package/dist/src/construct/piped-event-handler/main.js

@@ -2,7 +2,7 @@ import { SqsQueue } from 'aws-cdk-lib/aws-events-targets';
 import _ from 'lodash';
 import { EventHandler } from '../event-handler/index.js';
 /**
- * @classdesc Provides a construct to create and deploy an EventBridge Piped Event Handler
+ * Provides a construct to create and deploy an EventBridge Piped Event Handler
  * @example
  * import { PipedEventHandler, PipedEventHandlerProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -15,6 +15,7 @@ import { EventHandler } from '../event-handler/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class PipedEventHandler extends EventHandler {
     props;

package/dist/src/construct/piped-event-handler/types.d.ts

@@ -1,6 +1,7 @@
 import { QueueProps } from 'aws-cdk-lib/aws-sqs';
 import { SqsToLambdaPipeProps, SqsToSfnPipeProps } from '../../services/index.js';
 import { EventHandlerProps } from '../event-handler/index.js';
+/** @category Interface */
 export interface PipedEventHandlerProps extends EventHandlerProps {
     pipedDlq: QueueProps;
     pipedQueue: QueueProps;

package/dist/src/construct/rest-api-lambda/main.d.ts

@@ -8,9 +8,9 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { RestApiLambdaEnvironment, RestApiLambdaProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a RestApi as Lambda
+ * Provides a construct to create and deploy a RestApi as Lambda
  *
- * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/RestApiLambda.jpg)
  * @example
  * import { RestApiLambda, RestApiLambdaProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -23,6 +23,7 @@ import { RestApiLambdaEnvironment, RestApiLambdaProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare abstract class RestApiLambda extends CommonConstruct {
     props: RestApiLambdaProps;

package/dist/src/construct/rest-api-lambda/main.js

@@ -3,9 +3,9 @@ import { PolicyDocument } from 'aws-cdk-lib/aws-iam';
 import _ from 'lodash';
 import { CommonConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides a construct to create and deploy a RestApi as Lambda
+ * Provides a construct to create and deploy a RestApi as Lambda
  *
- * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/RestApiLambda.jpg)
  * @example
  * import { RestApiLambda, RestApiLambdaProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -18,6 +18,7 @@ import { CommonConstruct } from '../../common/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class RestApiLambda extends CommonConstruct {
     /* restApiLambda props */

package/dist/src/construct/rest-api-lambda/types.d.ts

@@ -3,10 +3,12 @@ import { AcmProps, LambdaEnvironment, LambdaProps, LambdaRestApiProps } from '..
 import { CommonStackProps } from '../../common/index.js';
 /**
  */
+/** @category Interface */
 export interface RestApiLambdaEnvironment extends LambdaEnvironment {
 }
 /**
  */
+/** @category Interface */
 export interface RestApiLambdaProps extends CommonStackProps {
     apiRootPaths?: string[];
     apiSubDomain: string;

package/dist/src/construct/rest-api-lambda-with-cache/main.d.ts

@@ -4,9 +4,9 @@ import { Construct } from 'constructs';
 import { RestApiLambda } from '../rest-api-lambda/index.js';
 import { RestApiLambdaWithCacheProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a RestApi API as Lambda with Caching
+ * Provides a construct to create and deploy a RestApi API as Lambda with Caching
  *
- * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/RestApiLambda.jpg)
  * @example
  * import { RestApiLambdaWithCacheProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -19,6 +19,7 @@ import { RestApiLambdaWithCacheProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare abstract class RestApiLambdaWithCache extends RestApiLambda {
     props: RestApiLambdaWithCacheProps;

package/dist/src/construct/rest-api-lambda-with-cache/main.js

@@ -5,9 +5,9 @@ import _ from 'lodash';
 import { createCfnOutput } from '../../utils/index.js';
 import { RestApiLambda } from '../rest-api-lambda/index.js';
 /**
- * @classdesc Provides a construct to create and deploy a RestApi API as Lambda with Caching
+ * Provides a construct to create and deploy a RestApi API as Lambda with Caching
  *
- * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/RestApiLambda.jpg)
  * @example
  * import { RestApiLambdaWithCacheProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -20,6 +20,7 @@ import { RestApiLambda } from '../rest-api-lambda/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class RestApiLambdaWithCache extends RestApiLambda {
     /* restApiLambdaWithCache props */

package/dist/src/construct/rest-api-lambda-with-cache/types.d.ts

@@ -2,6 +2,7 @@ import { RestApiLambdaProps } from '../rest-api-lambda/index.js';
 import { ReplicatedElastiCacheProps, VpcProps } from '../../services/index.js';
 /**
  */
+/** @category Interface */
 export interface RestApiLambdaWithCacheProps extends RestApiLambdaProps {
     restApiCache: ReplicatedElastiCacheProps;
     restApiVpc: VpcProps;

package/dist/src/construct/site-with-ecs-backend/constants.d.ts

@@ -1,3 +1,4 @@
+/** @category Enum */
 export declare enum SiteResponseHeaderPolicyType {
     ORIGIN = "origin",
     STATIC = "static"

package/dist/src/construct/site-with-ecs-backend/constants.js

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

package/dist/src/construct/site-with-ecs-backend/main.d.ts

@@ -13,7 +13,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { SiteCachePolicyProps, SiteResponseHeadersPolicyProps, SiteWithEcsBackendProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
+ * Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
  * @example
  * import { SiteWithEcsBackend, SiteWithEcsBackendProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -26,6 +26,7 @@ import { SiteCachePolicyProps, SiteResponseHeadersPolicyProps, SiteWithEcsBacken
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class SiteWithEcsBackend extends CommonConstruct {
     props: SiteWithEcsBackendProps;

package/dist/src/construct/site-with-ecs-backend/main.js

@@ -7,7 +7,7 @@ import { PolicyDocument, PolicyStatement } from 'aws-cdk-lib/aws-iam';
 import _ from 'lodash';
 import { CommonConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
+ * Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
  * @example
  * import { SiteWithEcsBackend, SiteWithEcsBackendProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -20,6 +20,7 @@ import { CommonConstruct } from '../../common/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class SiteWithEcsBackend extends CommonConstruct {
     /* site properties */

package/dist/src/construct/site-with-ecs-backend/types.d.ts

@@ -5,6 +5,7 @@ import { AcmProps, CloudfrontFunctionProps, DistributionProps, EcsApplicationLoa
 import { SiteResponseHeaderPolicyType } from './constants.js';
 /**
  */
+/** @category Interface */
 export interface SiteWithEcsBackendProps extends CommonStackProps {
     logLevel: string;
     nodeEnv: string;
@@ -32,16 +33,20 @@ export interface SiteWithEcsBackendProps extends CommonStackProps {
     useExistingHostedZone: boolean;
     useExistingVpc: boolean;
 }
+/** @category Interface */
 export interface SiteResponseHeadersStrictTransportSecurity extends ResponseHeadersStrictTransportSecurity {
     accessControlMaxAgeInSeconds: number;
 }
+/** @category Interface */
 export interface SiteSecurityHeadersBehavior extends ResponseSecurityHeadersBehavior {
     strictTransportSecurity: SiteResponseHeadersStrictTransportSecurity;
 }
+/** @category Interface */
 export interface SiteResponseHeadersPolicyProps extends ResponseHeadersPolicyProps {
     securityHeadersBehavior: SiteSecurityHeadersBehavior;
     type: SiteResponseHeaderPolicyType;
 }
+/** @category Interface */
 export interface SiteCachePolicyProps extends CachePolicyProps {
     defaultTtlInSeconds: number;
     minTtlInSeconds: number;

package/dist/src/construct/site-with-lambda-backend/constants.d.ts

@@ -1,5 +1,7 @@
+/** @category Enum */
 export declare enum SiteWithLambdaBackendResponseHeaderPolicyType {
     ORIGIN = "origin",
     STATIC = "static"
 }
+/** @category Constant */
 export declare const LAMBDA_ALIAS_NAME_CURRENT = "latest";

package/dist/src/construct/site-with-lambda-backend/constants.js

@@ -1,6 +1,8 @@
+/** @category Enum */
 export var SiteWithLambdaBackendResponseHeaderPolicyType;
 (function (SiteWithLambdaBackendResponseHeaderPolicyType) {
     SiteWithLambdaBackendResponseHeaderPolicyType["ORIGIN"] = "origin";
     SiteWithLambdaBackendResponseHeaderPolicyType["STATIC"] = "static";
 })(SiteWithLambdaBackendResponseHeaderPolicyType || (SiteWithLambdaBackendResponseHeaderPolicyType = {}));
+/** @category Constant */
 export const LAMBDA_ALIAS_NAME_CURRENT = 'latest';

package/dist/src/construct/site-with-lambda-backend/main.d.ts

@@ -10,7 +10,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { SiteWithLambdaBackendCachePolicyProps, SiteWithLambdaBackendProps, SiteWithLambdaBackendResponseHeadersPolicyProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
+ * Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
  * @example
  * import { SiteWithLambdaBackend, SiteWithLambdaBackendProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -23,6 +23,7 @@ import { SiteWithLambdaBackendCachePolicyProps, SiteWithLambdaBackendProps, Site
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class SiteWithLambdaBackend extends CommonConstruct {
     props: SiteWithLambdaBackendProps;

package/dist/src/construct/site-with-lambda-backend/main.js

@@ -7,7 +7,7 @@ import _ from 'lodash';
 import { CommonConstruct } from '../../common/index.js';
 import { LAMBDA_ALIAS_NAME_CURRENT } from './constants.js';
 /**
- * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
+ * Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
  * @example
  * import { SiteWithLambdaBackend, SiteWithLambdaBackendProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -20,6 +20,7 @@ import { LAMBDA_ALIAS_NAME_CURRENT } from './constants.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class SiteWithLambdaBackend extends CommonConstruct {
     /* site properties */

package/dist/src/construct/site-with-lambda-backend/types.d.ts

@@ -4,6 +4,7 @@ import { AcmProps, CloudfrontFunctionProps, DistributionProps, LambdaProps, LogP
 import { SiteWithLambdaBackendResponseHeaderPolicyType } from './constants.js';
 /**
  */
+/** @category Interface */
 export interface SiteWithLambdaBackendProps extends CommonStackProps {
     logLevel: string;
     nodeEnv: string;
@@ -28,16 +29,20 @@ export interface SiteWithLambdaBackendProps extends CommonStackProps {
     useExistingHostedZone: boolean;
     useExistingVpc: boolean;
 }
+/** @category Interface */
 export interface SiteWithLambdaBackendResponseHeadersStrictTransportSecurity extends ResponseHeadersStrictTransportSecurity {
     accessControlMaxAgeInSeconds: number;
 }
+/** @category Interface */
 export interface SiteWithLambdaBackendSecurityHeadersBehavior extends ResponseSecurityHeadersBehavior {
     strictTransportSecurity: SiteWithLambdaBackendResponseHeadersStrictTransportSecurity;
 }
+/** @category Interface */
 export interface SiteWithLambdaBackendResponseHeadersPolicyProps extends ResponseHeadersPolicyProps {
     securityHeadersBehavior: SiteWithLambdaBackendSecurityHeadersBehavior;
     type: SiteWithLambdaBackendResponseHeaderPolicyType;
 }
+/** @category Interface */
 export interface SiteWithLambdaBackendCachePolicyProps extends CachePolicyProps {
     defaultTtlInSeconds: number;
     minTtlInSeconds: number;

package/dist/src/construct/static-asset-deployment/main.d.ts

@@ -4,7 +4,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { StaticAssetDeploymentProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy static assets into S3 bucket
+ * Provides a construct to create and deploy static assets into S3 bucket
  * @example
  * import { StaticAssetDeployment, StaticAssetDeploymentProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -15,6 +15,7 @@ import { StaticAssetDeploymentProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class StaticAssetDeployment extends CommonConstruct {
     staticAssetBucket: IBucket;

package/dist/src/construct/static-asset-deployment/main.js

@@ -5,7 +5,7 @@ import _ from 'lodash';
 import appRoot from 'app-root-path';
 import { CommonConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides a construct to create and deploy static assets into S3 bucket
+ * Provides a construct to create and deploy static assets into S3 bucket
  * @example
  * import { StaticAssetDeployment, StaticAssetDeploymentProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -16,6 +16,7 @@ import { CommonConstruct } from '../../common/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class StaticAssetDeployment extends CommonConstruct {
     /* construct resources */

package/dist/src/construct/static-asset-deployment/types.d.ts

@@ -1,5 +1,6 @@
 import { BucketDeploymentProps, S3BucketProps } from '../../services/index.js';
 import { CommonStackProps } from '../../common/index.js';
+/** @category Interface */
 export interface AssetExport {
     key: string;
     value: string;
@@ -9,6 +10,7 @@ export interface AssetExport {
  * When value is configured, the construct will invalidate the distribution after the deployment.
  * Use either domainName or distributionId or domainNameRef or distributionIdRef.
  */
+/** @category Interface */
 export interface StaticCloudFrontDistribution {
     /**
      * @summary The domain name to associate with the bucket.
@@ -31,6 +33,7 @@ export interface StaticCloudFrontDistribution {
      */
     invalidationPaths: string[];
 }
+/** @category Interface */
 export interface StaticAssetDeploymentProps extends CommonStackProps {
     staticAssetBucket: S3BucketProps;
     staticAssetDeployment: BucketDeploymentProps;

package/dist/src/construct/static-site/main.d.ts

@@ -6,7 +6,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { StaticSiteProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a s3 hosted static site
+ * Provides a construct to create and deploy a s3 hosted static site
  * @example
  * import { StaticSite, StaticSiteProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -19,6 +19,7 @@ import { StaticSiteProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class StaticSite extends CommonConstruct {
     props: StaticSiteProps;

package/dist/src/construct/static-site/main.js

@@ -1,7 +1,7 @@
 import { FunctionEventType, } from 'aws-cdk-lib/aws-cloudfront';
 import { CommonConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides a construct to create and deploy a s3 hosted static site
+ * Provides a construct to create and deploy a s3 hosted static site
  * @example
  * import { StaticSite, StaticSiteProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -14,6 +14,7 @@ import { CommonConstruct } from '../../common/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class StaticSite extends CommonConstruct {
     /* static site properties */

package/dist/src/construct/static-site/types.d.ts

@@ -3,6 +3,7 @@ import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, CloudfrontFunctionProps, DistributionProps, S3BucketProps } from '../../services/index.js';
 /**
  */
+/** @category Interface */
 export interface StaticSiteProps extends CommonStackProps {
     logLevel: string;
     nodeEnv: string;

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

@@ -4,7 +4,7 @@ import { IFunction } from 'aws-cdk-lib/aws-lambda';
 import { CommonConstruct } from '../../common/index.js';
 import { LambdaRestApiProps } from './types.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
@@ -19,6 +19,7 @@ import { LambdaRestApiProps } from './types.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 declare class ApiManager {
     /**

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 {
     /**

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 {
     /**

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,16 +26,17 @@ 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)

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;