@gradientedge/cdk-utils-aws 2.4.1 → 2.6.0

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

@@ -20,11 +20,22 @@ import { ApiToAnyTargetProps, ApiToAnyTargetRestApiResource, ApiToAnyTargetRestA
  * @category Construct
  */
 export declare class ApiToAnyTarget extends CommonConstruct {
+    /** The API to any target properties */
     props: ApiToAnyTargetProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets: ISecret[];
+    /** The REST API resources (api, integration, domain, etc.) */
     apiToAnyTargetRestApi: ApiToAnyTargetRestApiType;
+    /** The default API resource path name */
     apiResource: string;
+    /**
+     * @summary Create a new ApiToAnyTarget construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the API to any target properties
+     */
     constructor(parent: Construct, id: string, props: ApiToAnyTargetProps);
     /**
      * @summary Initialise and provision resources

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

@@ -19,13 +19,22 @@ import { ApiToAnyTargetRestApi } from './target.js';
  * @category Construct
  */
 export class ApiToAnyTarget extends CommonConstruct {
+    /** The API to any target properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* application related resources */
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets;
-    /* rest restApi related resources */
+    /** The REST API resources (api, integration, domain, etc.) */
     apiToAnyTargetRestApi;
+    /** The default API resource path name */
     apiResource;
+    /**
+     * @summary Create a new ApiToAnyTarget construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the API to any target properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

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

@@ -3,21 +3,36 @@ 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 */
+/**
+ * Container class to hold all REST API resources for the {@link ApiToAnyTarget} construct
+ * @category Construct
+ */
 export declare class ApiToAnyTargetRestApi implements ApiToAnyTargetRestApiType {
+    /** The CloudWatch log group for API Gateway access logs */
     accessLogGroup: LogGroup;
+    /** The API Gateway REST API */
     api: IRestApi;
+    /** The optional API Gateway authorizer */
     authoriser?: IAuthorizer;
+    /** The base path mappings for the API custom domain */
     basePathMappings: BasePathMapping[];
+    /** The SSL/TLS certificate for the custom domain */
     certificate: ICertificate;
+    /** The API Gateway custom domain */
     domain: DomainName;
+    /** The Route53 hosted zone for the API domain */
     hostedZone: IHostedZone;
+    /** The default API Gateway integration */
     integration: Integration;
+    /** Map of HTTP methods to their API Gateway Method resources */
     method: {
         [httpMethod: string]: Method;
     };
+    /** The default method error response */
     methodErrorResponse: MethodResponse;
+    /** The default method success response */
     methodResponse: MethodResponse;
+    /** Map of paths to their API Gateway Resource objects */
     resource: {
         [path: string]: Resource;
     };

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

@@ -1,15 +1,30 @@
-/** @category Construct */
+/**
+ * Container class to hold all REST API resources for the {@link ApiToAnyTarget} construct
+ * @category Construct
+ */
 export class ApiToAnyTargetRestApi {
+    /** The CloudWatch log group for API Gateway access logs */
     accessLogGroup;
+    /** The API Gateway REST API */
     api;
+    /** The optional API Gateway authorizer */
     authoriser;
+    /** The base path mappings for the API custom domain */
     basePathMappings;
+    /** The SSL/TLS certificate for the custom domain */
     certificate;
+    /** The API Gateway custom domain */
     domain;
+    /** The Route53 hosted zone for the API domain */
     hostedZone;
+    /** The default API Gateway integration */
     integration;
+    /** Map of HTTP methods to their API Gateway Method resources */
     method;
+    /** The default method error response */
     methodErrorResponse;
+    /** The default method success response */
     methodResponse;
+    /** Map of paths to their API Gateway Resource objects */
     resource;
 }

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

@@ -4,61 +4,113 @@ 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';
+/**
+ * Type definition for REST API resources used by the {@link ApiToAnyTarget} construct
+ */
 /** @category Interface */
 export interface ApiToAnyTargetRestApiType {
+    /** The CloudWatch log group for API Gateway access logs */
     accessLogGroup: LogGroup;
+    /** The API Gateway REST API */
     api: IRestApi;
+    /** The optional API Gateway authorizer */
     authoriser?: IAuthorizer;
+    /** The base path mappings for the API custom domain */
     basePathMappings: BasePathMapping[];
+    /** The SSL/TLS certificate for the custom domain */
     certificate: ICertificate;
+    /** The API Gateway custom domain */
     domain: DomainName;
+    /** The Route53 hosted zone for the API domain */
     hostedZone: IHostedZone;
+    /** The default API Gateway integration */
     integration: Integration;
+    /** Map of HTTP methods to their API Gateway Method resources */
     method: {
         [httpMethod: string]: Method;
     };
+    /** The default method error response */
     methodErrorResponse: MethodResponse;
+    /** The default method success response */
     methodResponse: MethodResponse;
+    /** Map of paths to their API Gateway Resource objects */
     resource: {
         [path: string]: Resource;
     };
 }
+/**
+ * Properties for defining an individual API resource with its integration and configuration
+ */
 /** @category Interface */
 export interface ApiToAnyTargetRestApiResource {
+    /** Whether to add a proxy resource ({proxy+}) under this resource */
     addProxy: boolean;
+    /** The optional API Gateway authorizer for this resource */
     authorizer?: IAuthorizer;
+    /** The allowed CORS origins */
     allowedOrigins?: string[];
+    /** The allowed CORS HTTP methods */
     allowedMethods?: string[];
+    /** The allowed CORS headers */
     allowedHeaders?: string[];
+    /** The API Gateway integration for this resource */
     integration: Integration;
+    /** Required method request parameters */
     methodRequestParameters?: {
         [param: string]: boolean;
     };
+    /** The resource path segment */
     path: string;
+    /** The parent resource to attach this resource to */
     parent?: IResource;
+    /** The integration to use for the proxy resource */
     proxyIntegration?: Integration;
+    /** Whether to enable default CORS preflight configuration */
     enableDefaultCors?: boolean;
+    /** The mock integration for testing */
     mockIntegration?: MockIntegration;
+    /** The mock method responses */
     mockMethodResponses?: MethodResponse[];
 }
+/**
+ * Properties for configuring the REST API in the {@link ApiToAnyTarget} construct
+ */
 /** @category Interface */
 export interface ApiToAnyTargetRestApiProps {
+    /** The SSL/TLS certificate configuration */
     certificate: AcmProps;
+    /** CloudFormation export name for an existing REST API ID */
     importedRestApiRef?: string;
+    /** CloudFormation export name for an existing REST API root resource ID */
     importedRestApiRootResourceRef?: string;
+    /** Custom method error response configuration */
     methodErrorResponse: MethodResponse;
+    /** Custom method success response configuration */
     methodResponse: MethodResponse;
+    /** REST API configuration properties */
     restApi: RestApigProps;
+    /** Whether to use an existing REST API instead of creating a new one */
     useExisting: boolean;
+    /** Whether to create resources and methods on the REST API */
     withResource?: boolean;
 }
+/**
+ * Properties for configuring an {@link ApiToAnyTarget} construct
+ */
 /** @category Interface */
 export interface ApiToAnyTargetProps extends CommonStackProps {
+    /** REST API configuration */
     api: ApiToAnyTargetRestApiProps;
+    /** Additional API root paths for base path mappings */
     apiRootPaths?: string[];
+    /** The subdomain for the API Gateway custom domain */
     apiSubDomain: string;
+    /** The application log level */
     logLevel: string;
+    /** The Node.js environment (e.g. development, production) */
     nodeEnv: string;
+    /** The timezone for the application */
     timezone: string;
+    /** Whether to look up an existing hosted zone instead of creating one */
     useExistingHostedZone: boolean;
 }

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

@@ -10,26 +10,44 @@ import { ApiToEventBridgeTargetRestApiType } from './types.js';
  * @category Construct
  */
 export declare class ApiToEventbridgeTargetRestApi implements ApiToEventBridgeTargetRestApiType {
+    /** The CloudWatch log group for API Gateway access logs */
     accessLogGroup: LogGroup;
+    /** The API Gateway REST API */
     api: RestApi;
+    /** The SSL/TLS certificate for the custom domain */
     certificate: ICertificate;
+    /** The API Gateway custom domain */
     domain: DomainName;
+    /** The API Gateway error response model */
     errorResponseModel: Model;
+    /** The Route53 hosted zone for the API domain */
     hostedZone: IHostedZone;
+    /** The API Gateway integration with the backend service */
     integration: Integration;
+    /** The integration error response mapping */
     integrationErrorResponse: IntegrationResponse;
+    /** The integration request parameter mappings */
     integrationRequestParameters: {
         [p: string]: string;
     };
+    /** The integration request template mappings */
     integrationRequestTemplates: {
         [p: string]: string;
     };
+    /** The integration success response mapping */
     integrationResponse: IntegrationResponse;
+    /** The API Gateway resource method */
     method: Method;
+    /** The method error response */
     methodErrorResponse: MethodResponse;
+    /** The method success response */
     methodResponse: MethodResponse;
+    /** The API Gateway resource */
     resource: Resource;
+    /** The success response model */
     responseModel: Model;
+    /** The SNS topic for event forwarding */
     topic: Topic;
+    /** The IAM role for the API Gateway integration */
     role: Role;
 }

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

@@ -3,22 +3,40 @@
  * @category Construct
  */
 export class ApiToEventbridgeTargetRestApi {
+    /** The CloudWatch log group for API Gateway access logs */
     accessLogGroup;
+    /** The API Gateway REST API */
     api;
+    /** The SSL/TLS certificate for the custom domain */
     certificate;
+    /** The API Gateway custom domain */
     domain;
+    /** The API Gateway error response model */
     errorResponseModel;
+    /** The Route53 hosted zone for the API domain */
     hostedZone;
+    /** The API Gateway integration with the backend service */
     integration;
+    /** The integration error response mapping */
     integrationErrorResponse;
+    /** The integration request parameter mappings */
     integrationRequestParameters;
+    /** The integration request template mappings */
     integrationRequestTemplates;
+    /** The integration success response mapping */
     integrationResponse;
+    /** The API Gateway resource method */
     method;
+    /** The method error response */
     methodErrorResponse;
+    /** The method success response */
     methodResponse;
+    /** The API Gateway resource */
     resource;
+    /** The success response model */
     responseModel;
+    /** The SNS topic for event forwarding */
     topic;
+    /** The IAM role for the API Gateway integration */
     role;
 }

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

@@ -6,11 +6,18 @@ import { ApiToEventBridgeTargetEventType } from './types.js';
  * @category Construct
  */
 export declare class ApiToEventbridgeTargetEvent implements ApiToEventBridgeTargetEventType {
+    /** The EventBridge event bus */
     eventBus: IEventBus;
+    /** The CloudWatch log group for event logging */
     logGroup: LogGroup;
+    /** The CloudWatch log group for failed event deliveries */
     logGroupFailure: LogGroup;
+    /** The CloudWatch log group for successful event deliveries */
     logGroupSuccess: LogGroup;
+    /** The EventBridge rule for routing events */
     rule: Rule;
+    /** The EventBridge rule for failed event deliveries */
     ruleFailure: Rule;
+    /** The EventBridge rule for successful event deliveries */
     ruleSuccess: Rule;
 }

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

@@ -3,11 +3,18 @@
  * @category Construct
  */
 export class ApiToEventbridgeTargetEvent {
+    /** The EventBridge event bus */
     eventBus;
+    /** The CloudWatch log group for event logging */
     logGroup;
+    /** The CloudWatch log group for failed event deliveries */
     logGroupFailure;
+    /** The CloudWatch log group for successful event deliveries */
     logGroupSuccess;
+    /** The EventBridge rule for routing events */
     rule;
+    /** The EventBridge rule for failed event deliveries */
     ruleFailure;
+    /** The EventBridge rule for successful event deliveries */
     ruleSuccess;
 }

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

@@ -21,12 +21,24 @@ import { ApiToEventBridgeTargetEventType, ApiToEventBridgeTargetProps, ApiToEven
  * @category Construct
  */
 export declare class ApiToEventBridgeTarget extends CommonConstruct {
+    /** The API to EventBridge target properties */
     props: ApiToEventBridgeTargetProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets: ISecret[];
+    /** The EventBridge event resources (bus, rules, log groups) */
     apiEvent: ApiToEventBridgeTargetEventType;
+    /** The REST API resources (api, integration, domain, etc.) */
     apiToEventBridgeTargetRestApi: ApiToEventBridgeTargetRestApiType;
+    /** The default API resource path name */
     apiResource: string;
+    /**
+     * @summary Create a new ApiToEventBridgeTarget construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the API to EventBridge target properties
+     */
     constructor(parent: Construct, id: string, props: ApiToEventBridgeTargetProps);
     /**
      * @summary Initialise and provision resources

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

@@ -25,15 +25,24 @@ import { ApiToEventbridgeTargetEvent } from './event.js';
  * @category Construct
  */
 export class ApiToEventBridgeTarget extends CommonConstruct {
+    /** The API to EventBridge target properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* application related resources */
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets;
-    /* event related resources */
+    /** The EventBridge event resources (bus, rules, log groups) */
     apiEvent;
-    /* rest restApi related resources */
+    /** The REST API resources (api, integration, domain, etc.) */
     apiToEventBridgeTargetRestApi;
+    /** The default API resource path name */
     apiResource;
+    /**
+     * @summary Create a new ApiToEventBridgeTarget construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the API to EventBridge target properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

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

@@ -9,97 +9,164 @@ import { ITopic } from 'aws-cdk-lib/aws-sns';
 import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, EventRuleProps, LambdaProps, LogProps, RestApigProps } from '../../services/index.js';
 /**
+ * Type definition for EventBridge event resources used by the {@link ApiToEventBridgeTarget} construct
  */
 /** @category Interface */
 export interface ApiToEventBridgeTargetEventType {
+    /** The EventBridge event bus */
     eventBus: IEventBus;
+    /** The CloudWatch log group for event logging */
     logGroup: LogGroup;
+    /** The CloudWatch log group for failed event deliveries */
     logGroupFailure: LogGroup;
+    /** The CloudWatch log group for successful event deliveries */
     logGroupSuccess: LogGroup;
+    /** The EventBridge rule for routing events */
     rule: Rule;
+    /** The EventBridge rule for failed event deliveries */
     ruleFailure: Rule;
+    /** The EventBridge rule for successful event deliveries */
     ruleSuccess: Rule;
 }
 /**
+ * Type definition for REST API resources used by the {@link ApiToEventBridgeTarget} construct
  */
 /** @category Interface */
 export interface ApiToEventBridgeTargetRestApiType {
+    /** The CloudWatch log group for API Gateway access logs */
     accessLogGroup: LogGroup;
+    /** The API Gateway REST API */
     api: IRestApi;
+    /** The optional API Gateway authorizer */
     authoriser?: IAuthorizer;
+    /** The SSL/TLS certificate for the custom domain */
     certificate: ICertificate;
+    /** The API Gateway custom domain */
     domain: DomainName;
+    /** The API Gateway error response model */
     errorResponseModel: Model;
+    /** The Route53 hosted zone for the API domain */
     hostedZone: IHostedZone;
+    /** The API Gateway integration with EventBridge */
     integration: Integration;
+    /** The API Gateway integration error response mapping */
     integrationErrorResponse: IntegrationResponse;
+    /** The API Gateway integration request parameter mappings */
     integrationRequestParameters: {
         [p: string]: string;
     };
+    /** The API Gateway integration request template mappings */
     integrationRequestTemplates: {
         [p: string]: string;
     };
+    /** The API Gateway integration success response mapping */
     integrationResponse: IntegrationResponse;
+    /** The API Gateway resource method */
     method: Method;
+    /** The API Gateway method error response */
     methodErrorResponse: MethodResponse;
+    /** The API Gateway method success response */
     methodResponse: MethodResponse;
+    /** The IAM policy for the API Gateway integration role */
     policy?: PolicyDocument;
+    /** The API Gateway resource */
     resource: Resource;
+    /** The API Gateway success response model */
     responseModel: Model;
+    /** The IAM role for the API Gateway integration */
     role?: Role;
+    /** The optional SNS topic for event forwarding */
     topic?: ITopic;
 }
 /**
+ * Properties for configuring the REST API in the {@link ApiToEventBridgeTarget} construct
  */
 /** @category Interface */
 export interface ApiToEventBridgeTargetRestApiProps {
+    /** The SSL/TLS certificate configuration */
     certificate: AcmProps;
+    /** Custom error response model options */
     errorResponseModel?: ModelOptions;
+    /** CloudFormation export name for an existing REST API ID */
     importedRestApiRef?: string;
+    /** CloudFormation export name for an existing REST API root resource ID */
     importedRestApiRootResourceRef?: string;
+    /** Custom integration error response configuration */
     integrationErrorResponse?: IntegrationResponse;
+    /** Custom integration options */
     integrationOptions?: IntegrationOptions;
+    /** Custom integration success response configuration */
     integrationResponse?: IntegrationResponse;
+    /** Custom method error response configuration */
     methodErrorResponse?: MethodResponse;
+    /** Custom method success response configuration */
     methodResponse?: MethodResponse;
+    /** The API resource path name */
     resource: string;
+    /** Custom success response model options */
     responseModel?: ModelOptions;
+    /** REST API configuration properties */
     restApi?: RestApigProps;
+    /** Whether to use an existing REST API instead of creating a new one */
     useExisting: boolean;
+    /** Whether to create a resource and method on the REST API */
     withResource?: boolean;
 }
 /**
+ * Properties for configuring the Lambda function in the {@link ApiToEventBridgeTarget} construct
  */
 /** @category Interface */
 export interface ApiToEventBridgeTargetLambdaProps {
+    /** The Lambda function configuration */
     function: LambdaProps;
+    /** The Lambda handler entry point */
     handler?: string;
+    /** The Lambda layer source code asset */
     layerSource?: AssetCode;
+    /** The Lambda function source code asset */
     source?: AssetCode;
 }
 /**
+ * Properties for configuring EventBridge events in the {@link ApiToEventBridgeTarget} construct
  */
 /** @category Interface */
 export interface ApiToEventBridgeTargetEventProps {
+    /** The name of the custom event bus (defaults to 'default') */
     eventBusName?: string;
+    /** Log group configuration for event logging */
     logGroup?: LogProps;
+    /** Log group configuration for failed event deliveries */
     logGroupFailure?: LogProps;
+    /** Log group configuration for successful event deliveries */
     logGroupSuccess?: LogProps;
+    /** The EventBridge rule configuration */
     rule: EventRuleProps;
+    /** The EventBridge rule configuration for failures */
     ruleFailure: EventRuleProps;
+    /** The EventBridge rule configuration for successes */
     ruleSuccess: EventRuleProps;
 }
 /**
+ * Properties for configuring an {@link ApiToEventBridgeTarget} construct
  */
 /** @category Interface */
 export interface ApiToEventBridgeTargetProps extends CommonStackProps {
+    /** REST API configuration */
     api: ApiToEventBridgeTargetRestApiProps;
+    /** Additional API root paths for base path mappings */
     apiRootPaths?: string[];
+    /** The subdomain for the API Gateway custom domain */
     apiSubDomain: string;
+    /** EventBridge event configuration */
     event: ApiToEventBridgeTargetEventProps;
+    /** Optional Lambda function configuration for event processing */
     lambda?: ApiToEventBridgeTargetLambdaProps;
+    /** The application log level */
     logLevel: string;
+    /** The Node.js environment (e.g. development, production) */
     nodeEnv: string;
+    /** The timezone for the application */
     timezone: string;
+    /** Whether to look up an existing hosted zone instead of creating one */
     useExistingHostedZone: boolean;
 }

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

@@ -7,11 +7,18 @@ import { ApiDestinedLambdaEnvironment, ApiDestinedLambdaType } from './types.js'
  * @category Construct
  */
 export declare class ApiDestinedLambda implements ApiDestinedLambdaType {
+    /** The EventBridge destination for failed Lambda invocations */
     destinationFailure: EventBridgeDestination;
+    /** The EventBridge destination for successful Lambda invocations */
     destinationSuccess: EventBridgeDestination;
+    /** The environment variables for the Lambda function */
     environment: ApiDestinedLambdaEnvironment;
+    /** The Lambda function */
     function: IFunction;
+    /** The Lambda layers attached to the function */
     layers: LayerVersion[];
+    /** The IAM policy for the Lambda function */
     policy: PolicyDocument;
+    /** The IAM role for the Lambda function */
     role: Role;
 }

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

@@ -3,11 +3,18 @@
  * @category Construct
  */
 export class ApiDestinedLambda {
+    /** The EventBridge destination for failed Lambda invocations */
     destinationFailure;
+    /** The EventBridge destination for successful Lambda invocations */
     destinationSuccess;
+    /** The environment variables for the Lambda function */
     environment;
+    /** The Lambda function */
     function;
+    /** The Lambda layers attached to the function */
     layers;
+    /** The IAM policy for the Lambda function */
     policy;
+    /** The IAM role for the Lambda function */
     role;
 }

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

@@ -23,13 +23,26 @@ import { ApiDestinedLambdaType } from './types.js';
  * @category Construct
  */
 export declare class ApiToEventBridgeTargetWithSns extends CommonConstruct {
+    /** The API to EventBridge target properties */
     props: ApiToEventBridgeTargetProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets: ISecret[];
+    /** The API destined Lambda resources (function, role, destinations) */
     apiDestinedLambda: ApiDestinedLambdaType;
+    /** The EventBridge event resources (bus, rules, log groups) */
     apiEvent: ApiToEventBridgeTargetEventType;
+    /** The REST API resources (api, integration, domain, etc.) */
     apiDestinedRestApi: ApiToEventBridgeTargetRestApiType;
+    /** The default API resource path name */
     apiResource: string;
+    /**
+     * @summary Create a new ApiToEventBridgeTargetWithSns construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the API to EventBridge target properties
+     */
     constructor(parent: Construct, id: string, props: ApiToEventBridgeTargetProps);
     /**
      * @summary Initialise and provision resources