@gradientedge/cdk-utils-aws 2.5.0 → 2.6.0

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

@@ -4,51 +4,96 @@ import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, CloudfrontFunctionProps, DistributionProps, EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EfsAccessPointOptions, EfsFileSystemProps, HealthCheck, LogProps, S3BucketProps } from '../../services/index.js';
 import { SiteResponseHeaderPolicyType } from './constants.js';
 /**
+ * Properties for configuring a {@link SiteWithEcsBackend} construct
  */
 /** @category Interface */
 export interface SiteWithEcsBackendProps extends CommonStackProps {
+    /** The application log level */
     logLevel: string;
+    /** The Node.js environment (e.g. development, production) */
     nodeEnv: string;
+    /** Path to the Dockerfile used to invalidate the CloudFront cache after deployment */
     siteCacheInvalidationDockerFilePath?: string;
+    /** Configuration for the global (edge) SSL/TLS certificate */
     siteCertificate: AcmProps;
+    /** Configuration for a CloudFront function to attach to the distribution */
     siteCloudfrontFunctionProps?: CloudfrontFunctionProps;
+    /** Configuration for the ECS cluster */
     siteCluster: EcsClusterProps;
+    /** Configuration for the CloudFront distribution */
     siteDistribution: DistributionProps;
+    /** Path to the Docker image used for the ECS container */
     siteEcsContainerImagePath: string;
+    /** Optional EFS file system configuration for persistent storage */
     siteFileSystem?: EfsFileSystemProps;
+    /** Optional EFS access point configurations */
     siteFileSystemAccessPoints?: EfsAccessPointOptions[];
+    /** Path to the CloudFront function code file */
     siteFunctionFilePath?: string;
+    /** Health check configuration for the ALB target group */
     siteHealthCheck: HealthCheck;
+    /** Configuration for the ECS task log group */
     siteLog: LogProps;
+    /** Configuration for the S3 bucket used for access logs */
     siteLogBucket: S3BucketProps;
+    /** Configuration for the CloudFront cache policy */
     siteCachePolicy?: SiteCachePolicyProps;
+    /** Configuration for the CloudFront origin request policy */
     siteOriginRequestPolicy: OriginRequestPolicyProps;
+    /** Configuration for the CloudFront response headers policy */
     siteOriginResponseHeadersPolicy: SiteResponseHeadersPolicyProps;
+    /** The Route53 record name for the site */
     siteRecordName?: string;
+    /** Configuration for the regional SSL/TLS certificate */
     siteRegionalCertificate: AcmProps;
+    /** The subdomain for the site */
     siteSubDomain: string;
+    /** Configuration for the ECS Fargate task and service */
     siteTask: EcsApplicationLoadBalancedFargateServiceProps;
+    /** VPC configuration for the ECS cluster */
     siteVpc: VpcProps;
+    /** The timezone for the application */
     timezone: string;
+    /** Whether to look up an existing hosted zone instead of creating one */
     useExistingHostedZone: boolean;
+    /** Whether to look up an existing VPC instead of creating one */
     useExistingVpc: boolean;
 }
+/**
+ * Extended strict transport security options with duration specified in seconds
+ */
 /** @category Interface */
 export interface SiteResponseHeadersStrictTransportSecurity extends ResponseHeadersStrictTransportSecurity {
+    /** The max-age value for the Strict-Transport-Security header in seconds */
     accessControlMaxAgeInSeconds: number;
 }
+/**
+ * Extended security headers behaviour with strict transport security support
+ */
 /** @category Interface */
 export interface SiteSecurityHeadersBehavior extends ResponseSecurityHeadersBehavior {
+    /** Strict transport security configuration */
     strictTransportSecurity: SiteResponseHeadersStrictTransportSecurity;
 }
+/**
+ * Extended response headers policy properties with security headers and policy type
+ */
 /** @category Interface */
 export interface SiteResponseHeadersPolicyProps extends ResponseHeadersPolicyProps {
+    /** Security headers behaviour configuration */
     securityHeadersBehavior: SiteSecurityHeadersBehavior;
+    /** The policy type (origin or static) */
     type: SiteResponseHeaderPolicyType;
 }
+/**
+ * Extended cache policy properties with TTL values specified in seconds
+ */
 /** @category Interface */
 export interface SiteCachePolicyProps extends CachePolicyProps {
+    /** The default TTL for cached objects in seconds */
     defaultTtlInSeconds: number;
+    /** The minimum TTL for cached objects in seconds */
     minTtlInSeconds: number;
+    /** The maximum TTL for cached objects in seconds */
     maxTtlInSeconds: number;
 }

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

@@ -1,7 +1,15 @@
+/**
+ * Enum for distinguishing between origin and static response header policy types
+ */
 /** @category Enum */
 export declare enum SiteWithLambdaBackendResponseHeaderPolicyType {
+    /** Policy applied to the origin behaviour */
     ORIGIN = "origin",
+    /** Policy applied to the static asset behaviour */
     STATIC = "static"
 }
+/**
+ * The default alias name used when creating Lambda function URLs with alias support
+ */
 /** @category Constant */
 export declare const LAMBDA_ALIAS_NAME_CURRENT = "latest";

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

@@ -1,8 +1,16 @@
+/**
+ * Enum for distinguishing between origin and static response header policy types
+ */
 /** @category Enum */
 export var SiteWithLambdaBackendResponseHeaderPolicyType;
 (function (SiteWithLambdaBackendResponseHeaderPolicyType) {
+    /** Policy applied to the origin behaviour */
     SiteWithLambdaBackendResponseHeaderPolicyType["ORIGIN"] = "origin";
+    /** Policy applied to the static asset behaviour */
     SiteWithLambdaBackendResponseHeaderPolicyType["STATIC"] = "static";
 })(SiteWithLambdaBackendResponseHeaderPolicyType || (SiteWithLambdaBackendResponseHeaderPolicyType = {}));
+/**
+ * The default alias name used when creating Lambda function URLs with alias support
+ */
 /** @category Constant */
 export const LAMBDA_ALIAS_NAME_CURRENT = 'latest';

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

@@ -26,31 +26,62 @@ import { SiteWithLambdaBackendCachePolicyProps, SiteWithLambdaBackendProps, Site
  * @category Construct
  */
 export declare class SiteWithLambdaBackend extends CommonConstruct {
+    /** The site with lambda backend properties */
     props: SiteWithLambdaBackendProps;
+    /** 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 resolved secrets from SecretsManager */
     siteSecrets: any;
+    /** The S3 bucket used for CloudFront access logs */
     siteLogBucket: IBucket;
+    /** The HTTP origin backed by the Lambda function URL */
     siteOrigin: HttpOrigin;
+    /** The CloudFront distribution for the site */
     siteDistribution: Distribution;
+    /** The internal domain name used for Lambda function URL routing */
     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: CfIFunction;
+    /** 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;
+    /** The S3 bucket deployment for static assets */
     siteStaticAssetDeployment: BucketDeployment;
+    /** The IAM policy for the site Lambda function */
     siteLambdaPolicy: PolicyDocument;
+    /** The IAM role for the site Lambda function */
     siteLambdaRole: Role;
+    /** The environment variables for the site Lambda function */
     siteLambdaEnvironment: any;
+    /** The Lambda layers (including Web Adapter) for the site function */
     siteLambdaLayers: ILayerVersion[];
+    /** The Lambda application code asset */
     siteLambdaApplication: AssetCode;
+    /** The site Lambda function */
     siteLambdaFunction: IFunction;
+    /** The Lambda function URL used as the CloudFront origin */
     siteLambdaUrl: FunctionUrl;
+    /**
+     * @summary Create a new SiteWithLambdaBackend construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the site with lambda backend properties
+     */
     constructor(parent: Construct, id: string, props: SiteWithLambdaBackendProps);
     /**
      * @summary Initialise and provision resources

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

@@ -23,33 +23,62 @@ import { LAMBDA_ALIAS_NAME_CURRENT } from './constants.js';
  * @category Construct
  */
 export class SiteWithLambdaBackend extends CommonConstruct {
-    /* site properties */
+    /** The site with lambda 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 resolved secrets from SecretsManager */
     siteSecrets;
+    /** The S3 bucket used for CloudFront access logs */
     siteLogBucket;
+    /** The HTTP origin backed by the Lambda function URL */
     siteOrigin;
+    /** The CloudFront distribution for the site */
     siteDistribution;
+    /** The internal domain name used for Lambda function URL routing */
     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;
+    /** The S3 bucket deployment for static assets */
     siteStaticAssetDeployment;
+    /** The IAM policy for the site Lambda function */
     siteLambdaPolicy;
+    /** The IAM role for the site Lambda function */
     siteLambdaRole;
+    /** The environment variables for the site Lambda function */
     siteLambdaEnvironment;
+    /** The Lambda layers (including Web Adapter) for the site function */
     siteLambdaLayers;
+    /** The Lambda application code asset */
     siteLambdaApplication;
+    /** The site Lambda function */
     siteLambdaFunction;
+    /** The Lambda function URL used as the CloudFront origin */
     siteLambdaUrl;
+    /**
+     * @summary Create a new SiteWithLambdaBackend construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the site with lambda backend properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

package/dist/src/construct/site-with-lambda-backend/types.d.ts

@@ -3,48 +3,90 @@ import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, CloudfrontFunctionProps, DistributionProps, LambdaProps, LogProps, S3BucketProps } from '../../services/index.js';
 import { SiteWithLambdaBackendResponseHeaderPolicyType } from './constants.js';
 /**
+ * Properties for configuring a {@link SiteWithLambdaBackend} construct
  */
 /** @category Interface */
 export interface SiteWithLambdaBackendProps extends CommonStackProps {
+    /** The application log level */
     logLevel: string;
+    /** The Node.js environment (e.g. development, production) */
     nodeEnv: string;
+    /** Path to the Dockerfile used to invalidate the CloudFront cache after deployment */
     siteCacheInvalidationDockerFilePath?: string;
+    /** Configuration for the global (edge) SSL/TLS certificate */
     siteCertificate: AcmProps;
+    /** Configuration for a CloudFront function to attach to the distribution */
     siteCloudfrontFunctionProps?: CloudfrontFunctionProps;
+    /** Configuration for the CloudFront distribution */
     siteDistribution: DistributionProps;
+    /** Path to the Lambda Web Adapter exec wrapper */
     siteExecWrapperPath: string;
+    /** Path to the CloudFront function code file */
     siteFunctionFilePath?: string;
+    /** The health check endpoint used by the Lambda Web Adapter */
     siteHealthEndpoint: string;
+    /** Configuration for the site Lambda function */
     siteLambda: LambdaProps;
+    /** Configuration for the site log group */
     siteLog: LogProps;
+    /** Configuration for the S3 bucket used for access logs */
     siteLogBucket: S3BucketProps;
+    /** The port the application listens on inside the Lambda container */
     sitePort: string;
+    /** Configuration for the CloudFront cache policy */
     siteCachePolicy?: SiteWithLambdaBackendCachePolicyProps;
+    /** Configuration for the CloudFront origin request policy */
     siteOriginRequestPolicy: OriginRequestPolicyProps;
+    /** Configuration for the CloudFront response headers policy */
     siteOriginResponseHeadersPolicy: SiteWithLambdaBackendResponseHeadersPolicyProps;
+    /** The Route53 record name for the site */
     siteRecordName?: string;
+    /** Configuration for the regional SSL/TLS certificate */
     siteRegionalCertificate: AcmProps;
+    /** The subdomain for the site */
     siteSubDomain: string;
+    /** The timezone for the application */
     timezone: string;
+    /** Whether to look up an existing hosted zone instead of creating one */
     useExistingHostedZone: boolean;
+    /** Whether to look up an existing VPC instead of creating one */
     useExistingVpc: boolean;
 }
+/**
+ * Extended strict transport security options with duration specified in seconds
+ */
 /** @category Interface */
 export interface SiteWithLambdaBackendResponseHeadersStrictTransportSecurity extends ResponseHeadersStrictTransportSecurity {
+    /** The max-age value for the Strict-Transport-Security header in seconds */
     accessControlMaxAgeInSeconds: number;
 }
+/**
+ * Extended security headers behaviour with strict transport security support
+ */
 /** @category Interface */
 export interface SiteWithLambdaBackendSecurityHeadersBehavior extends ResponseSecurityHeadersBehavior {
+    /** Strict transport security configuration */
     strictTransportSecurity: SiteWithLambdaBackendResponseHeadersStrictTransportSecurity;
 }
+/**
+ * Extended response headers policy properties with security headers and policy type
+ */
 /** @category Interface */
 export interface SiteWithLambdaBackendResponseHeadersPolicyProps extends ResponseHeadersPolicyProps {
+    /** Security headers behaviour configuration */
     securityHeadersBehavior: SiteWithLambdaBackendSecurityHeadersBehavior;
+    /** The policy type (origin or static) */
     type: SiteWithLambdaBackendResponseHeaderPolicyType;
 }
+/**
+ * Extended cache policy properties with TTL values specified in seconds
+ */
 /** @category Interface */
 export interface SiteWithLambdaBackendCachePolicyProps extends CachePolicyProps {
+    /** The default TTL for cached objects in seconds */
     defaultTtlInSeconds: number;
+    /** The minimum TTL for cached objects in seconds */
     minTtlInSeconds: number;
+    /** The maximum TTL for cached objects in seconds */
     maxTtlInSeconds: number;
 }

package/dist/src/construct/static-asset-deployment/main.d.ts

@@ -18,10 +18,20 @@ import { StaticAssetDeploymentProps } from './types.js';
  * @category Construct
  */
 export declare class StaticAssetDeployment extends CommonConstruct {
+    /** The S3 bucket for static assets */
     staticAssetBucket: IBucket;
+    /** The optional CloudFront distribution for cache invalidation */
     cloudfrontDistribution?: IDistribution;
+    /** The static asset deployment properties */
     props: StaticAssetDeploymentProps;
+    /** The scoped id of this construct */
     id: string;
+    /**
+     * @summary Create a new StaticAssetDeployment construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the static asset deployment properties
+     */
     constructor(parent: Construct, id: string, props: StaticAssetDeploymentProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/static-asset-deployment/main.js

@@ -19,11 +19,20 @@ import { CommonConstruct } from '../../common/index.js';
  * @category Construct
  */
 export class StaticAssetDeployment extends CommonConstruct {
-    /* construct resources */
+    /** The S3 bucket for static assets */
     staticAssetBucket;
+    /** The optional CloudFront distribution for cache invalidation */
     cloudfrontDistribution;
+    /** The static asset deployment properties */
     props;
+    /** The scoped id of this construct */
     id;
+    /**
+     * @summary Create a new StaticAssetDeployment construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the static asset deployment properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.id = id;

package/dist/src/construct/static-asset-deployment/types.d.ts

@@ -1,8 +1,13 @@
 import { BucketDeploymentProps, S3BucketProps } from '../../services/index.js';
 import { CommonStackProps } from '../../common/index.js';
+/**
+ * Represents a key-value pair for exporting static asset S3 URLs as CloudFormation outputs
+ */
 /** @category Interface */
 export interface AssetExport {
+    /** The CloudFormation output logical name */
     key: string;
+    /** The S3 object key to generate a URL for */
     value: string;
 }
 /**
@@ -33,12 +38,21 @@ export interface StaticCloudFrontDistribution {
      */
     invalidationPaths: string[];
 }
+/**
+ * Properties for configuring a {@link StaticAssetDeployment} construct
+ */
 /** @category Interface */
 export interface StaticAssetDeploymentProps extends CommonStackProps {
+    /** Configuration for the S3 bucket hosting the static assets */
     staticAssetBucket: S3BucketProps;
+    /** Configuration for the S3 bucket deployment */
     staticAssetDeployment: BucketDeploymentProps;
+    /** The source assets to deploy (file paths or ISource objects) */
     staticAssetSources: any[] | string[];
+    /** Optional asset exports to create as CloudFormation outputs */
     staticAssetsForExport?: AssetExport[];
+    /** Optional key prefix for deployed objects in the destination bucket */
     destinationKeyPrefix?: string;
+    /** Optional CloudFront distribution for cache invalidation after deployment */
     cloudFrontDistribution?: StaticCloudFrontDistribution;
 }

package/dist/src/construct/static-site/main.d.ts

@@ -22,17 +22,34 @@ import { StaticSiteProps } from './types.js';
  * @category Construct
  */
 export declare class StaticSite extends CommonConstruct {
+    /** The static site properties */
     props: StaticSiteProps;
+    /** The scoped id of this construct */
     id: string;
+    /** The Route53 hosted zone for the site domain */
     siteHostedZone: IHostedZone;
+    /** The SSL/TLS certificate for the site */
     siteCertificate: ICertificate;
+    /** The Route53 A record pointing to the CloudFront distribution */
     siteARecord: ARecord;
+    /** The S3 bucket hosting the static site content */
     siteBucket: IBucket;
+    /** The CloudFront distribution serving the static site */
     siteDistribution: IDistribution;
+    /** The S3 bucket used for CloudFront access logs */
     siteLogBucket: IBucket;
+    /** The CloudFront origin access identity for S3 bucket access */
     siteOriginAccessIdentity: OriginAccessIdentity;
+    /** The CloudFront function attached to the distribution */
     siteCloudfrontFunction: IFunction;
+    /** The CloudFront function associations for the distribution behaviours */
     siteFunctionAssociations: FunctionAssociation[];
+    /**
+     * @summary Create a new StaticSite construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the static site properties
+     */
     constructor(parent: Construct, id: string, props: StaticSiteProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/static-site/main.js

@@ -17,19 +17,34 @@ import { CommonConstruct } from '../../common/index.js';
  * @category Construct
  */
 export class StaticSite extends CommonConstruct {
-    /* static site properties */
+    /** The static site properties */
     props;
+    /** The scoped id of this construct */
     id;
-    /* static site resources */
+    /** The Route53 hosted zone for the site domain */
     siteHostedZone;
+    /** The SSL/TLS certificate for the site */
     siteCertificate;
+    /** The Route53 A record pointing to the CloudFront distribution */
     siteARecord;
+    /** The S3 bucket hosting the static site content */
     siteBucket;
+    /** The CloudFront distribution serving the static site */
     siteDistribution;
+    /** The S3 bucket used for CloudFront access logs */
     siteLogBucket;
+    /** The CloudFront origin access identity for S3 bucket access */
     siteOriginAccessIdentity;
+    /** The CloudFront function attached to the distribution */
     siteCloudfrontFunction;
+    /** The CloudFront function associations for the distribution behaviours */
     siteFunctionAssociations;
+    /**
+     * @summary Create a new StaticSite construct
+     * @param parent the parent construct
+     * @param id scoped id of the resource
+     * @param props the static site properties
+     */
     constructor(parent, id, props) {
         super(parent, id, props);
         this.props = props;

package/dist/src/construct/static-site/types.d.ts

@@ -2,24 +2,41 @@ import { ISource } from 'aws-cdk-lib/aws-s3-deployment';
 import { CommonStackProps } from '../../common/index.js';
 import { AcmProps, CloudfrontFunctionProps, DistributionProps, S3BucketProps } from '../../services/index.js';
 /**
+ * Properties for configuring a {@link StaticSite} construct
  */
 /** @category Interface */
 export interface StaticSiteProps extends CommonStackProps {
+    /** The application log level */
     logLevel: string;
+    /** The Node.js environment (e.g. development, production) */
     nodeEnv: string;
+    /** Additional domain aliases for the CloudFront distribution */
     siteAliases?: string[];
+    /** Configuration for the S3 bucket hosting the static site */
     siteBucket: S3BucketProps;
+    /** Path to the Dockerfile used to invalidate the CloudFront cache after deployment */
     siteCacheInvalidationDockerFilePath?: string;
+    /** Configuration for the SSL/TLS certificate */
     siteCertificate: AcmProps;
+    /** Configuration for a CloudFront function to attach to the distribution */
     siteCloudfrontFunctionProps?: CloudfrontFunctionProps;
+    /** Whether to create an alternative A record for the site */
     siteCreateAltARecord: boolean;
+    /** Configuration for the CloudFront distribution */
     siteDistribution?: DistributionProps;
+    /** Path to the CloudFront function code file */
     siteFunctionFilePath?: string;
+    /** The hosted zone domain name override */
     siteHostedZoneDomainName?: string;
+    /** Configuration for the S3 bucket used for access logs */
     siteLogBucket: S3BucketProps;
+    /** The Route53 record name for the site */
     siteRecordName?: string;
+    /** The source asset to deploy to the site bucket */
     siteSource: ISource;
+    /** The subdomain for the static site */
     siteSubDomain?: string;
+    /** The timezone for the application */
     timezone: string;
     /**
      * Whether to prune the contents of the bucket when deploying assets.
@@ -27,5 +44,6 @@ export interface StaticSiteProps extends CommonStackProps {
      * @default true
      */
     pruneOnDeployment?: boolean;
+    /** Whether to look up an existing hosted zone instead of creating one */
     useExistingHostedZone: boolean;
 }

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

@@ -27,7 +27,7 @@ export declare 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: string, scope: CommonConstruct, props: LambdaRestApiProps, lambdaFunction: IFunction): LambdaRestApi;
     /**
@@ -39,31 +39,31 @@ export declare class ApiManager {
      */
     createApiDomain(id: string, scope: CommonConstruct, domainName: string, certificate: ICertificate): DomainName;
     /**
-     * @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: string, scope: CommonConstruct, parent: IResource, path: string, integration: Integration, addProxy: boolean, authorizer?: IAuthorizer, allowedOrigins?: string[], allowedMethods?: string[], allowedHeaders?: string[], methodRequestParameters?: {
         [param: string]: boolean;
     }, proxyIntegration?: Integration, enableDefaultCors?: boolean, mockIntegration?: Integration, mockMethodResponses?: MethodResponse[]): import("aws-cdk-lib/aws-apigateway").Resource;
     /**
      * @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: string, scope: CommonConstruct, api: IRestApi): void;
 }