@gradientedge/cdk-utils-aws 2.0.0 → 2.2.0

package/README.md

@@ -0,0 +1,31 @@
+# @gradientedge/cdk-utils-aws
+
+AWS CDK utilities for provisioning and managing AWS infrastructure using the [AWS CDK](https://docs.aws.amazon.com/cdk/latest/guide/home.html).
+
+## Overview
+
+This package provides high-level constructs and service managers that simplify common AWS CDK patterns:
+
+- **Constructs** — ready-to-use patterns like REST API with Lambda, EventBridge targets, static sites, and ECS backends
+- **Services** — manager classes for AWS services including Lambda, API Gateway, CloudFront, DynamoDB, ECS, S3, SQS, SNS, and more
+- **Common** — base constructs and stack classes that all higher-level constructs extend
+
+## Installation
+
+```bash
+pnpm add @gradientedge/cdk-utils-aws
+```
+
+## Usage
+
+```typescript
+import { CommonConstruct } from '@gradientedge/cdk-utils-aws'
+import { Construct } from 'constructs'
+
+class MyStack extends CommonConstruct {
+  constructor(parent: Construct, id: string, props: CommonStackProps) {
+    super(parent, id, props)
+    this.initResources()
+  }
+}
+```

package/dist/src/common/construct.d.ts

@@ -4,8 +4,7 @@ import { AcmManager, ApiManager, AppConfigManager, CloudFrontManager, CloudTrail
 import { ResourceNameFormatter } from './resource-name-formatter.js';
 import { CommonStackProps } from './types.js';
 /**
- * @subcategory Construct
- * @classdesc Common construct to use as a base for all higher level constructs.
+ * Common construct to use as a base for all higher level constructs.
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils';
  *
@@ -15,6 +14,7 @@ import { CommonStackProps } from './types.js';
  *     this.props = props;
  *   };
  * };
+ * @category Common
  */
 export declare class CommonConstruct extends Construct {
     props: CommonStackProps;

package/dist/src/common/construct.js

@@ -4,8 +4,7 @@ import { AcmManager, ApiManager, AppConfigManager, CloudFrontManager, CloudTrail
 import { createCfnOutput } from '../utils/index.js';
 import { ResourceNameFormatter } from './resource-name-formatter.js';
 /**
- * @subcategory Construct
- * @classdesc Common construct to use as a base for all higher level constructs.
+ * Common construct to use as a base for all higher level constructs.
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils';
  *
@@ -15,6 +14,7 @@ import { ResourceNameFormatter } from './resource-name-formatter.js';
  *     this.props = props;
  *   };
  * };
+ * @category Common
  */
 export class CommonConstruct extends Construct {
     props;

package/dist/src/common/resource-name-formatter.d.ts

@@ -1,5 +1,6 @@
 import { Construct } from 'constructs';
 import { CommonStackProps, ResourceNameFormatterProps } from './types.js';
+/** @category Common */
 export declare class ResourceNameFormatter extends Construct {
     props: CommonStackProps;
     constructor(parent: Construct, id: string, props: CommonStackProps);

package/dist/src/common/resource-name-formatter.js

@@ -1,4 +1,5 @@
 import { Construct } from 'constructs';
+/** @category Common */
 export class ResourceNameFormatter extends Construct {
     props;
     constructor(parent, id, props) {

package/dist/src/common/stack.d.ts

@@ -3,7 +3,7 @@ import { App, Stack, StackProps } from 'aws-cdk-lib';
 import { CommonStackProps } from './types.js';
 import { CommonConstruct } from './construct.js';
 /**
- * @classdesc Common stack to use as a base for all higher level constructs.
+ * Common stack to use as a base for all higher level constructs.
  * @example
  * import { CommonStack } from '@gradientedge/cdk-utils'
  *
@@ -13,6 +13,7 @@ import { CommonConstruct } from './construct.js';
  *     // provision resources
  *   }
  * }
+ * @category Common
  */
 export declare class CommonStack extends Stack {
     static NODEJS_RUNTIME: Runtime;

package/dist/src/common/stack.js

@@ -7,7 +7,7 @@ import _ from 'lodash';
 import { isDevStage } from '@gradientedge/cdk-utils-common';
 import { CommonConstruct } from './construct.js';
 /**
- * @classdesc Common stack to use as a base for all higher level constructs.
+ * Common stack to use as a base for all higher level constructs.
  * @example
  * import { CommonStack } from '@gradientedge/cdk-utils'
  *
@@ -17,6 +17,7 @@ import { CommonConstruct } from './construct.js';
  *     // provision resources
  *   }
  * }
+ * @category Common
  */
 export class CommonStack extends Stack {
     static NODEJS_RUNTIME = Runtime.NODEJS_24_X;

package/dist/src/common/types.d.ts

@@ -4,6 +4,7 @@ import { RetentionDays } from 'aws-cdk-lib/aws-logs';
 import { BaseProps } from '@gradientedge/cdk-utils-common';
 /**
  */
+/** @category Interface */
 export interface CommonStackProps extends BaseProps, StackProps {
     region: string;
     resourceProjectIdentifier?: string;
@@ -21,6 +22,7 @@ export interface CommonStackProps extends BaseProps, StackProps {
         [key: string]: ResourceNameFormatterProps;
     };
 }
+/** @category Interface */
 export interface ResourceNameFormatterProps {
     exclude?: boolean;
     globalPrefix?: boolean;

package/dist/src/construct/api-to-any-target/main.d.ts

@@ -4,7 +4,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { ApiToAnyTargetProps, ApiToAnyTargetRestApiResource, ApiToAnyTargetRestApiType } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a shallow API Gateway
+ * Provides a construct to create and deploy a shallow API Gateway
  * @example
  * import { ApiToAnyTarget, ApiToAnyTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -17,6 +17,7 @@ import { ApiToAnyTargetProps, ApiToAnyTargetRestApiResource, ApiToAnyTargetRestA
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class ApiToAnyTarget extends CommonConstruct {
     props: ApiToAnyTargetProps;

package/dist/src/construct/api-to-any-target/main.js

@@ -3,7 +3,7 @@ import { AccessLogFormat, BasePathMapping, Cors, EndpointType, LogGroupLogDestin
 import { CommonConstruct } from '../../common/index.js';
 import { ApiToAnyTargetRestApi } from './target.js';
 /**
- * @classdesc Provides a construct to create and deploy a shallow API Gateway
+ * Provides a construct to create and deploy a shallow API Gateway
  * @example
  * import { ApiToAnyTarget, ApiToAnyTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -16,6 +16,7 @@ import { ApiToAnyTargetRestApi } from './target.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class ApiToAnyTarget extends CommonConstruct {
     props;

package/dist/src/construct/api-to-any-target/target.d.ts

@@ -3,6 +3,7 @@ import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager';
 import { LogGroup } from 'aws-cdk-lib/aws-logs';
 import { IHostedZone } from 'aws-cdk-lib/aws-route53';
 import { ApiToAnyTargetRestApiType } from './types.js';
+/** @category Construct */
 export declare class ApiToAnyTargetRestApi implements ApiToAnyTargetRestApiType {
     accessLogGroup: LogGroup;
     api: IRestApi;

package/dist/src/construct/api-to-any-target/target.js

@@ -1,3 +1,4 @@
+/** @category Construct */
 export class ApiToAnyTargetRestApi {
     accessLogGroup;
     api;

package/dist/src/construct/api-to-any-target/types.d.ts

@@ -4,6 +4,7 @@ import { LogGroup } from 'aws-cdk-lib/aws-logs';
 import { IHostedZone } from 'aws-cdk-lib/aws-route53';
 import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, RestApigProps } from '../../services/index.js';
+/** @category Interface */
 export interface ApiToAnyTargetRestApiType {
     accessLogGroup: LogGroup;
     api: IRestApi;
@@ -22,6 +23,7 @@ export interface ApiToAnyTargetRestApiType {
         [path: string]: Resource;
     };
 }
+/** @category Interface */
 export interface ApiToAnyTargetRestApiResource {
     addProxy: boolean;
     authorizer?: IAuthorizer;
@@ -39,6 +41,7 @@ export interface ApiToAnyTargetRestApiResource {
     mockIntegration?: MockIntegration;
     mockMethodResponses?: MethodResponse[];
 }
+/** @category Interface */
 export interface ApiToAnyTargetRestApiProps {
     certificate: AcmProps;
     importedRestApiRef?: string;
@@ -49,6 +52,7 @@ export interface ApiToAnyTargetRestApiProps {
     useExisting: boolean;
     withResource?: boolean;
 }
+/** @category Interface */
 export interface ApiToAnyTargetProps extends CommonStackProps {
     api: ApiToAnyTargetRestApiProps;
     apiRootPaths?: string[];

package/dist/src/construct/api-to-eventbridge-target/api.d.ts

@@ -6,7 +6,8 @@ import { IHostedZone } from 'aws-cdk-lib/aws-route53';
 import { Topic } from 'aws-cdk-lib/aws-sns';
 import { ApiToEventBridgeTargetRestApiType } from './types.js';
 /**
- * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
+ * Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
+ * @category Construct
  */
 export declare class ApiToEventbridgeTargetRestApi implements ApiToEventBridgeTargetRestApiType {
     accessLogGroup: LogGroup;

package/dist/src/construct/api-to-eventbridge-target/api.js

@@ -1,5 +1,6 @@
 /**
- * @classdesc Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
+ * Provides a construct to contain api resources for ApiToEventBridgeTargetWithSns
+ * @category Construct
  */
 export class ApiToEventbridgeTargetRestApi {
     accessLogGroup;

package/dist/src/construct/api-to-eventbridge-target/event.d.ts

@@ -2,7 +2,8 @@ import { IEventBus, Rule } from 'aws-cdk-lib/aws-events';
 import { LogGroup } from 'aws-cdk-lib/aws-logs';
 import { ApiToEventBridgeTargetEventType } from './types.js';
 /**
- * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
+ * Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
+ * @category Construct
  */
 export declare class ApiToEventbridgeTargetEvent implements ApiToEventBridgeTargetEventType {
     eventBus: IEventBus;

package/dist/src/construct/api-to-eventbridge-target/event.js

@@ -1,5 +1,6 @@
 /**
- * @classdesc Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
+ * Provides a construct to contain event resources for ApiToEventBridgeTargetWithSns
+ * @category Construct
  */
 export class ApiToEventbridgeTargetEvent {
     eventBus;

package/dist/src/construct/api-to-eventbridge-target/main.d.ts

@@ -3,9 +3,9 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEventBridgeTargetRestApiType } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
+ * Provides a construct to create and deploy API Gateway invocations to EventBridge
  *
- * <b>Architecture</b><br/> ![Architecture](./ApiToEventBridgeTarget.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/ApiToEventBridgeTarget.jpg)
  * @example
  * import { ApiToEventBridgeTarget, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -18,6 +18,7 @@ import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEven
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class ApiToEventBridgeTarget extends CommonConstruct {
     props: ApiToEventBridgeTargetProps;

package/dist/src/construct/api-to-eventbridge-target/main.js

@@ -7,9 +7,9 @@ import { CommonConstruct } from '../../common/index.js';
 import { ApiToEventbridgeTargetRestApi } from './api.js';
 import { ApiToEventbridgeTargetEvent } from './event.js';
 /**
- * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
+ * Provides a construct to create and deploy API Gateway invocations to EventBridge
  *
- * <b>Architecture</b><br/> ![Architecture](./ApiToEventBridgeTarget.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/ApiToEventBridgeTarget.jpg)
  * @example
  * import { ApiToEventBridgeTarget, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -22,6 +22,7 @@ import { ApiToEventbridgeTargetEvent } from './event.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class ApiToEventBridgeTarget extends CommonConstruct {
     props;

package/dist/src/construct/api-to-eventbridge-target/types.d.ts

@@ -10,6 +10,7 @@ import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, EventRuleProps, LambdaProps, LogProps, RestApigProps } from '../../services/index.js';
 /**
  */
+/** @category Interface */
 export interface ApiToEventBridgeTargetEventType {
     eventBus: IEventBus;
     logGroup: LogGroup;
@@ -21,6 +22,7 @@ export interface ApiToEventBridgeTargetEventType {
 }
 /**
  */
+/** @category Interface */
 export interface ApiToEventBridgeTargetRestApiType {
     accessLogGroup: LogGroup;
     api: IRestApi;
@@ -49,6 +51,7 @@ export interface ApiToEventBridgeTargetRestApiType {
 }
 /**
  */
+/** @category Interface */
 export interface ApiToEventBridgeTargetRestApiProps {
     certificate: AcmProps;
     errorResponseModel?: ModelOptions;
@@ -67,7 +70,8 @@ export interface ApiToEventBridgeTargetRestApiProps {
 }
 /**
  */
-interface ApiToEventBridgeTargetLambdaProps {
+/** @category Interface */
+export interface ApiToEventBridgeTargetLambdaProps {
     function: LambdaProps;
     handler?: string;
     layerSource?: AssetCode;
@@ -75,7 +79,8 @@ interface ApiToEventBridgeTargetLambdaProps {
 }
 /**
  */
-interface ApiToEventBridgeTargetEventProps {
+/** @category Interface */
+export interface ApiToEventBridgeTargetEventProps {
     eventBusName?: string;
     logGroup?: LogProps;
     logGroupFailure?: LogProps;
@@ -86,6 +91,7 @@ interface ApiToEventBridgeTargetEventProps {
 }
 /**
  */
+/** @category Interface */
 export interface ApiToEventBridgeTargetProps extends CommonStackProps {
     api: ApiToEventBridgeTargetRestApiProps;
     apiRootPaths?: string[];
@@ -97,4 +103,3 @@ export interface ApiToEventBridgeTargetProps extends CommonStackProps {
     timezone: string;
     useExistingHostedZone: boolean;
 }
-export {};

package/dist/src/construct/api-to-eventbridge-target-with-sns/api-destined-lambda.d.ts

@@ -3,7 +3,8 @@ import { IFunction, LayerVersion } from 'aws-cdk-lib/aws-lambda';
 import { EventBridgeDestination } from 'aws-cdk-lib/aws-lambda-destinations';
 import { ApiDestinedLambdaEnvironment, ApiDestinedLambdaType } from './types.js';
 /**
- * @classdesc Provides a construct to contain lambda resources for ApiToEventBridgeTargetWithSns
+ * Provides a construct to contain lambda resources for ApiToEventBridgeTargetWithSns
+ * @category Construct
  */
 export declare class ApiDestinedLambda implements ApiDestinedLambdaType {
     destinationFailure: EventBridgeDestination;

package/dist/src/construct/api-to-eventbridge-target-with-sns/api-destined-lambda.js

@@ -1,5 +1,6 @@
 /**
- * @classdesc Provides a construct to contain lambda resources for ApiToEventBridgeTargetWithSns
+ * Provides a construct to contain lambda resources for ApiToEventBridgeTargetWithSns
+ * @category Construct
  */
 export class ApiDestinedLambda {
     destinationFailure;

package/dist/src/construct/api-to-eventbridge-target-with-sns/main.d.ts

@@ -5,9 +5,9 @@ import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEven
 import { ApiDestinedLambdaType } from './types.js';
 /**
  * @deprecated Use ApiToEventBridgeTarget instead. This will be removed in a future release.
- * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
+ * Provides a construct to create and deploy API Gateway invocations to EventBridge
  *
- * <b>Architecture</b><br/> ![Architecture](./ApiToEventBridgeTargetWithSns.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/ApiToEventBridgeTargetWithSns.jpg)
  * @example
  * import { ApiToEventBridgeTargetWithSns, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -20,6 +20,7 @@ import { ApiDestinedLambdaType } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class ApiToEventBridgeTargetWithSns extends CommonConstruct {
     props: ApiToEventBridgeTargetProps;

package/dist/src/construct/api-to-eventbridge-target-with-sns/main.js

@@ -9,9 +9,9 @@ import { ApiToEventbridgeTargetEvent, ApiToEventbridgeTargetRestApi, } from '../
 import { ApiDestinedLambda } from './api-destined-lambda.js';
 /**
  * @deprecated Use ApiToEventBridgeTarget instead. This will be removed in a future release.
- * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
+ * Provides a construct to create and deploy API Gateway invocations to EventBridge
  *
- * <b>Architecture</b><br/> ![Architecture](./ApiToEventBridgeTargetWithSns.jpg)
+ * <b>Architecture</b><br/> ![Architecture](https://raw.githubusercontent.com/gradientedge/cdk-utils/main/img/ApiToEventBridgeTargetWithSns.jpg)
  * @example
  * import { ApiToEventBridgeTargetWithSns, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -24,6 +24,7 @@ import { ApiDestinedLambda } from './api-destined-lambda.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class ApiToEventBridgeTargetWithSns extends CommonConstruct {
     props;

package/dist/src/construct/api-to-eventbridge-target-with-sns/types.d.ts

@@ -4,11 +4,13 @@ import { PolicyDocument, Role } from 'aws-cdk-lib/aws-iam';
 import { LambdaEnvironment } from '../../services/index.js';
 /**
  */
+/** @category Interface */
 export interface ApiDestinedLambdaEnvironment extends LambdaEnvironment {
     SOURCE_ID: string;
 }
 /**
  */
+/** @category Interface */
 export interface ApiDestinedLambdaType {
     destinationFailure: EventBridgeDestination;
     destinationSuccess: EventBridgeDestination;

package/dist/src/construct/api-to-lambda-target/api.d.ts

@@ -6,7 +6,8 @@ import { IHostedZone } from 'aws-cdk-lib/aws-route53';
 import { Topic } from 'aws-cdk-lib/aws-sns';
 import { ApiToLambdaTargetRestApiType } from './types.js';
 /**
- * @classdesc Provides a construct to contain api resources for ApiToLambdaTarget
+ * Provides a construct to contain api resources for ApiToLambdaTarget
+ * @category Construct
  */
 export declare class ApiToLambdaTargetRestApi implements ApiToLambdaTargetRestApiType {
     api: RestApi;

package/dist/src/construct/api-to-lambda-target/api.js

@@ -1,5 +1,6 @@
 /**
- * @classdesc Provides a construct to contain api resources for ApiToLambdaTarget
+ * Provides a construct to contain api resources for ApiToLambdaTarget
+ * @category Construct
  */
 export class ApiToLambdaTargetRestApi {
     api;

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

@@ -3,6 +3,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { ApiToLambdaTargetProps, ApiToLambdaTargetRestApiType } from './types.js';
 /**
+ * @category Construct
  */
 export declare class ApiToLambdaTarget extends CommonConstruct {
     props: ApiToLambdaTargetProps;

package/dist/src/construct/api-to-lambda-target/main.js

@@ -5,6 +5,7 @@ import { Function } from 'aws-cdk-lib/aws-lambda';
 import { CommonConstruct } from '../../common/index.js';
 import { ApiToLambdaTargetRestApi } from './api.js';
 /**
+ * @category Construct
  */
 export class ApiToLambdaTarget extends CommonConstruct {
     props;

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

@@ -8,6 +8,7 @@ import { AcmProps, LambdaRestApiProps } from '../../services/index.js';
 import { CommonStackProps } from '../../common/index.js';
 /**
  */
+/** @category Interface */
 export interface ApiToLambdaTargetRestApiType {
     api: IRestApi;
     authoriser?: IAuthorizer;
@@ -37,6 +38,7 @@ export interface ApiToLambdaTargetRestApiType {
 }
 /**
  */
+/** @category Interface */
 export interface ApiToLambdaTargetRestApiProps {
     certificate: AcmProps;
     importedRestApiRef?: string;
@@ -50,6 +52,7 @@ export interface ApiToLambdaTargetRestApiProps {
 }
 /**
  */
+/** @category Interface */
 export interface ApiToLambdaTargetProps extends CommonStackProps {
     api: ApiToLambdaTargetRestApiProps;
     apiRootPaths?: string[];

package/dist/src/construct/application-configuration/main.d.ts

@@ -2,6 +2,7 @@ import { CfnApplication, CfnConfigurationProfile, CfnEnvironment, CfnHostedConfi
 import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { ApplicationConfigurationProps } from './types.js';
+/** @category Construct */
 export declare class ApplicationConfiguration extends CommonConstruct {
     props: ApplicationConfigurationProps;
     id: string;

package/dist/src/construct/application-configuration/main.js

@@ -1,6 +1,7 @@
 import { Duration, Fn } from 'aws-cdk-lib';
 import { CfnDeployment, CfnHostedConfigurationVersion, DeploymentStrategy, RolloutStrategy, } from 'aws-cdk-lib/aws-appconfig';
 import { CommonConstruct } from '../../common/index.js';
+/** @category Construct */
 export class ApplicationConfiguration extends CommonConstruct {
     id;
     appConfigApplication;

package/dist/src/construct/application-configuration/types.d.ts

@@ -1,5 +1,6 @@
 import { CommonStackProps } from '../../common/index.js';
 import { AppConfigProps } from '../../services/index.js';
+/** @category Interface */
 export interface ApplicationConfigurationProps extends CommonStackProps {
     appConfig: AppConfigProps;
     appConfigContent: any;

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

@@ -6,6 +6,7 @@ import { LogGroup } from 'aws-cdk-lib/aws-logs';
 import { Queue } from 'aws-cdk-lib/aws-sqs';
 import { Chain, Map, StateMachine } from 'aws-cdk-lib/aws-stepfunctions';
 import { EventHandlerType } from './types.js';
+/** @category Construct */
 export declare class Handler implements EventHandlerType {
     archive: Archive;
     ecsTargets: EcsTask[];

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

@@ -1,3 +1,4 @@
+/** @category Construct */
 export class Handler {
     archive;
     ecsTargets = [];

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

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

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

@@ -8,7 +8,7 @@ import _ from 'lodash';
 import { CommonConstruct } from '../../common/index.js';
 import { Handler } from './handler.js';
 /**
- * @classdesc Provides a construct to create and deploy an EventBridge Event Handler
+ * Provides a construct to create and deploy an EventBridge Event Handler
  * @example
  * import { EventHandler, EventHandlerProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -21,6 +21,7 @@ import { Handler } from './handler.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class EventHandler extends CommonConstruct {
     props;

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

@@ -6,6 +6,7 @@ import { Queue } from 'aws-cdk-lib/aws-sqs';
 import { Chain, Map, StateMachine } from 'aws-cdk-lib/aws-stepfunctions';
 import { CommonStackProps } from '../../common/index.js';
 import { EventRuleProps, LogProps, QueueProps, SfnMapProps, SfnStateMachineProps, VpcProps } from '../../services/index.js';
+/** @category Interface */
 export interface EventHandlerProps extends CommonStackProps {
     eventBusName: string;
     eventRetentionInDays: number;
@@ -20,6 +21,7 @@ export interface EventHandlerProps extends CommonStackProps {
     workflowLog: LogProps;
     workflowMapState: SfnMapProps;
 }
+/** @category Interface */
 export interface EventHandlerType {
     archive: Archive;
     ecsTargets: EcsTask[];

package/dist/src/construct/lambda-with-iam-access/main.d.ts

@@ -7,7 +7,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common/index.js';
 import { LambdaWithIamAccessEnvironment, LambdaWithIamAccessProps } from './types.js';
 /**
- * @classdesc Provides a construct to create a lambda function with IAM access
+ * Provides a construct to create a lambda function with IAM access
  * @example
  * import { LambdaWithIamAccess, LambdaWithIamAccessProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -20,6 +20,7 @@ import { LambdaWithIamAccessEnvironment, LambdaWithIamAccessProps } from './type
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class LambdaWithIamAccess extends CommonConstruct {
     props: LambdaWithIamAccessProps;

package/dist/src/construct/lambda-with-iam-access/main.js

@@ -6,7 +6,7 @@ import _ from 'lodash';
 import { CommonConstruct } from '../../common/index.js';
 import { Architecture } from '../../services/index.js';
 /**
- * @classdesc Provides a construct to create a lambda function with IAM access
+ * Provides a construct to create a lambda function with IAM access
  * @example
  * import { LambdaWithIamAccess, LambdaWithIamAccessProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -19,6 +19,7 @@ import { Architecture } from '../../services/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class LambdaWithIamAccess extends CommonConstruct {
     /* LambdaWithIamAccess props */

package/dist/src/construct/lambda-with-iam-access/types.d.ts

@@ -2,6 +2,7 @@ import { AssetCode, LambdaInsightsVersion } from 'aws-cdk-lib/aws-lambda';
 import { SecretProps } from 'aws-cdk-lib/aws-secretsmanager';
 import { CommonStackProps } from '../../common/index.js';
 import { LambdaEnvironment, LambdaProps } from '../../services/index.js';
+/** @category Interface */
 export interface LambdaWithIamAccessProps extends CommonStackProps {
     configEnabled?: boolean;
     lambda: LambdaProps;
@@ -16,5 +17,6 @@ export interface LambdaWithIamAccessProps extends CommonStackProps {
     timezone: string;
     vpcName?: string;
 }
+/** @category Interface */
 export interface LambdaWithIamAccessEnvironment extends LambdaEnvironment {
 }