@gradientedge/cdk-utils-aws 2.5.0 → 2.7.0

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

@@ -23,21 +23,42 @@ import { LambdaWithIamAccessEnvironment, LambdaWithIamAccessProps } from './type
  * @category Construct
  */
 export declare class LambdaWithIamAccess extends CommonConstruct {
+    /** The Lambda with IAM access properties */
     props: LambdaWithIamAccessProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The IAM policy for the Lambda function */
     lambdaPolicy: PolicyDocument;
+    /** The IAM role for the Lambda function */
     lambdaRole: Role;
+    /** The environment variables for the Lambda function */
     lambdaEnvironment: LambdaWithIamAccessEnvironment;
+    /** The Lambda layers attached to the function */
     lambdaLayers: ILayerVersion[];
+    /** The Lambda function */
     lambdaFunction: IFunction;
+    /** The IAM user created for invoking the Lambda function */
     lambdaIamUser: User;
+    /** The IAM access key for the Lambda IAM user */
     lambdaUserAccessKey: CfnAccessKey;
+    /** The Secrets Manager secret storing the IAM access key credentials */
     lambdaUserAccessSecret: Secret;
+    /** The VPC for the Lambda function */
     lambdaVpc: IVpc;
+    /** The security groups for the Lambda function */
     lambdaSecurityGroups: ISecurityGroup[];
+    /** The EFS access point for the Lambda function */
     lambdaAccessPoint: IAccessPoint;
+    /** The EFS mount path for the Lambda function */
     lambdaMountPath: string;
+    /** The VPC subnet selection for the Lambda function */
     lambdaVpcSubnets: SubnetSelection;
+    /**
+     * @summary Create a new LambdaWithIamAccess construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the Lambda with IAM access properties
+     */
     constructor(parent: Construct, id: string, props: LambdaWithIamAccessProps);
     /**
      * @summary Initialise and provision resources

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

@@ -22,23 +22,42 @@ import { Architecture } from '../../services/index.js';
  * @category Construct
  */
 export class LambdaWithIamAccess extends CommonConstruct {
-    /* LambdaWithIamAccess props */
+    /** The Lambda with IAM access properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* LambdaWithIamAccess resources */
+    /** The IAM policy for the Lambda function */
     lambdaPolicy;
+    /** The IAM role for the Lambda function */
     lambdaRole;
+    /** The environment variables for the Lambda function */
     lambdaEnvironment;
+    /** The Lambda layers attached to the function */
     lambdaLayers = [];
+    /** The Lambda function */
     lambdaFunction;
+    /** The IAM user created for invoking the Lambda function */
     lambdaIamUser;
+    /** The IAM access key for the Lambda IAM user */
     lambdaUserAccessKey;
+    /** The Secrets Manager secret storing the IAM access key credentials */
     lambdaUserAccessSecret;
+    /** The VPC for the Lambda function */
     lambdaVpc;
+    /** The security groups for the Lambda function */
     lambdaSecurityGroups;
+    /** The EFS access point for the Lambda function */
     lambdaAccessPoint;
+    /** The EFS mount path for the Lambda function */
     lambdaMountPath;
+    /** The VPC subnet selection for the Lambda function */
     lambdaVpcSubnets;
+    /**
+     * @summary Create a new LambdaWithIamAccess construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the Lambda with IAM access properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

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

@@ -2,21 +2,39 @@ 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';
+/**
+ * Properties for configuring a {@link LambdaWithIamAccess} construct
+ */
 /** @category Interface */
 export interface LambdaWithIamAccessProps extends CommonStackProps {
+    /** Whether to enable AppConfig integration for the Lambda function */
     configEnabled?: boolean;
+    /** The Lambda function configuration */
     lambda: LambdaProps;
+    /** The Lambda handler entry point (defaults to 'index.handler') */
     lambdaHandler?: string;
+    /** The Lambda Insights layer version for enhanced monitoring */
     lambdaInsightsVersion?: LambdaInsightsVersion;
+    /** The source code assets for Lambda layers */
     lambdaLayerSources: AssetCode[];
+    /** The Secrets Manager secret configuration for storing IAM credentials */
     lambdaSecret: SecretProps;
+    /** The Lambda function source code asset */
     lambdaSource: AssetCode;
+    /** The application log level */
     logLevel: string;
+    /** The Node.js environment (e.g. development, production) */
     nodeEnv: string;
+    /** CloudFormation export name for an existing security group */
     securityGroupExportName?: string;
+    /** The timezone for the application */
     timezone: string;
+    /** Name of an existing VPC to look up */
     vpcName?: string;
 }
+/**
+ * Environment variables for the {@link LambdaWithIamAccess} Lambda function
+ */
 /** @category Interface */
 export interface LambdaWithIamAccessEnvironment extends LambdaEnvironment {
 }

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

@@ -19,9 +19,18 @@ import { PipedEventHandlerProps } from './types.js';
  * @category Construct
  */
 export declare class PipedEventHandler extends EventHandler {
+    /** The piped event handler properties */
     props: PipedEventHandlerProps;
+    /** The dead-letter queue for failed piped messages */
     pipedDlq: IQueue;
+    /** The SQS queue used as the event pipe source */
     pipedQueue: IQueue;
+    /**
+     * @summary Create a new PipedEventHandler construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the piped event handler properties
+     */
     protected constructor(parent: Construct, id: string, props: PipedEventHandlerProps);
     /**
      * @summary Initialise and provision resources

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

@@ -18,9 +18,18 @@ import { EventHandler } from '../event-handler/index.js';
  * @category Construct
  */
 export class PipedEventHandler extends EventHandler {
+    /** The piped event handler properties */
     props;
+    /** The dead-letter queue for failed piped messages */
     pipedDlq;
+    /** The SQS queue used as the event pipe source */
     pipedQueue;
+    /**
+     * @summary Create a new PipedEventHandler construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the piped event handler properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

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

@@ -1,10 +1,17 @@
 import { QueueProps } from 'aws-cdk-lib/aws-sqs';
 import { SqsToLambdaPipeProps, SqsToSfnPipeProps } from '../../services/index.js';
 import { EventHandlerProps } from '../event-handler/index.js';
+/**
+ * Properties for configuring a {@link PipedEventHandler} construct
+ */
 /** @category Interface */
 export interface PipedEventHandlerProps extends EventHandlerProps {
+    /** Configuration for the dead-letter queue used by the piped queue */
     pipedDlq: QueueProps;
+    /** Configuration for the SQS queue used as the event pipe source */
     pipedQueue: QueueProps;
+    /** Configuration for the SQS-to-Lambda EventBridge pipe */
     sqsToLambdaPipe: SqsToLambdaPipeProps;
+    /** Configuration for the SQS-to-Step-Functions EventBridge pipe */
     sqsToSfnPipe: SqsToSfnPipeProps;
 }

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

@@ -26,19 +26,38 @@ import { RestApiLambdaEnvironment, RestApiLambdaProps } from './types.js';
  * @category Construct
  */
 export declare abstract class RestApiLambda extends CommonConstruct {
+    /** The REST API Lambda properties */
     props: RestApiLambdaProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets: ISecret[];
+    /** The IAM policy for the REST API Lambda function */
     restApiLambdaPolicy: PolicyDocument;
+    /** The IAM role for the REST API Lambda function */
     restApiLambdaRole: Role;
+    /** The environment variables for the REST API Lambda function */
     restApiLambdaEnvironment: RestApiLambdaEnvironment;
+    /** The Lambda layers attached to the REST API function */
     restApiLambdaLayers: ILayerVersion[];
+    /** The REST API Lambda function */
     restApiLambdaFunction: IFunction;
+    /** The API Gateway REST API */
     restApi: RestApi;
+    /** The Route53 hosted zone for the API domain */
     restApiHostedZone: IHostedZone;
+    /** The SSL/TLS certificate for the API custom domain */
     restApiCertificate: ICertificate;
+    /** The API Gateway custom domain */
     restApiDomain: DomainName;
+    /** The base path mappings for the API custom domain */
     restApiBasePathMappings: BasePathMapping[];
+    /**
+     * @summary Create a new RestApiLambda construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the REST API Lambda properties
+     */
     protected constructor(parent: Construct, id: string, props: RestApiLambdaProps);
     /**
      * @summary Initialise and provision resources
@@ -81,6 +100,10 @@ export declare abstract class RestApiLambda extends CommonConstruct {
      * @summary Method to create rest restApiLambda for RestApi
      */
     protected createRestApi(): void;
+    /**
+     * @summary Abstract method to create REST API resources (routes, methods, integrations)
+     * Must be implemented by subclasses to define the API structure
+     */
     protected abstract createRestApiResources(): void;
     /**
      * @summary Method to create custom restApiLambda domain for RestApi

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

@@ -21,21 +21,38 @@ import { CommonConstruct } from '../../common/index.js';
  * @category Construct
  */
 export class RestApiLambda extends CommonConstruct {
-    /* restApiLambda props */
+    /** The REST API Lambda properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* restApiLambda resources */
+    /** The resolved application secrets from SecretsManager */
     applicationSecrets;
+    /** The IAM policy for the REST API Lambda function */
     restApiLambdaPolicy;
+    /** The IAM role for the REST API Lambda function */
     restApiLambdaRole;
+    /** The environment variables for the REST API Lambda function */
     restApiLambdaEnvironment;
+    /** The Lambda layers attached to the REST API function */
     restApiLambdaLayers = [];
+    /** The REST API Lambda function */
     restApiLambdaFunction;
+    /** The API Gateway REST API */
     restApi;
+    /** The Route53 hosted zone for the API domain */
     restApiHostedZone;
+    /** The SSL/TLS certificate for the API custom domain */
     restApiCertificate;
+    /** The API Gateway custom domain */
     restApiDomain;
+    /** The base path mappings for the API custom domain */
     restApiBasePathMappings = [];
+    /**
+     * @summary Create a new RestApiLambda construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the REST API Lambda properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

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

@@ -2,24 +2,38 @@ import { AssetCode } from 'aws-cdk-lib/aws-lambda';
 import { AcmProps, LambdaEnvironment, LambdaProps, LambdaRestApiProps } from '../../services/index.js';
 import { CommonStackProps } from '../../common/index.js';
 /**
+ * Environment variables for the {@link RestApiLambda} Lambda function
  */
 /** @category Interface */
 export interface RestApiLambdaEnvironment extends LambdaEnvironment {
 }
 /**
+ * Properties for configuring a {@link RestApiLambda} construct
  */
 /** @category Interface */
 export interface RestApiLambdaProps extends CommonStackProps {
+    /** 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 API Gateway REST API configuration */
     restApi: LambdaRestApiProps;
+    /** The SSL/TLS certificate configuration */
     restApiCertificate: AcmProps;
+    /** The Lambda handler entry point */
     restApiHandler: string;
+    /** The Lambda function configuration */
     restApiLambda: LambdaProps;
+    /** The source code assets for Lambda layers */
     restApiLambdaLayerSources?: AssetCode[];
+    /** The Lambda function source code asset */
     restApiSource: AssetCode;
+    /** 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/rest-api-lambda-with-cache/main.d.ts

@@ -22,12 +22,24 @@ import { RestApiLambdaWithCacheProps } from './types.js';
  * @category Construct
  */
 export declare abstract class RestApiLambdaWithCache extends RestApiLambda {
+    /** The REST API Lambda with cache properties */
     props: RestApiLambdaWithCacheProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The VPC for the Lambda function and ElastiCache cluster */
     restApivpc: IVpc;
+    /** The ElastiCache replication group */
     restApiCache: CfnReplicationGroup;
+    /** The security group shared by the Lambda function and ElastiCache cluster */
     restApiSecurityGroup: ISecurityGroup;
+    /** The CloudFormation export name for the security group */
     restApiSecurityGroupExportName: string;
+    /**
+     * @summary Create a new RestApiLambdaWithCache construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the REST API Lambda with cache properties
+     */
     protected constructor(parent: Construct, id: string, props: RestApiLambdaWithCacheProps);
     /**
      * @summary Initialise and provision resources

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

@@ -23,14 +23,24 @@ import { RestApiLambda } from '../rest-api-lambda/index.js';
  * @category Construct
  */
 export class RestApiLambdaWithCache extends RestApiLambda {
-    /* restApiLambdaWithCache props */
+    /** The REST API Lambda with cache properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* restApiLambda resources */
+    /** The VPC for the Lambda function and ElastiCache cluster */
     restApivpc;
+    /** The ElastiCache replication group */
     restApiCache;
+    /** The security group shared by the Lambda function and ElastiCache cluster */
     restApiSecurityGroup;
+    /** The CloudFormation export name for the security group */
     restApiSecurityGroupExportName;
+    /**
+     * @summary Create a new RestApiLambdaWithCache construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the REST API Lambda with cache properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

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

@@ -1,12 +1,18 @@
 import { RestApiLambdaProps } from '../rest-api-lambda/index.js';
 import { ReplicatedElastiCacheProps, VpcProps } from '../../services/index.js';
 /**
+ * Properties for configuring a {@link RestApiLambdaWithCache} construct
  */
 /** @category Interface */
 export interface RestApiLambdaWithCacheProps extends RestApiLambdaProps {
+    /** The ElastiCache replication group configuration */
     restApiCache: ReplicatedElastiCacheProps;
+    /** The VPC configuration for the Lambda function and cache */
     restApiVpc: VpcProps;
+    /** CloudFormation export name for an existing security group */
     securityGroupExportName: string;
+    /** Whether to look up an existing VPC instead of creating one */
     useExistingVpc: boolean;
+    /** Name of an existing VPC to look up */
     vpcName?: string;
 }

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

@@ -1,5 +1,10 @@
+/**
+ * Enum for distinguishing between origin and static response header policy types
+ */
 /** @category Enum */
 export declare enum SiteResponseHeaderPolicyType {
+    /** Policy applied to the origin behaviour */
     ORIGIN = "origin",
+    /** Policy applied to the static asset behaviour */
     STATIC = "static"
 }

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

@@ -1,6 +1,11 @@
+/**
+ * Enum for distinguishing between origin and static response header policy types
+ */
 /** @category Enum */
 export var SiteResponseHeaderPolicyType;
 (function (SiteResponseHeaderPolicyType) {
+    /** Policy applied to the origin behaviour */
     SiteResponseHeaderPolicyType["ORIGIN"] = "origin";
+    /** Policy applied to the static asset behaviour */
     SiteResponseHeaderPolicyType["STATIC"] = "static";
 })(SiteResponseHeaderPolicyType || (SiteResponseHeaderPolicyType = {}));

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

@@ -29,39 +29,76 @@ import { SiteCachePolicyProps, SiteResponseHeadersPolicyProps, SiteWithEcsBacken
  * @category Construct
  */
 export declare class SiteWithEcsBackend extends CommonConstruct {
+    /** The site with ECS backend properties */
     props: SiteWithEcsBackendProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The Route53 hosted zone for the site domain */
     siteHostedZone: IHostedZone;
+    /** The global (edge) SSL/TLS certificate */
     siteCertificate: ICertificate;
+    /** The regional SSL/TLS certificate */
     siteRegionalCertificate: ICertificate;
+    /** The IAM policy for the ECS task execution role */
     siteEcsPolicy: PolicyDocument;
+    /** The IAM role for the ECS task execution */
     siteEcsRole: Role;
+    /** The environment variables passed to the ECS container */
     siteEcsEnvironment: {
         [key: string]: string;
     };
+    /** The VPC for the ECS cluster */
     siteVpc: IVpc;
+    /** The resolved secrets from SecretsManager */
     siteSecrets: any;
+    /** The ECS cluster */
     siteEcsCluster: Cluster;
+    /** The CloudWatch log group for ECS task logs */
     siteEcsLogGroup: LogGroup;
+    /** Docker build arguments for the ECS container image */
     siteEcsBuildArgs: any;
+    /** The Docker container image for the ECS task */
     siteEcsContainerImage: AssetImage;
+    /** The ECS Fargate service */
     siteEcsService: FargateService;
+    /** The ECS Fargate task definition */
     siteEcsTaskDefinition: FargateTaskDefinition;
+    /** The Application Load Balancer listener */
     siteEcsListener: ApplicationListener;
+    /** The Application Load Balancer */
     siteEcsLoadBalancer: ApplicationLoadBalancer;
+    /** The ALB target group */
     siteEcsTargetGroup: ApplicationTargetGroup;
+    /** The EFS file system for persistent storage */
     siteFileSystem: FileSystem;
+    /** The S3 bucket used for ALB and CloudFront access logs */
     siteLogBucket: IBucket;
+    /** The HTTP origin pointing to the ECS backend */
     siteOrigin: HttpOrigin;
+    /** The CloudFront distribution for the site */
     siteDistribution: Distribution;
+    /** The internal domain name used by the ECS load balancer */
     siteInternalDomainName: string;
+    /** The external domain name exposed to end users via CloudFront */
     siteExternalDomainName: string;
+    /** The list of domain names associated with the CloudFront distribution */
     siteDomainNames: string[];
+    /** The CloudFront function attached to the distribution */
     siteCloudfrontFunction: IFunction;
+    /** The CloudFront function associations for the distribution behaviours */
     siteFunctionAssociations: FunctionAssociation[];
+    /** The CloudFront origin request policy */
     siteOriginRequestPolicy: OriginRequestPolicy;
+    /** The CloudFront response headers policy */
     siteOriginResponseHeadersPolicy?: ResponseHeadersPolicy;
+    /** The CloudFront cache policy */
     siteCachePolicy: CachePolicy;
+    /**
+     * @summary Create a new SiteWithEcsBackend construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the site with ECS backend properties
+     */
     constructor(parent: Construct, id: string, props: SiteWithEcsBackendProps);
     /**
      * @summary Initialise and provision resources

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

@@ -23,39 +23,74 @@ import { CommonConstruct } from '../../common/index.js';
  * @category Construct
  */
 export class SiteWithEcsBackend extends CommonConstruct {
-    /* site properties */
+    /** The site with ECS backend properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* site resources */
+    /** The Route53 hosted zone for the site domain */
     siteHostedZone;
+    /** The global (edge) SSL/TLS certificate */
     siteCertificate;
+    /** The regional SSL/TLS certificate */
     siteRegionalCertificate;
+    /** The IAM policy for the ECS task execution role */
     siteEcsPolicy;
+    /** The IAM role for the ECS task execution */
     siteEcsRole;
+    /** The environment variables passed to the ECS container */
     siteEcsEnvironment;
+    /** The VPC for the ECS cluster */
     siteVpc;
+    /** The resolved secrets from SecretsManager */
     siteSecrets;
+    /** The ECS cluster */
     siteEcsCluster;
+    /** The CloudWatch log group for ECS task logs */
     siteEcsLogGroup;
+    /** Docker build arguments for the ECS container image */
     siteEcsBuildArgs = {};
+    /** The Docker container image for the ECS task */
     siteEcsContainerImage;
+    /** The ECS Fargate service */
     siteEcsService;
+    /** The ECS Fargate task definition */
     siteEcsTaskDefinition;
+    /** The Application Load Balancer listener */
     siteEcsListener;
+    /** The Application Load Balancer */
     siteEcsLoadBalancer;
+    /** The ALB target group */
     siteEcsTargetGroup;
+    /** The EFS file system for persistent storage */
     siteFileSystem;
+    /** The S3 bucket used for ALB and CloudFront access logs */
     siteLogBucket;
+    /** The HTTP origin pointing to the ECS backend */
     siteOrigin;
+    /** The CloudFront distribution for the site */
     siteDistribution;
+    /** The internal domain name used by the ECS load balancer */
     siteInternalDomainName;
+    /** The external domain name exposed to end users via CloudFront */
     siteExternalDomainName;
+    /** The list of domain names associated with the CloudFront distribution */
     siteDomainNames;
+    /** The CloudFront function attached to the distribution */
     siteCloudfrontFunction;
+    /** The CloudFront function associations for the distribution behaviours */
     siteFunctionAssociations;
+    /** The CloudFront origin request policy */
     siteOriginRequestPolicy;
+    /** The CloudFront response headers policy */
     siteOriginResponseHeadersPolicy;
+    /** The CloudFront cache policy */
     siteCachePolicy;
+    /**
+     * @summary Create a new SiteWithEcsBackend construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the site with ECS backend properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;