@gradientedge/cdk-utils-aws 2.4.1 → 2.6.0

package/dist/src/services/api-gateway/main.js

@@ -26,7 +26,7 @@ export class ApiManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props lambda rest restApi props
-     * @param lambdaFunction
+     * @param lambdaFunction the Lambda function to use as the backend handler
      */
     createLambdaRestApi(id, scope, props, lambdaFunction) {
         if (!props)
@@ -86,22 +86,22 @@ export class ApiManager {
         return apiDomain;
     }
     /**
-     * @summary Method to create an API gateway resource
-     * @param id
-     * @param scope
-     * @param parent
-     * @param path
-     * @param integration
-     * @param addProxy
-     * @param authorizer
-     * @param allowedOrigins
-     * @param allowedMethods
-     * @param allowedHeaders
-     * @param methodRequestParameters
-     * @param proxyIntegration
-     * @param enableDefaultCors
-     * @param mockIntegration
-     * @param mockMethodResponses
+     * @summary Method to create an API gateway resource with methods, optional CORS, and optional proxy sub-resource
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param parent the parent API resource to attach this resource to
+     * @param path the URL path segment for this resource
+     * @param integration the backend integration for methods on this resource
+     * @param addProxy whether to create a greedy proxy child resource ({path+})
+     * @param authorizer optional authorizer for the methods
+     * @param allowedOrigins optional CORS allowed origins (defaults to all origins)
+     * @param allowedMethods optional CORS allowed methods (defaults to all methods)
+     * @param allowedHeaders optional CORS allowed headers (defaults to default headers)
+     * @param methodRequestParameters optional request parameter mappings for methods
+     * @param proxyIntegration optional alternative integration for the proxy resource
+     * @param enableDefaultCors set to false to disable automatic CORS preflight configuration
+     * @param mockIntegration optional mock integration for OPTIONS when CORS is disabled
+     * @param mockMethodResponses optional method responses for the mock OPTIONS integration
      */
     createApiResource(id, scope, parent, path, integration, addProxy, authorizer, allowedOrigins, allowedMethods, allowedHeaders, methodRequestParameters, proxyIntegration, enableDefaultCors, mockIntegration, mockMethodResponses) {
         const methods = allowedMethods ?? Cors.ALL_METHODS;
@@ -167,9 +167,9 @@ export class ApiManager {
     }
     /**
      * @summary Method to create an api deployment
-     * @param id
-     * @param scope
-     * @param api
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param api the REST API to create a deployment for
      */
     createApiDeployment(id, scope, api) {
         new Deployment(scope, `${id}`, {

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

@@ -1,12 +1,19 @@
 import { LambdaRestApiProps as LambdaRestApigProps, RestApiProps } from 'aws-cdk-lib/aws-apigateway';
 import { TagProps } from '../../types/index.js';
 /**
+ * Props for creating a Lambda-backed REST API with additional configuration options.
+ * @see {@link ApiManager.createLambdaRestApi}
  */
 /** @category Interface */
 export interface LambdaRestApiProps extends LambdaRestApigProps {
+    /** Optional tags to apply to the REST API resource */
     tags?: TagProps[];
+    /** Minimum response payload size (in bytes) to be compressed */
     minCompressionSizeInBytes?: number;
 }
+/**
+ * Props for creating a REST API.
+ */
 /** @category Interface */
 export interface RestApigProps extends RestApiProps {
 }

package/dist/src/services/appconfig/constants.d.ts

@@ -1,12 +1,12 @@
 /**
- * @returns { Map<string, string> } AppConfig extension ARN by region for x84
+ * Mapping of AWS region to AppConfig extension Lambda layer ARN for x86_64 architecture.
  */
 /** @category Constant */
 export declare const ArnsByRegionForX86_64: {
     [region: string]: string;
 };
 /**
- * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
+ * Mapping of AWS region to AppConfig extension Lambda layer ARN for ARM64 architecture.
  */
 /** @category Constant */
 export declare const ArnsByRegionForArm64: {

package/dist/src/services/appconfig/constants.js

@@ -1,5 +1,5 @@
 /**
- * @returns { Map<string, string> } AppConfig extension ARN by region for x84
+ * Mapping of AWS region to AppConfig extension Lambda layer ARN for x86_64 architecture.
  */
 /** @category Constant */
 export const ArnsByRegionForX86_64 = {
@@ -36,7 +36,7 @@ export const ArnsByRegionForX86_64 = {
     'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension:223',
 };
 /**
- * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
+ * Mapping of AWS region to AppConfig extension Lambda layer ARN for ARM64 architecture.
  */
 /** @category Constant */
 export const ArnsByRegionForArm64 = {

package/dist/src/services/appconfig/main.d.ts

@@ -3,7 +3,7 @@ import { CommonConstruct } from '../../common/index.js';
 import { Architecture } from '../constants.js';
 import { AppConfigProps } from './types.js';
 /**
- * Provides operations on AWS
+ * Provides operations on AWS AppConfig.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -30,7 +30,7 @@ export declare class AppConfigManager {
      * @summary Method to create an AppConfig Application
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig application
      */
     createApplication(id: string, scope: CommonConstruct, props: AppConfigProps): CfnApplication;
@@ -39,7 +39,7 @@ export declare class AppConfigManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param applicationId id of the application
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig environment
      */
     createEnvironment(id: string, scope: CommonConstruct, applicationId: string, props: AppConfigProps): CfnEnvironment;
@@ -49,7 +49,7 @@ export declare class AppConfigManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param applicationId id of the application
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig configuration profile
      */
     createConfigurationProfile(id: string, scope: CommonConstruct, applicationId: string, props: AppConfigProps): CfnConfigurationProfile;
@@ -57,7 +57,7 @@ export declare class AppConfigManager {
      * @summary Method to create an AppConfig Deployment Strategy
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig deployment strategy
      */
     createDeploymentStrategy(id: string, scope: CommonConstruct, props: AppConfigProps): DeploymentStrategy;

package/dist/src/services/appconfig/main.js

@@ -4,7 +4,7 @@ import { createCfnOutput } from '../../utils/index.js';
 import { Architecture } from '../constants.js';
 import { ArnsByRegionForArm64, ArnsByRegionForX86_64 } from './constants.js';
 /**
- * Provides operations on AWS
+ * Provides operations on AWS AppConfig.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -40,7 +40,7 @@ export class AppConfigManager {
      * @summary Method to create an AppConfig Application
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig application
      */
     createApplication(id, scope, props) {
@@ -59,7 +59,7 @@ export class AppConfigManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param applicationId id of the application
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig environment
      */
     createEnvironment(id, scope, applicationId, props) {
@@ -80,7 +80,7 @@ export class AppConfigManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param applicationId id of the application
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig configuration profile
      */
     createConfigurationProfile(id, scope, applicationId, props) {
@@ -100,7 +100,7 @@ export class AppConfigManager {
      * @summary Method to create an AppConfig Deployment Strategy
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the AppConfig configuration properties
      * @returns the appconfig deployment strategy
      */
     createDeploymentStrategy(id, scope, props) {

package/dist/src/services/appconfig/types.d.ts

@@ -1,19 +1,29 @@
 import { CfnApplicationProps, CfnConfigurationProfileProps, CfnDeploymentProps, CfnEnvironmentProps, DeploymentStrategyProps } from 'aws-cdk-lib/aws-appconfig';
 /**
- *
+ * Props for an AppConfig deployment strategy with an optional ARN reference.
+ * @see {@link AppConfigManager.createDeploymentStrategy}
  */
 /** @category Interface */
 export interface AppConfigDeploymentStrategyProps extends DeploymentStrategyProps {
+    /** The ARN of the deployment strategy */
     deploymentStrategyArn?: string;
 }
 /**
+ * Props for configuring an AppConfig application and its associated resources.
+ * @see {@link AppConfigManager}
  */
 /** @category Interface */
 export interface AppConfigProps {
+    /** Configuration for the AppConfig application */
     application: CfnApplicationProps;
+    /** Configuration for the AppConfig configuration profile */
     configurationProfile: CfnConfigurationProfileProps;
+    /** Configuration for the AppConfig deployment */
     deployment: CfnDeploymentProps;
+    /** Configuration for the AppConfig deployment strategy */
     deploymentStrategy: AppConfigDeploymentStrategyProps;
+    /** Configuration for the AppConfig environment */
     environment: CfnEnvironmentProps;
+    /** Unique identifier for the AppConfig resource set */
     id: string;
 }

package/dist/src/services/certificate-manager/types.d.ts

@@ -1,12 +1,20 @@
 import { CertificateProps } from 'aws-cdk-lib/aws-certificatemanager';
 /**
+ * Props for creating or importing an ACM certificate.
+ * @see {@link AcmManager.resolveCertificate}
  */
 /** @category Interface */
 export interface AcmProps extends CertificateProps {
+    /** The AWS account ID where the certificate resides */
     certificateAccount?: string;
+    /** The full ARN of an existing certificate to import */
     certificateArn?: string;
+    /** The certificate ID used to construct an ARN when certificateArn is not provided */
     certificateId?: string;
+    /** The AWS region where the certificate resides */
     certificateRegion?: string;
+    /** The SSM parameter name storing the certificate reference */
     certificateSsmName?: string;
+    /** Whether to import an existing certificate instead of creating a new one */
     useExistingCertificate: boolean;
 }

package/dist/src/services/cloudfront/main.d.ts

@@ -11,7 +11,7 @@ import { CommonConstruct } from '../../common/index.js';
 import { LambdaEdgeProps } from '../lambda/index.js';
 import { CloudfrontFunctionProps, DistributionProps } from './types.js';
 /**
- * Provides operations on AWS
+ * Provides operations on AWS CloudFront.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -47,12 +47,12 @@ export declare class CloudFrontManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props distribution properties
-     * @param siteBucket
-     * @param logBucket
-     * @param oai
-     * @param certificate
-     * @param aliases
-     * @param defaultFunctionAssociations
+     * @param siteBucket the S3 bucket serving as the origin
+     * @param logBucket optional S3 bucket for access logs
+     * @param oai optional Origin Access Identity for S3 access
+     * @param certificate optional ACM certificate for custom domain HTTPS
+     * @param aliases optional custom domain names for the distribution
+     * @param defaultFunctionAssociations optional CloudFront function associations for the default behavior
      */
     createDistributionWithS3Origin(id: string, scope: CommonConstruct, props: DistributionProps, siteBucket: IBucket, logBucket?: IBucket, oai?: OriginAccessIdentity, certificate?: ICertificate, aliases?: string[], defaultFunctionAssociations?: FunctionAssociation[]): cf.Distribution;
     /**
@@ -60,12 +60,12 @@ export declare class CloudFrontManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props distribution properties
-     * @param origin
-     * @param domainNames
-     * @param logBucket
-     * @param certificate
-     * @param defaultFunctionAssociations
-     * @param responseHeadersPolicy
+     * @param origin the HTTP origin for the distribution
+     * @param domainNames the custom domain names for the distribution
+     * @param logBucket optional S3 bucket for access logs
+     * @param certificate optional ACM certificate for custom domain HTTPS
+     * @param defaultFunctionAssociations optional CloudFront function associations for the default behavior
+     * @param responseHeadersPolicy optional response headers policy for the default behavior
      */
     createDistributionWithHttpOrigin(id: string, scope: CommonConstruct, props: DistributionProps, origin: HttpOrigin, domainNames: string[], logBucket?: IBucket, certificate?: ICertificate, defaultFunctionAssociations?: FunctionAssociation[], responseHeadersPolicy?: IResponseHeadersPolicyRef): cf.Distribution;
     /**
@@ -73,30 +73,30 @@ export declare class CloudFrontManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props lambda@edge properties
-     * @param layers
-     * @param code
-     * @param role
-     * @param environment
-     * @param vpc
-     * @param securityGroups
-     * @param accessPoint
-     * @param mountPath
+     * @param layers the Lambda layers to attach to the function
+     * @param code the asset code bundle for the function
+     * @param role the IAM role for the function execution
+     * @param environment optional environment variables for the function
+     * @param vpc optional VPC to deploy the function into
+     * @param securityGroups optional security groups for VPC-connected functions
+     * @param accessPoint optional EFS access point for filesystem mounting
+     * @param mountPath optional mount path for the EFS filesystem (defaults to /mnt/msg)
      */
     createEdgeFunction(id: string, scope: CommonConstruct, props: LambdaEdgeProps, layers: ILayerVersion[], code: AssetCode, role: Role, environment?: any, vpc?: IVpc, securityGroups?: ISecurityGroup[], accessPoint?: IAccessPoint, mountPath?: string): cf.experimental.EdgeFunction;
     /**
-     *
-     * @param id
-     * @param scope
-     * @param dockerFilePath
-     * @param distributionId
-     * @param paths
+     * @summary Method to trigger a CloudFront cache invalidation via a CodeBuild project
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param dockerFilePath the path to the Dockerfile for the CodeBuild project
+     * @param distributionId the CloudFront distribution ID to invalidate
+     * @param paths optional invalidation paths (defaults to /*)
      */
     invalidateCache(id: string, scope: CommonConstruct, dockerFilePath: string, distributionId: string, paths?: string): void;
     /**
      * @summary Method to provision a Cloudfront function
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the CloudFront function properties
      */
     createCloudfrontFunction(id: string, scope: CommonConstruct, props: CloudfrontFunctionProps): cf.Function;
     /**

package/dist/src/services/cloudfront/main.js

@@ -8,7 +8,7 @@ import _ from 'lodash';
 import { CommonStack } from '../../common/index.js';
 import { createCfnOutput } from '../../utils/index.js';
 /**
- * Provides operations on AWS
+ * Provides operations on AWS CloudFront.
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
@@ -51,12 +51,12 @@ export class CloudFrontManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props distribution properties
-     * @param siteBucket
-     * @param logBucket
-     * @param oai
-     * @param certificate
-     * @param aliases
-     * @param defaultFunctionAssociations
+     * @param siteBucket the S3 bucket serving as the origin
+     * @param logBucket optional S3 bucket for access logs
+     * @param oai optional Origin Access Identity for S3 access
+     * @param certificate optional ACM certificate for custom domain HTTPS
+     * @param aliases optional custom domain names for the distribution
+     * @param defaultFunctionAssociations optional CloudFront function associations for the default behavior
      */
     createDistributionWithS3Origin(id, scope, props, siteBucket, logBucket, oai, certificate, aliases, defaultFunctionAssociations) {
         const distribution = new Distribution(scope, `${id}`, {
@@ -92,12 +92,12 @@ export class CloudFrontManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props distribution properties
-     * @param origin
-     * @param domainNames
-     * @param logBucket
-     * @param certificate
-     * @param defaultFunctionAssociations
-     * @param responseHeadersPolicy
+     * @param origin the HTTP origin for the distribution
+     * @param domainNames the custom domain names for the distribution
+     * @param logBucket optional S3 bucket for access logs
+     * @param certificate optional ACM certificate for custom domain HTTPS
+     * @param defaultFunctionAssociations optional CloudFront function associations for the default behavior
+     * @param responseHeadersPolicy optional response headers policy for the default behavior
      */
     createDistributionWithHttpOrigin(id, scope, props, origin, domainNames, logBucket, certificate, defaultFunctionAssociations, responseHeadersPolicy) {
         const distribution = new Distribution(scope, `${id}`, {
@@ -142,14 +142,14 @@ export class CloudFrontManager {
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param props lambda@edge properties
-     * @param layers
-     * @param code
-     * @param role
-     * @param environment
-     * @param vpc
-     * @param securityGroups
-     * @param accessPoint
-     * @param mountPath
+     * @param layers the Lambda layers to attach to the function
+     * @param code the asset code bundle for the function
+     * @param role the IAM role for the function execution
+     * @param environment optional environment variables for the function
+     * @param vpc optional VPC to deploy the function into
+     * @param securityGroups optional security groups for VPC-connected functions
+     * @param accessPoint optional EFS access point for filesystem mounting
+     * @param mountPath optional mount path for the EFS filesystem (defaults to /mnt/msg)
      */
     createEdgeFunction(id, scope, props, layers, code, role, environment, vpc, securityGroups, accessPoint, mountPath) {
         if (!props)
@@ -192,12 +192,12 @@ export class CloudFrontManager {
         return edgeFunction;
     }
     /**
-     *
-     * @param id
-     * @param scope
-     * @param dockerFilePath
-     * @param distributionId
-     * @param paths
+     * @summary Method to trigger a CloudFront cache invalidation via a CodeBuild project
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param dockerFilePath the path to the Dockerfile for the CodeBuild project
+     * @param distributionId the CloudFront distribution ID to invalidate
+     * @param paths optional invalidation paths (defaults to /*)
      */
     invalidateCache(id, scope, dockerFilePath, distributionId, paths) {
         new AwsCustomResource(scope, `${id}-trigger-codebuild-${new Date().getTime()}`, {
@@ -216,7 +216,7 @@ export class CloudFrontManager {
      * @summary Method to provision a Cloudfront function
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the CloudFront function properties
      */
     createCloudfrontFunction(id, scope, props) {
         if (!props)

package/dist/src/services/cloudfront/types.d.ts

@@ -1,15 +1,23 @@
 import { DistributionProps as CfDistributionProps, FunctionProps } from 'aws-cdk-lib/aws-cloudfront';
 import { TagProps } from '../../types/index.js';
 /**
+ * Props for creating a CloudFront distribution with optional tags.
+ * @see {@link CloudFrontManager.createDistributionWithS3Origin}
+ * @see {@link CloudFrontManager.createDistributionWithHttpOrigin}
  */
 /** @category Interface */
 export interface DistributionProps extends CfDistributionProps {
+    /** Optional tags to apply to the distribution */
     tags?: TagProps[];
 }
 /**
+ * Props for creating a CloudFront function.
+ * @see {@link CloudFrontManager.createCloudfrontFunction}
  */
 /** @category Interface */
 export interface CloudfrontFunctionProps extends FunctionProps {
+    /** The CloudFront event type that triggers the function (e.g. viewer-request, viewer-response) */
     eventType: string;
+    /** The file path to the CloudFront function source code */
     functionFilePath: string;
 }

package/dist/src/services/cloudwatch/logs.d.ts

@@ -24,8 +24,8 @@ export declare class LogManager {
      * @summary Method to create a cloudwatch metric filter
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param logGroup
+     * @param props the metric filter properties
+     * @param logGroup the log group to apply the metric filter to
      */
     createMetricFilter(id: string, scope: CommonConstruct, props: MetricFilterProps, logGroup: logs.ILogGroup): {
         metric: cdk.aws_cloudwatch.Metric;
@@ -35,14 +35,14 @@ export declare class LogManager {
      * @summary Method to create a cloudwatch log group (cfn)
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the log group properties
      */
     createCfnLogGroup(id: string, scope: CommonConstruct, props: LogProps): cdk.aws_logs.CfnLogGroup;
     /**
      * @summary Method to create a cloudwatch log group
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the log group properties
      */
     createLogGroup(id: string, scope: CommonConstruct, props: LogProps): cdk.aws_logs.LogGroup;
 }

package/dist/src/services/cloudwatch/logs.js

@@ -24,8 +24,8 @@ export class LogManager {
      * @summary Method to create a cloudwatch metric filter
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
-     * @param logGroup
+     * @param props the metric filter properties
+     * @param logGroup the log group to apply the metric filter to
      */
     createMetricFilter(id, scope, props, logGroup) {
         if (!props)
@@ -51,7 +51,7 @@ export class LogManager {
      * @summary Method to create a cloudwatch log group (cfn)
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the log group properties
      */
     createCfnLogGroup(id, scope, props) {
         if (!props)
@@ -75,7 +75,7 @@ export class LogManager {
      * @summary Method to create a cloudwatch log group
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
-     * @param props
+     * @param props the log group properties
      */
     createLogGroup(id, scope, props) {
         if (!props)