@gradientedge/cdk-utils-aws 2.3.0 → 2.4.0

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

@@ -17,38 +17,76 @@ import { CommonStackProps } from './types.js';
  * @category Common
  */
 export declare class CommonConstruct extends Construct {
+    /** The common stack properties for the construct */
     props: CommonStackProps;
+    /** Utility for formatting resource names with prefix/suffix conventions */
     resourceNameFormatter: ResourceNameFormatter;
+    /** Manager for AWS Certificate Manager operations */
     acmManager: AcmManager;
+    /** Manager for API Gateway operations */
     apiManager: ApiManager;
+    /** Manager for AWS AppConfig operations */
     appConfigManager: AppConfigManager;
+    /** Manager for AWS CodeBuild operations */
     codeBuildManager: CodeBuildManager;
+    /** Manager for CloudFront distribution operations */
     cloudFrontManager: CloudFrontManager;
+    /** Manager for CloudTrail operations */
     cloudTrailManager: CloudTrailManager;
+    /** Manager for CloudWatch operations */
     cloudWatchManager: CloudWatchManager;
+    /** Manager for DynamoDB operations */
     dynamodbManager: DynamodbManager;
+    /** Manager for Elastic Container Registry operations */
     ecrManager: EcrManager;
+    /** Manager for Elastic Container Service operations */
     ecsManager: EcsManager;
+    /** Manager for Elastic File System operations */
     efsManager: EfsManager;
+    /** Manager for Elastic Kubernetes Service operations */
     eksManager: EksManager;
+    /** Manager for ElastiCache operations */
     elasticacheManager: ElastiCacheManager;
+    /** Manager for EventBridge operations */
     eventManager: EventManager;
+    /** Manager for EventBridge target operations */
     eventTargetManager: EventTargetManager;
+    /** Manager for CloudWatch Evidently operations */
     evidentlyManager: EvidentlyManager;
+    /** Manager for IAM operations */
     iamManager: IamManager;
+    /** Manager for KMS operations */
     kmsManager: KmsManager;
+    /** Manager for Lambda operations */
     lambdaManager: LambdaManager;
+    /** Manager for CloudWatch Logs operations */
     logManager: LogManager;
+    /** Manager for Route53 operations */
     route53Manager: Route53Manager;
+    /** Manager for S3 operations */
     s3Manager: S3Manager;
+    /** Manager for Secrets Manager operations */
     secretsManager: SecretsManager;
+    /** Manager for Step Functions operations */
     sfnManager: SfnManager;
+    /** Manager for SNS operations */
     snsManager: SnsManager;
+    /** Manager for SQS operations */
     sqsManager: SqsManager;
+    /** Manager for Systems Manager operations */
     ssmManager: SsmManager;
+    /** Manager for VPC operations */
     vpcManager: VpcManager;
+    /** Manager for WAF operations */
     wafManager: WafManager;
+    /** The fully qualified domain name resolved from domainName and subDomain */
     fullyQualifiedDomainName: string;
+    /**
+     * @summary Create a new CommonConstruct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the common stack properties
+     */
     constructor(parent: Construct, id: string, props: CommonStackProps);
     /**
      * @summary Helper method to add CloudFormation outputs from the construct

package/dist/src/common/construct.js

@@ -17,38 +17,76 @@ import { ResourceNameFormatter } from './resource-name-formatter.js';
  * @category Common
  */
 export class CommonConstruct extends Construct {
+    /** The common stack properties for the construct */
     props;
+    /** Utility for formatting resource names with prefix/suffix conventions */
     resourceNameFormatter;
+    /** Manager for AWS Certificate Manager operations */
     acmManager;
+    /** Manager for API Gateway operations */
     apiManager;
+    /** Manager for AWS AppConfig operations */
     appConfigManager;
+    /** Manager for AWS CodeBuild operations */
     codeBuildManager;
+    /** Manager for CloudFront distribution operations */
     cloudFrontManager;
+    /** Manager for CloudTrail operations */
     cloudTrailManager;
+    /** Manager for CloudWatch operations */
     cloudWatchManager;
+    /** Manager for DynamoDB operations */
     dynamodbManager;
+    /** Manager for Elastic Container Registry operations */
     ecrManager;
+    /** Manager for Elastic Container Service operations */
     ecsManager;
+    /** Manager for Elastic File System operations */
     efsManager;
+    /** Manager for Elastic Kubernetes Service operations */
     eksManager;
+    /** Manager for ElastiCache operations */
     elasticacheManager;
+    /** Manager for EventBridge operations */
     eventManager;
+    /** Manager for EventBridge target operations */
     eventTargetManager;
+    /** Manager for CloudWatch Evidently operations */
     evidentlyManager;
+    /** Manager for IAM operations */
     iamManager;
+    /** Manager for KMS operations */
     kmsManager;
+    /** Manager for Lambda operations */
     lambdaManager;
+    /** Manager for CloudWatch Logs operations */
     logManager;
+    /** Manager for Route53 operations */
     route53Manager;
+    /** Manager for S3 operations */
     s3Manager;
+    /** Manager for Secrets Manager operations */
     secretsManager;
+    /** Manager for Step Functions operations */
     sfnManager;
+    /** Manager for SNS operations */
     snsManager;
+    /** Manager for SQS operations */
     sqsManager;
+    /** Manager for Systems Manager operations */
     ssmManager;
+    /** Manager for VPC operations */
     vpcManager;
+    /** Manager for WAF operations */
     wafManager;
+    /** The fully qualified domain name resolved from domainName and subDomain */
     fullyQualifiedDomainName;
+    /**
+     * @summary Create a new CommonConstruct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the common stack properties
+     */
     constructor(parent, id, props) {
         super(parent, id);
         this.props = props;

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

@@ -1,8 +1,19 @@
 import { Construct } from 'constructs';
 import { CommonStackProps, ResourceNameFormatterProps } from './types.js';
-/** @category Common */
+/**
+ * Utility class to format resource names with configurable prefix, suffix, and stage conventions.
+ * Ensures consistent naming across all provisioned AWS resources.
+ * @category Common
+ */
 export declare class ResourceNameFormatter extends Construct {
+    /** The common stack properties used for resource name formatting */
     props: CommonStackProps;
+    /**
+     * @summary Create a new ResourceNameFormatter
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the common stack properties
+     */
     constructor(parent: Construct, id: string, props: CommonStackProps);
     /**
      * @summary Helper method to format a resource name based on the provided options

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

@@ -1,7 +1,18 @@
 import { Construct } from 'constructs';
-/** @category Common */
+/**
+ * Utility class to format resource names with configurable prefix, suffix, and stage conventions.
+ * Ensures consistent naming across all provisioned AWS resources.
+ * @category Common
+ */
 export class ResourceNameFormatter extends Construct {
+    /** The common stack properties used for resource name formatting */
     props;
+    /**
+     * @summary Create a new ResourceNameFormatter
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the common stack properties
+     */
     constructor(parent, id, props) {
         super(parent, id);
         this.props = props;

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

@@ -16,9 +16,18 @@ import { CommonConstruct } from './construct.js';
  * @category Common
  */
 export declare class CommonStack extends Stack {
+    /** The default Node.js runtime used for Lambda functions */
     static NODEJS_RUNTIME: Runtime;
+    /** The common construct instance provisioned by this stack */
     construct: CommonConstruct;
+    /** The resolved common stack properties */
     props: CommonStackProps;
+    /**
+     * @summary Create a new CommonStack
+     * @param parent the CDK app
+     * @param name the stack name
+     * @param props the stack properties
+     */
     constructor(parent: App, name: string, props: StackProps);
     /**
      * @summary Method to determine the core CDK construct properties injected via context cdk.json

package/dist/src/common/stack.js

@@ -20,9 +20,18 @@ import { CommonConstruct } from './construct.js';
  * @category Common
  */
 export class CommonStack extends Stack {
+    /** The default Node.js runtime used for Lambda functions */
     static NODEJS_RUNTIME = Runtime.NODEJS_24_X;
+    /** The common construct instance provisioned by this stack */
     construct;
+    /** The resolved common stack properties */
     props;
+    /**
+     * @summary Create a new CommonStack
+     * @param parent the CDK app
+     * @param name the stack name
+     * @param props the stack properties
+     */
     constructor(parent, name, props) {
         super(parent, name, props);
         /* determine extra cdk contexts */

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

@@ -3,30 +3,52 @@ import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
 import { RetentionDays } from 'aws-cdk-lib/aws-logs';
 import { BaseProps } from '@gradientedge/cdk-utils-common';
 /**
+ * Common stack properties shared across all AWS constructs and stacks
  */
 /** @category Interface */
 export interface CommonStackProps extends BaseProps, StackProps {
+    /** The AWS region for resource deployment */
     region: string;
+    /** Optional project identifier used in resource naming */
     resourceProjectIdentifier?: string;
+    /** Global prefix prepended to all resource names */
     globalPrefix?: string;
+    /** Global suffix appended to all resource names */
     globalSuffix?: string;
+    /** Default prefix for resource names */
     resourcePrefix?: string;
+    /** Default suffix for resource names */
     resourceSuffix?: string;
+    /** The log retention period for CloudWatch log groups */
     logRetention?: RetentionDays;
+    /** The default reserved concurrent executions for Lambda functions */
     defaultReservedLambdaConcurrentExecutions?: number;
+    /** The default tracing configuration for Lambda functions */
     defaultTracing?: Tracing;
+    /** Whether to exclude the domain name from S3 bucket names */
     excludeDomainNameForBuckets?: boolean;
+    /** Whether to exclude the account number from S3 bucket names */
     excludeAccountNumberForBuckets?: boolean;
+    /** The Node.js runtime version for Lambda functions */
     nodejsRuntime?: Runtime;
+    /** Per-service resource name formatting options */
     resourceNameOptions?: {
         [key: string]: ResourceNameFormatterProps;
     };
 }
+/**
+ * Options for controlling how a resource name is formatted
+ */
 /** @category Interface */
 export interface ResourceNameFormatterProps {
+    /** Whether to exclude the prefix and suffix from the formatted name */
     exclude?: boolean;
+    /** Whether to include the global prefix */
     globalPrefix?: boolean;
+    /** Whether to include the global suffix */
     globalSuffix?: boolean;
+    /** Custom prefix to use instead of the default resource prefix */
     prefix?: string;
+    /** Custom suffix to use instead of the default resource suffix */
     suffix?: string;
 }

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

@@ -26,6 +26,9 @@ export declare class ApiToAnyTarget extends CommonConstruct {
     apiToAnyTargetRestApi: ApiToAnyTargetRestApiType;
     apiResource: string;
     constructor(parent: Construct, id: string, props: ApiToAnyTargetProps);
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources(): void;
     /**
      * @summary Method to resolve secrets from SecretsManager
@@ -40,9 +43,25 @@ export declare class ApiToAnyTarget extends CommonConstruct {
      * @summary Method to resolve a certificate based on attributes
      */
     protected resolveCertificate(): void;
+    /**
+     * @summary Create or resolve the API Gateway REST API for the any-target integration
+     */
     protected createApiToAnyTargetRestApi(): void;
+    /**
+     * @summary Create an API resource with the specified integration and method configuration
+     * @param apiResourceProps the resource properties including path, integration, and authorizer
+     */
     protected createApiToAnyTargetResource(apiResourceProps: ApiToAnyTargetRestApiResource): Resource | undefined;
+    /**
+     * @summary Create the custom domain for the API Gateway
+     */
     protected createApiDomain(): void;
+    /**
+     * @summary Create the base path mapping for the API custom domain
+     */
     protected createApiBasePathMapping(): void;
+    /**
+     * @summary Create Route53 DNS records for the API custom domain
+     */
     protected createApiRouteAssets(): void;
 }

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

@@ -32,6 +32,9 @@ export class ApiToAnyTarget extends CommonConstruct {
         this.id = id;
         this.apiToAnyTargetRestApi = new ApiToAnyTargetRestApi();
     }
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources() {
         /* application related resources */
         this.resolveSecrets();
@@ -70,6 +73,9 @@ export class ApiToAnyTarget extends CommonConstruct {
         }
         this.apiToAnyTargetRestApi.certificate = this.acmManager.resolveCertificate(`${this.id}-certificate`, this, this.props.api.certificate);
     }
+    /**
+     * @summary Create or resolve the API Gateway REST API for the any-target integration
+     */
     createApiToAnyTargetRestApi() {
         if (this.props.api.useExisting && this.props.api.importedRestApiRef) {
             this.apiToAnyTargetRestApi.api = RestApi.fromRestApiId(this, `${this.id}-rest-api`, Fn.importValue(this.props.api.importedRestApiRef));
@@ -114,6 +120,10 @@ export class ApiToAnyTarget extends CommonConstruct {
         this.addCfnOutput(`${this.id}-restApiId`, this.apiToAnyTargetRestApi.api.restApiId);
         this.addCfnOutput(`${this.id}-restApiRootResourceId`, this.apiToAnyTargetRestApi.api.root.resourceId);
     }
+    /**
+     * @summary Create an API resource with the specified integration and method configuration
+     * @param apiResourceProps the resource properties including path, integration, and authorizer
+     */
     createApiToAnyTargetResource(apiResourceProps) {
         if (!this.props.api.withResource)
             return;
@@ -130,6 +140,9 @@ export class ApiToAnyTarget extends CommonConstruct {
         }
         return this.apiManager.createApiResource(`${this.id}-resource-${apiResourceProps.path}}`, this, apiResourceProps.parent ?? rootResource, apiResourceProps.path, apiResourceProps.integration, apiResourceProps.addProxy, apiResourceProps.authorizer, apiResourceProps.allowedOrigins, apiResourceProps.allowedMethods, apiResourceProps.allowedHeaders, apiResourceProps.methodRequestParameters, apiResourceProps.proxyIntegration, apiResourceProps.enableDefaultCors, apiResourceProps.mockIntegration, apiResourceProps.mockMethodResponses);
     }
+    /**
+     * @summary Create the custom domain for the API Gateway
+     */
     createApiDomain() {
         if (this.props.api.useExisting)
             return;
@@ -137,6 +150,9 @@ export class ApiToAnyTarget extends CommonConstruct {
             ? `${this.props.apiSubDomain}.${this.fullyQualifiedDomainName}`
             : `${this.props.apiSubDomain}-${this.props.stage}.${this.fullyQualifiedDomainName}`, this.apiToAnyTargetRestApi.certificate);
     }
+    /**
+     * @summary Create the base path mapping for the API custom domain
+     */
     createApiBasePathMapping() {
         if (this.props.api.useExisting)
             return;
@@ -147,6 +163,9 @@ export class ApiToAnyTarget extends CommonConstruct {
             stage: this.apiToAnyTargetRestApi.api.deploymentStage,
         });
     }
+    /**
+     * @summary Create Route53 DNS records for the API custom domain
+     */
     createApiRouteAssets() {
         if (this.props.api.useExisting)
             return;

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

@@ -28,6 +28,9 @@ export declare class ApiToEventBridgeTarget extends CommonConstruct {
     apiToEventBridgeTargetRestApi: ApiToEventBridgeTargetRestApiType;
     apiResource: string;
     constructor(parent: Construct, id: string, props: ApiToEventBridgeTargetProps);
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources(): void;
     /**
      * @summary Method to resolve secrets from SecretsManager
@@ -54,6 +57,9 @@ export declare class ApiToEventBridgeTarget extends CommonConstruct {
      * Method to create EventBridge rule with lambda target for success
      */
     protected createApiToEventBridgeTargetRule(): void;
+    /**
+     * @summary Create the IAM policy for the EventBridge target integration
+     */
     protected createApiToEventBridgeTargetPolicy(): void;
     /**
      * @summary Method to create a role for api integration

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

@@ -42,6 +42,9 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
         this.apiToEventBridgeTargetRestApi = new ApiToEventbridgeTargetRestApi();
         this.apiResource = 'notify';
     }
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources() {
         /* application related resources */
         this.resolveSecrets();
@@ -139,6 +142,9 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
         };
         this.apiEvent.rule = this.eventManager.createRule(`${this.id}-api-to-eventbridge-target-rule`, this, this.props.event.rule, this.apiEvent.eventBus, [new CloudWatchLogGroup(this.apiEvent.logGroup)]);
     }
+    /**
+     * @summary Create the IAM policy for the EventBridge target integration
+     */
     createApiToEventBridgeTargetPolicy() {
         this.apiToEventBridgeTargetRestApi.policy = new PolicyDocument({
             statements: [this.iamManager.statementForPutEvents()],

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

@@ -31,6 +31,9 @@ export declare class ApiToEventBridgeTargetWithSns extends CommonConstruct {
     apiDestinedRestApi: ApiToEventBridgeTargetRestApiType;
     apiResource: string;
     constructor(parent: Construct, id: string, props: ApiToEventBridgeTargetProps);
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources(): void;
     /**
      * @summary Method to resolve secrets from SecretsManager

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

@@ -47,6 +47,9 @@ export class ApiToEventBridgeTargetWithSns extends CommonConstruct {
         this.apiDestinedRestApi = new ApiToEventbridgeTargetRestApi();
         this.apiResource = 'notify';
     }
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources() {
         /* application related resources */
         this.resolveSecrets();

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

@@ -12,6 +12,9 @@ export declare class ApiToLambdaTarget extends CommonConstruct {
     apiToLambdaTargetRestApi: ApiToLambdaTargetRestApiType;
     apiResource: string;
     constructor(parent: Construct, id: string, props: ApiToLambdaTargetProps);
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources(): void;
     /**
      * @summary Method to resolve secrets from SecretsManager
@@ -34,6 +37,9 @@ export declare class ApiToLambdaTarget extends CommonConstruct {
      * @summary Method to create api integration method error response
      */
     protected createApiToLambdaTargetMethodErrorResponse(): void;
+    /**
+     * @summary Resolve an existing Lambda function by name for the API integration
+     */
     protected resolveApiToLambdaTargetFunction(): void;
     /**
      * @summary Method to create rest restApi for Api
@@ -43,6 +49,9 @@ export declare class ApiToLambdaTarget extends CommonConstruct {
      * @summary Method to create api integration resource
      */
     protected createApiToLambdaTargetResource(): void;
+    /**
+     * @summary Create the IAM policy for the Lambda target integration
+     */
     protected createApiToLambdaTargetPolicy(): void;
     /**
      * @summary Method to create a role for api integration

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

@@ -21,6 +21,9 @@ export class ApiToLambdaTarget extends CommonConstruct {
         this.id = id;
         this.apiToLambdaTargetRestApi = new ApiToLambdaTargetRestApi();
     }
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources() {
         this.resolveSecrets();
         this.resolveHostedZone();
@@ -100,6 +103,9 @@ export class ApiToLambdaTarget extends CommonConstruct {
             ...this.props.api.methodErrorResponse,
         };
     }
+    /**
+     * @summary Resolve an existing Lambda function by name for the API integration
+     */
     resolveApiToLambdaTargetFunction() {
         this.apiToLambdaTargetRestApi.lambda = Function.fromFunctionName(this, `${this.id}-lambda`, this.resourceNameFormatter.format(this.props.lambdaFunctionName));
     }
@@ -143,6 +149,9 @@ export class ApiToLambdaTarget extends CommonConstruct {
         }
         this.apiToLambdaTargetRestApi.resource = rootResource.addResource(this.props.api.resource ?? this.apiResource);
     }
+    /**
+     * @summary Create the IAM policy for the Lambda target integration
+     */
     createApiToLambdaTargetPolicy() {
         this.apiToLambdaTargetRestApi.policy = new PolicyDocument({
             statements: [

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

@@ -12,13 +12,40 @@ export declare class ApplicationConfiguration extends CommonConstruct {
     appConfigVersion: CfnHostedConfigurationVersion;
     appConfigDeploymentStrategy: IDeploymentStrategy;
     constructor(parent: Construct, id: string, props: ApplicationConfigurationProps);
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources(): void;
+    /**
+     * @summary Create all AppConfig resources for the application configuration
+     */
     protected createConfiguration(): void;
+    /**
+     * @summary Create the AppConfig application resource
+     */
     protected createAppConfigApplication(): void;
+    /**
+     * @summary Create the AppConfig environment resource
+     */
     protected createAppConfigEnvironment(): void;
+    /**
+     * @summary Create the AppConfig configuration profile resource
+     */
     protected createAppConfigProfile(): void;
+    /**
+     * @summary Create the AppConfig hosted configuration version with the provided content
+     */
     protected createAppConfigVersion(): void;
+    /**
+     * @summary Create or resolve the AppConfig deployment strategy
+     */
     protected createAppConfigDeploymentStrategy(): void;
+    /**
+     * @summary Create the AppConfig deployment to roll out the configuration
+     */
     protected createAppConfigDeployment(): void;
+    /**
+     * @summary Resolve environment variables containing AppConfig resource identifiers for Lambda consumption
+     */
     resolveEnvironmentVariables(): any;
 }

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

@@ -14,10 +14,16 @@ export class ApplicationConfiguration extends CommonConstruct {
         this.props = props;
         this.id = id;
     }
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources() {
         this.createConfiguration();
         this.resolveEnvironmentVariables();
     }
+    /**
+     * @summary Create all AppConfig resources for the application configuration
+     */
     createConfiguration() {
         this.createAppConfigApplication();
         this.createAppConfigEnvironment();
@@ -26,15 +32,27 @@ export class ApplicationConfiguration extends CommonConstruct {
         this.createAppConfigDeploymentStrategy();
         this.createAppConfigDeployment();
     }
+    /**
+     * @summary Create the AppConfig application resource
+     */
     createAppConfigApplication() {
         this.appConfigApplication = this.appConfigManager.createApplication(`${this.id}-ac-application`, this, this.props.appConfig);
     }
+    /**
+     * @summary Create the AppConfig environment resource
+     */
     createAppConfigEnvironment() {
         this.appConfigEnvironment = this.appConfigManager.createEnvironment(`${this.id}-ac-environment`, this, Fn.ref(this.appConfigApplication.logicalId), this.props.appConfig);
     }
+    /**
+     * @summary Create the AppConfig configuration profile resource
+     */
     createAppConfigProfile() {
         this.appConfigProfile = this.appConfigManager.createConfigurationProfile(`${this.id}-ac-profile`, this, Fn.ref(this.appConfigApplication.logicalId), this.props.appConfig);
     }
+    /**
+     * @summary Create the AppConfig hosted configuration version with the provided content
+     */
     createAppConfigVersion() {
         this.appConfigVersion = new CfnHostedConfigurationVersion(this, `${this.id}-ac-configuration`, {
             applicationId: Fn.ref(this.appConfigApplication.logicalId),
@@ -43,6 +61,9 @@ export class ApplicationConfiguration extends CommonConstruct {
             contentType: 'application/json',
         });
     }
+    /**
+     * @summary Create or resolve the AppConfig deployment strategy
+     */
     createAppConfigDeploymentStrategy() {
         if (!this.props.appConfig.deploymentStrategy)
             return;
@@ -61,6 +82,9 @@ export class ApplicationConfiguration extends CommonConstruct {
             deploymentStrategyName: this.resourceNameFormatter.format(this.props.appConfig.deploymentStrategy.deploymentStrategyName ?? 'common-deployment-strategy', this.props.resourceNameOptions?.appconfig),
         });
     }
+    /**
+     * @summary Create the AppConfig deployment to roll out the configuration
+     */
     createAppConfigDeployment() {
         new CfnDeployment(this, `${this.id}-app-config-deployment`, {
             applicationId: Fn.ref(this.appConfigApplication.logicalId),
@@ -70,6 +94,9 @@ export class ApplicationConfiguration extends CommonConstruct {
             environmentId: Fn.ref(this.appConfigEnvironment.logicalId),
         });
     }
+    /**
+     * @summary Resolve environment variables containing AppConfig resource identifiers for Lambda consumption
+     */
     resolveEnvironmentVariables() {
         return {
             APP_CONFIG_APPLICATION_ID: Fn.ref(this.appConfigApplication.logicalId),

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

@@ -28,6 +28,9 @@ export declare class EventHandler extends CommonConstruct {
     useMapState: boolean;
     vpc: IVpc;
     constructor(parent: Construct, id: string, props: EventHandlerProps);
+    /**
+     * @summary Initialise and provision resources
+     */
     initResources(): void;
     /**
      * @summary Method to resolve common vpc  or create a new one.