@gradientedge/cdk-utils 8.91.0 → 8.93.0

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

@@ -4,9 +4,6 @@ import * as lambda from 'aws-cdk-lib/aws-lambda';
 import { LambdaRestApiProps } from './types';
 import { CommonConstruct } from '../../../common';
 /**
- * @stability stable
- * @category cdk-utils.api-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS API Gateway.
  * - 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.
@@ -21,47 +18,46 @@ import { CommonConstruct } from '../../../common';
  *     this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
  *   }
  * }
- *
  * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
  */
 export declare class ApiManager {
     /**
      * @summary Method to create a Rest API with Lambda backend/target
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {AcmProps} props lambda rest restApi props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props lambda rest restApi props
      * @param lambdaFunction
      */
     createLambdaRestApi(id: string, scope: CommonConstruct, props: LambdaRestApiProps, lambdaFunction: lambda.IFunction): apig.LambdaRestApi;
     /**
      * @summary Method to create custom restApi domain
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
      * @param domainName the domain name to use
      * @param certificate the certificate used for custom restApi domain
      */
     createApiDomain(id: string, scope: CommonConstruct, domainName: string, certificate: acm.ICertificate): apig.DomainName;
     /**
      * @summary Method to create an API gateway resource
-     * @param {string} id
-     * @param {CommonConstruct} scope
-     * @param {apig.IResource} parent
-     * @param {string} path
-     * @param {apig.Integration} integration
-     * @param {boolean} addProxy
-     * @param {apig.IAuthorizer} authorizer
-     * @param {string[]?} allowedOrigins
-     * @param {string[]?} allowedMethods
-     * @param {string[]?} allowedHeaders
-     * @param {{}?} methodRequestParameters
-     * @param {apig.Integration} proxyIntegration
+     * @param id
+     * @param scope
+     * @param parent
+     * @param path
+     * @param integration
+     * @param addProxy
+     * @param authorizer
+     * @param allowedOrigins
+     * @param allowedMethods
+     * @param allowedHeaders
+     * @param methodRequestParameters
+     * @param proxyIntegration
      */
-    createApiResource(id: string, scope: CommonConstruct, parent: apig.IResource, path: string, integration: apig.Integration, addProxy: boolean, authorizer?: apig.IAuthorizer, allowedOrigins?: string[], allowedMethods?: string[], allowedHeaders?: string[], methodRequestParameters?: {}, proxyIntegration?: apig.Integration): apig.Resource;
+    createApiResource(id: string, scope: CommonConstruct, parent: apig.IResource, path: string, integration: apig.Integration, addProxy: boolean, authorizer?: apig.IAuthorizer, allowedOrigins?: string[], allowedMethods?: string[], allowedHeaders?: string[], methodRequestParameters?: any, proxyIntegration?: apig.Integration): apig.Resource;
     /**
      * @summary Method to create an api deployment
-     * @param {string} id
-     * @param {CommonConstruct} scope
-     * @param {apig.IRestApi} restApi
+     * @param id
+     * @param scope
+     * @param restApi
      */
     createApiDeployment(id: string, scope: CommonConstruct, restApi: apig.IRestApi): void;
 }

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

@@ -28,9 +28,6 @@ const apig = __importStar(require("aws-cdk-lib/aws-apigateway"));
 const utils = __importStar(require("../../../utils"));
 const cdk = __importStar(require("aws-cdk-lib"));
 /**
- * @stability stable
- * @category cdk-utils.api-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS API Gateway.
  * - 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.
@@ -45,15 +42,14 @@ const cdk = __importStar(require("aws-cdk-lib"));
  *     this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
  *   }
  * }
- *
  * @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
  */
 class ApiManager {
     /**
      * @summary Method to create a Rest API with Lambda backend/target
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {AcmProps} props lambda rest restApi props
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props lambda rest restApi props
      * @param lambdaFunction
      */
     createLambdaRestApi(id, scope, props, lambdaFunction) {
@@ -61,41 +57,41 @@ class ApiManager {
             throw `Api props undefined for ${id}`;
         const api = new apig.LambdaRestApi(scope, `${id}`, {
             binaryMediaTypes: props.binaryMediaTypes,
-            minCompressionSize: props.minCompressionSize,
+            cloudWatchRole: props.cloudWatchRole || false,
+            defaultCorsPreflightOptions: props.defaultCorsPreflightOptions,
             defaultMethodOptions: props.defaultMethodOptions,
             deploy: props.deploy || true,
             deployOptions: {
-                stageName: scope.props.stage,
                 accessLogDestination: props.deployOptions?.accessLogDestination,
                 accessLogFormat: props.deployOptions?.accessLogFormat,
-                tracingEnabled: props.deployOptions?.tracingEnabled,
                 cacheClusterEnabled: props.deployOptions?.cacheClusterEnabled,
                 cacheClusterSize: props.deployOptions?.cacheClusterSize,
+                cachingEnabled: props.deployOptions?.cachingEnabled,
                 clientCertificateId: props.deployOptions?.clientCertificateId,
+                dataTraceEnabled: props.deployOptions?.dataTraceEnabled,
                 description: `${id} - ${scope.props.stage} stage`,
                 documentationVersion: props.deployOptions?.documentationVersion,
-                variables: props.deployOptions?.variables,
-                methodOptions: props.deployOptions?.methodOptions,
                 loggingLevel: props.deployOptions?.loggingLevel,
-                dataTraceEnabled: props.deployOptions?.dataTraceEnabled,
-                cachingEnabled: props.deployOptions?.cachingEnabled,
+                methodOptions: props.deployOptions?.methodOptions,
                 metricsEnabled: props.deployOptions?.metricsEnabled,
+                stageName: scope.props.stage,
+                tracingEnabled: props.deployOptions?.tracingEnabled,
+                variables: props.deployOptions?.variables,
             },
-            retainDeployments: props.retainDeployments,
-            parameters: props.parameters,
-            policy: props.policy,
-            failOnWarnings: props.failOnWarnings || false,
             domainName: props.domainName,
-            cloudWatchRole: props.cloudWatchRole || false,
-            endpointTypes: props.endpointTypes,
             endpointConfiguration: {
                 types: props.endpointConfiguration?.types || [apig.EndpointType.REGIONAL],
                 vpcEndpoints: props.endpointConfiguration?.vpcEndpoints,
             },
-            restApiName: `${props.restApiName}-${scope.props.stage}`,
+            endpointTypes: props.endpointTypes,
+            failOnWarnings: props.failOnWarnings || false,
             handler: lambdaFunction,
-            defaultCorsPreflightOptions: props.defaultCorsPreflightOptions,
+            minCompressionSize: props.minCompressionSize,
+            parameters: props.parameters,
+            policy: props.policy,
             proxy: props.proxy ?? true,
+            restApiName: `${props.restApiName}-${scope.props.stage}`,
+            retainDeployments: props.retainDeployments,
         });
         if (props.tags && props.tags.length > 0) {
             props.tags.forEach(tag => {
@@ -108,15 +104,15 @@ class ApiManager {
     }
     /**
      * @summary Method to create custom restApi domain
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
      * @param domainName the domain name to use
      * @param certificate the certificate used for custom restApi domain
      */
     createApiDomain(id, scope, domainName, certificate) {
         const apiDomain = new apig.DomainName(scope, `${id}`, {
-            domainName: domainName,
             certificate: certificate,
+            domainName: domainName,
             endpointType: scope.isProductionStage() ? apig.EndpointType.EDGE : apig.EndpointType.REGIONAL,
             securityPolicy: apig.SecurityPolicy.TLS_1_2,
         });
@@ -125,27 +121,27 @@ class ApiManager {
     }
     /**
      * @summary Method to create an API gateway resource
-     * @param {string} id
-     * @param {CommonConstruct} scope
-     * @param {apig.IResource} parent
-     * @param {string} path
-     * @param {apig.Integration} integration
-     * @param {boolean} addProxy
-     * @param {apig.IAuthorizer} authorizer
-     * @param {string[]?} allowedOrigins
-     * @param {string[]?} allowedMethods
-     * @param {string[]?} allowedHeaders
-     * @param {{}?} methodRequestParameters
-     * @param {apig.Integration} proxyIntegration
+     * @param id
+     * @param scope
+     * @param parent
+     * @param path
+     * @param integration
+     * @param addProxy
+     * @param authorizer
+     * @param allowedOrigins
+     * @param allowedMethods
+     * @param allowedHeaders
+     * @param methodRequestParameters
+     * @param proxyIntegration
      */
     createApiResource(id, scope, parent, path, integration, addProxy, authorizer, allowedOrigins, allowedMethods, allowedHeaders, methodRequestParameters, proxyIntegration) {
         const methods = allowedMethods ?? apig.Cors.ALL_METHODS;
         const resource = parent.addResource(path, {
             defaultCorsPreflightOptions: {
-                allowOrigins: allowedOrigins ?? apig.Cors.ALL_ORIGINS,
-                allowMethods: [...methods, 'OPTIONS'],
-                allowHeaders: allowedHeaders ?? apig.Cors.DEFAULT_HEADERS,
                 allowCredentials: true,
+                allowHeaders: allowedHeaders ?? apig.Cors.DEFAULT_HEADERS,
+                allowMethods: [...methods, 'OPTIONS'],
+                allowOrigins: allowedOrigins ?? apig.Cors.ALL_ORIGINS,
             },
         });
         methods.forEach(method => resource.addMethod(method, integration, {
@@ -156,10 +152,10 @@ class ApiManager {
         if (addProxy) {
             const resourceProxy = resource.addResource(`{${path}+}`, {
                 defaultCorsPreflightOptions: {
-                    allowOrigins: allowedOrigins ?? apig.Cors.ALL_ORIGINS,
-                    allowMethods: [...methods, 'OPTIONS'],
-                    allowHeaders: allowedHeaders ?? apig.Cors.DEFAULT_HEADERS,
                     allowCredentials: true,
+                    allowHeaders: allowedHeaders ?? apig.Cors.DEFAULT_HEADERS,
+                    allowMethods: [...methods, 'OPTIONS'],
+                    allowOrigins: allowedOrigins ?? apig.Cors.ALL_ORIGINS,
                 },
             });
             methods.forEach(method => resourceProxy.addMethod(method, proxyIntegration ?? integration, {
@@ -172,9 +168,9 @@ class ApiManager {
     }
     /**
      * @summary Method to create an api deployment
-     * @param {string} id
-     * @param {CommonConstruct} scope
-     * @param {apig.IRestApi} restApi
+     * @param id
+     * @param scope
+     * @param restApi
      */
     createApiDeployment(id, scope, restApi) {
         new apig.Deployment(scope, `${id}`, {

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

@@ -1,8 +1,6 @@
 import { TagProps } from '../../../types';
 import * as apig from 'aws-cdk-lib/aws-apigateway';
 /**
- * @category cdk-utils.api-manager
- * @subcategory Properties
  */
 export interface LambdaRestApiProps extends apig.LambdaRestApiProps {
     tags?: TagProps[];

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

@@ -1,16 +1,10 @@
 /**
- * @stability stable
- * @category cdk-utils.app-config-manager
- * @subcategory Construct
  * @returns { Map<string, string> } AppConfig extension ARN by region for x84
  */
 export declare const ArnsByRegionForX86_64: {
     [region: string]: string;
 };
 /**
- * @stability stable
- * @category cdk-utils.app-config-manager
- * @subcategory Construct
  * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
  */
 export declare const ArnsByRegionForArm64: {

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

@@ -2,59 +2,53 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArnsByRegionForArm64 = exports.ArnsByRegionForX86_64 = void 0;
 /**
- * @stability stable
- * @category cdk-utils.app-config-manager
- * @subcategory Construct
  * @returns { Map<string, string> } AppConfig extension ARN by region for x84
  */
 exports.ArnsByRegionForX86_64 = {
-    'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension:110',
-    'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension:79',
-    'us-west-1': 'arn:aws:lambda:us-west-1:958113053741:layer:AWS-AppConfig-Extension:121',
-    'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension:143',
-    'ca-central-1': 'arn:aws:lambda:ca-central-1:039592058896:layer:AWS-AppConfig-Extension:79',
-    'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension:91',
-    'eu-central-2': 'arn:aws:lambda:eu-central-2:758369105281:layer:AWS-AppConfig-Extension:29',
-    'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension:108',
-    'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension:79',
-    'eu-west-3': 'arn:aws:lambda:eu-west-3:493207061005:layer:AWS-AppConfig-Extension:80',
-    'eu-north-1': 'arn:aws:lambda:eu-north-1:646970417810:layer:AWS-AppConfig-Extension:139',
-    'eu-south-1': 'arn:aws:lambda:eu-south-1:203683718741:layer:AWS-AppConfig-Extension:71',
-    'eu-south-2': 'arn:aws:lambda:eu-south-2:586093569114:layer:AWS-AppConfig-Extension:26',
-    'cn-north-1': 'arn:aws-cn:lambda:cn-north-1:615057806174:layer:AWS-AppConfig-Extension:66',
-    'cn-northwest-1': 'arn:aws-cn:lambda:cn-northwest-1:615084187847:layer:AWS-AppConfig-Extension:66',
+    'af-south-1': 'arn:aws:lambda:af-south-1:574348263942:layer:AWS-AppConfig-Extension:71',
     'ap-east-1': 'arn:aws:lambda:ap-east-1:630222743974:layer:AWS-AppConfig-Extension:71',
     'ap-northeast-1': 'arn:aws:lambda:ap-northeast-1:980059726660:layer:AWS-AppConfig-Extension:82',
     'ap-northeast-2': 'arn:aws:lambda:ap-northeast-2:826293736237:layer:AWS-AppConfig-Extension:91',
     'ap-northeast-3': 'arn:aws:lambda:ap-northeast-3:706869817123:layer:AWS-AppConfig-Extension:84',
+    'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension:92',
+    'ap-south-2': 'arn:aws:lambda:ap-south-2:489524808438:layer:AWS-AppConfig-Extension:29',
     'ap-southeast-1': 'arn:aws:lambda:ap-southeast-1:421114256042:layer:AWS-AppConfig-Extension:89',
     'ap-southeast-2': 'arn:aws:lambda:ap-southeast-2:080788657173:layer:AWS-AppConfig-Extension:91',
     'ap-southeast-3': 'arn:aws:lambda:ap-southeast-3:418787028745:layer:AWS-AppConfig-Extension:60',
     'ap-southeast-4': 'arn:aws:lambda:ap-southeast-4:307021474294:layer:AWS-AppConfig-Extension:2',
-    'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension:92',
-    'ap-south-2': 'arn:aws:lambda:ap-south-2:489524808438:layer:AWS-AppConfig-Extension:29',
-    'sa-east-1': 'arn:aws:lambda:sa-east-1:000010852771:layer:AWS-AppConfig-Extension:110',
-    'af-south-1': 'arn:aws:lambda:af-south-1:574348263942:layer:AWS-AppConfig-Extension:71',
+    'ca-central-1': 'arn:aws:lambda:ca-central-1:039592058896:layer:AWS-AppConfig-Extension:79',
+    'cn-north-1': 'arn:aws-cn:lambda:cn-north-1:615057806174:layer:AWS-AppConfig-Extension:66',
+    'cn-northwest-1': 'arn:aws-cn:lambda:cn-northwest-1:615084187847:layer:AWS-AppConfig-Extension:66',
+    'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension:91',
+    'eu-central-2': 'arn:aws:lambda:eu-central-2:758369105281:layer:AWS-AppConfig-Extension:29',
+    'eu-north-1': 'arn:aws:lambda:eu-north-1:646970417810:layer:AWS-AppConfig-Extension:139',
+    'eu-south-1': 'arn:aws:lambda:eu-south-1:203683718741:layer:AWS-AppConfig-Extension:71',
+    'eu-south-2': 'arn:aws:lambda:eu-south-2:586093569114:layer:AWS-AppConfig-Extension:26',
+    'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension:108',
+    'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension:79',
+    'eu-west-3': 'arn:aws:lambda:eu-west-3:493207061005:layer:AWS-AppConfig-Extension:80',
     'me-central-1': 'arn:aws:lambda:me-central-1:662846165436:layer:AWS-AppConfig-Extension:31',
     'me-south-1': 'arn:aws:lambda:me-south-1:559955524753:layer:AWS-AppConfig-Extension:71',
+    'sa-east-1': 'arn:aws:lambda:sa-east-1:000010852771:layer:AWS-AppConfig-Extension:110',
+    'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension:110',
+    'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension:79',
     'us-gov-east-1': 'arn:aws-us-gov:lambda:us-gov-east-1:946561847325:layer:AWS-AppConfig-Extension:44',
     'us-gov-west-1': 'arn:aws-us-gov:lambda:us-gov-west-1:946746059096:layer:AWS-AppConfig-Extension:44',
+    'us-west-1': 'arn:aws:lambda:us-west-1:958113053741:layer:AWS-AppConfig-Extension:121',
+    'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension:143',
 };
 /**
- * @stability stable
- * @category cdk-utils.app-config-manager
- * @subcategory Construct
  * @returns { Map<string, string> } AppConfig extension ARN by region for arm64
  */
 exports.ArnsByRegionForArm64 = {
-    'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension-Arm64:43',
-    'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension-Arm64:31',
-    'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension-Arm64:45',
-    'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension-Arm64:34',
-    'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension-Arm64:46',
-    'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension-Arm64:31',
     'ap-northeast-1': 'arn:aws:lambda:ap-northeast-1:980059726660:layer:AWS-AppConfig-Extension-Arm64:35',
+    'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension-Arm64:34',
     'ap-southeast-1': 'arn:aws:lambda:ap-southeast-1:421114256042:layer:AWS-AppConfig-Extension-Arm64:41',
     'ap-southeast-2': 'arn:aws:lambda:ap-southeast-2:080788657173:layer:AWS-AppConfig-Extension-Arm64:34',
-    'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension-Arm64:34',
+    'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension-Arm64:34',
+    'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension-Arm64:46',
+    'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension-Arm64:31',
+    'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension-Arm64:43',
+    'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension-Arm64:31',
+    'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension-Arm64:45',
 };

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

@@ -3,8 +3,6 @@ import { Architecture } from '../constants';
 import { AppConfigProps } from './types';
 import { CommonConstruct } from '../../../common';
 /**
- * @category cdk-utils.app-config-manager
- * @subcategory Construct
  * @classdesc 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.
@@ -18,41 +16,40 @@ import { CommonConstruct } from '../../../common';
  *     this.appConfigManager.createApplication('MyApplication', this)
  *   }
  * }
- *
  * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
  */
 export declare class AppConfigManager {
     /**
      * Method to get static ARNs for AppConfig extensions
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {Architecture} type type of the architecture
+     * @param scope scope in which this resource is defined
+     * @param type type of the architecture
      */
     getArnForAppConfigExtension(scope: CommonConstruct, type: Architecture): string;
     /**
      * @summary Method to create an AppConfig Application
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {AppConfigProps} props
-     * @returns {appconfig.CfnApplication}
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @returns the appconfig application
      */
     createApplication(id: string, scope: CommonConstruct, props: AppConfigProps): appconfig.CfnApplication;
     /**
      * @summary Method to create an AppConfig Environment for a given application
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} applicationId id of the application
-     * @param {AppConfigProps} props
-     * @returns {appconfig.CfnEnvironment}
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param applicationId id of the application
+     * @param props
+     * @returns the appconfig environment
      */
     createEnvironment(id: string, scope: CommonConstruct, applicationId: string, props: AppConfigProps): appconfig.CfnEnvironment;
     /**
      * @summary Method to create an AppConfig Configuration Profile for a given application
      * - <p>&#9888; The <b>locationUri</b> is defaulted to <i>hosted</i> if undefined</p>
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} applicationId id of the application
-     * @param {AppConfigProps} props
-     * @returns {appconfig.CfnConfigurationProfile}
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param applicationId id of the application
+     * @param props
+     * @returns the appconfig configuration profile
      */
     createConfigurationProfile(id: string, scope: CommonConstruct, applicationId: string, props: AppConfigProps): appconfig.CfnConfigurationProfile;
 }

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

@@ -30,8 +30,6 @@ const utils = __importStar(require("../../../utils"));
 const constants_1 = require("../constants");
 const constants_2 = require("./constants");
 /**
- * @category cdk-utils.app-config-manager
- * @subcategory Construct
  * @classdesc 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.
@@ -45,14 +43,13 @@ const constants_2 = require("./constants");
  *     this.appConfigManager.createApplication('MyApplication', this)
  *   }
  * }
- *
  * @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
  */
 class AppConfigManager {
     /**
      * Method to get static ARNs for AppConfig extensions
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {Architecture} type type of the architecture
+     * @param scope scope in which this resource is defined
+     * @param type type of the architecture
      */
     getArnForAppConfigExtension(scope, type) {
         switch (type) {
@@ -66,17 +63,17 @@ class AppConfigManager {
     }
     /**
      * @summary Method to create an AppConfig Application
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {AppConfigProps} props
-     * @returns {appconfig.CfnApplication}
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props
+     * @returns the appconfig application
      */
     createApplication(id, scope, props) {
         if (!props)
             throw `AppConfig props undefined for ${id}`;
         const application = new appconfig.CfnApplication(scope, `${id}`, {
-            name: `${props.application.name}-${scope.props.stage}`,
             description: props.application.description,
+            name: `${props.application.name}-${scope.props.stage}`,
             tags: props.application.tags,
         });
         utils.createCfnOutput(`${id}-ApplicationId`, scope, cdk.Fn.ref(application.logicalId));
@@ -85,20 +82,20 @@ class AppConfigManager {
     }
     /**
      * @summary Method to create an AppConfig Environment for a given application
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} applicationId id of the application
-     * @param {AppConfigProps} props
-     * @returns {appconfig.CfnEnvironment}
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param applicationId id of the application
+     * @param props
+     * @returns the appconfig environment
      */
     createEnvironment(id, scope, applicationId, props) {
         if (!props)
             throw `AppConfig props undefined for ${id}`;
         const environment = new appconfig.CfnEnvironment(scope, `${id}`, {
             applicationId: applicationId,
-            name: props.environment.name ?? scope.props.stage,
             description: props.environment.description,
             monitors: props.environment.monitors,
+            name: props.environment.name ?? scope.props.stage,
             tags: props.environment.tags,
         });
         utils.createCfnOutput(`${id}-configurationEnvironmentId`, scope, cdk.Fn.ref(environment.logicalId));
@@ -108,20 +105,20 @@ class AppConfigManager {
     /**
      * @summary Method to create an AppConfig Configuration Profile for a given application
      * - <p>&#9888; The <b>locationUri</b> is defaulted to <i>hosted</i> if undefined</p>
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {string} applicationId id of the application
-     * @param {AppConfigProps} props
-     * @returns {appconfig.CfnConfigurationProfile}
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param applicationId id of the application
+     * @param props
+     * @returns the appconfig configuration profile
      */
     createConfigurationProfile(id, scope, applicationId, props) {
         if (!props)
             throw `AppConfig props undefined for ${id}`;
         const profile = new appconfig.CfnConfigurationProfile(scope, `${id}`, {
             applicationId: applicationId,
+            description: props.configurationProfile.description,
             locationUri: props.configurationProfile.locationUri || 'hosted',
             name: `${props.configurationProfile.name}-${scope.props.stage}`,
-            description: props.configurationProfile.description,
             retrievalRoleArn: props.configurationProfile.retrievalRoleArn,
             tags: props.configurationProfile.tags,
             type: props.configurationProfile.type,

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

@@ -1,13 +1,11 @@
 import { CfnApplicationProps, CfnConfigurationProfileProps, CfnDeploymentProps, CfnDeploymentStrategyProps, CfnEnvironmentProps } from 'aws-cdk-lib/aws-appconfig';
 /**
- * @category cdk-utils.app-config-manager
- * @subcategory Properties
  */
 export interface AppConfigProps {
-    id: string;
     application: CfnApplicationProps;
     configurationProfile: CfnConfigurationProfileProps;
     deployment: CfnDeploymentProps;
     deploymentStrategy: CfnDeploymentStrategyProps;
     environment: CfnEnvironmentProps;
+    id: string;
 }

package/dist/src/lib/services/aws/certificate-manager/main.d.ts

@@ -3,9 +3,6 @@ import * as route53 from 'aws-cdk-lib/aws-route53';
 import { AcmProps } from './types';
 import { CommonConstruct } from '../../../common';
 /**
- * @stability stable
- * @category cdk-utils.acm-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Certificates.
  * - 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.
@@ -19,18 +16,16 @@ import { CommonConstruct } from '../../../common';
  *     this.acmManager.createCertificate('MyCertificate', this)
  *   }
  * }
- *
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
  */
 export declare class AcmManager {
     /**
      * @summary Method to create/import a certificate
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {AcmProps} props certificate props
-     * @param {route53.HostedZone?} hostedZone optional hosted zone to perform DNS validation
-     * @returns {acm.ICertificate}
-     *
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props certificate props
+     * @param hostedZone optional hosted zone to perform DNS validation
+     * @returns the resolved certificate
      * @mermaid
      *   graph LR;
      *     A((Start)) --> B{Valid Properties?};

package/dist/src/lib/services/aws/certificate-manager/main.js

@@ -28,9 +28,6 @@ const cdk = __importStar(require("aws-cdk-lib"));
 const acm = __importStar(require("aws-cdk-lib/aws-certificatemanager"));
 const utils = __importStar(require("../../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.acm-manager
- * @subcategory Construct
  * @classdesc Provides operations on AWS Certificates.
  * - 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.
@@ -44,18 +41,16 @@ const utils = __importStar(require("../../../utils"));
  *     this.acmManager.createCertificate('MyCertificate', this)
  *   }
  * }
- *
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
  */
 class AcmManager {
     /**
      * @summary Method to create/import a certificate
-     * @param {string} id scoped id of the resource
-     * @param {CommonConstruct} scope scope in which this resource is defined
-     * @param {AcmProps} props certificate props
-     * @param {route53.HostedZone?} hostedZone optional hosted zone to perform DNS validation
-     * @returns {acm.ICertificate}
-     *
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props certificate props
+     * @param hostedZone optional hosted zone to perform DNS validation
+     * @returns the resolved certificate
      * @mermaid
      *   graph LR;
      *     A((Start)) --> B{Valid Properties?};

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

@@ -1,13 +1,11 @@
 import * as acm from 'aws-cdk-lib/aws-certificatemanager';
 /**
- * @category cdk-utils.acm-manager
- * @subcategory Properties
  */
 export interface AcmProps extends acm.CertificateProps {
-    certificateSsmName?: string;
     certificateAccount?: string;
-    certificateRegion?: string;
-    certificateId?: string;
     certificateArn?: string;
+    certificateId?: string;
+    certificateRegion?: string;
+    certificateSsmName?: string;
     useExistingCertificate: boolean;
 }