@gradientedge/cdk-utils 8.91.0 → 8.92.0

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

@@ -28,10 +28,7 @@ const common_1 = require("../../common");
 const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const secretsManager = __importStar(require("aws-cdk-lib/aws-secretsmanager"));
 /**
- * @category cdk-utils.lambda-with-iam-access
- * @subcategory construct
  * @classdesc Provides a construct to create a lambda function with IAM access
- *
  * @example
  * import { LambdaWithIamAccess, LambdaWithIamAccessProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -44,7 +41,6 @@ const secretsManager = __importStar(require("aws-cdk-lib/aws-secretsmanager"));
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class LambdaWithIamAccess extends common_1.CommonConstruct {
     /* LambdaWithIamAccess props */
@@ -66,7 +62,6 @@ class LambdaWithIamAccess extends common_1.CommonConstruct {
     }
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources() {
         this.createLambdaPolicy();
@@ -79,7 +74,6 @@ class LambdaWithIamAccess extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam policy for Lambda function
-     * @protected
      */
     createLambdaPolicy() {
         this.lambdaPolicy = new iam.PolicyDocument({
@@ -88,25 +82,22 @@ class LambdaWithIamAccess extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam role for Lambda function
-     * @protected
      */
     createLambdaRole() {
         this.lambdaRole = this.iamManager.createRoleForLambda(`${this.id}-lambda-role`, this, this.lambdaPolicy);
     }
     /**
      * @summary Method to create environment variables for Lambda function
-     * @protected
      */
     createLambdaEnvironment() {
         this.lambdaEnvironment = {
-            NODE_ENV: this.props.nodeEnv,
             LOG_LEVEL: this.props.logLevel,
+            NODE_ENV: this.props.nodeEnv,
             TZ: this.props.timezone,
         };
     }
     /**
      * @summary Method to create layers for Lambda function
-     * @protected
      */
     createLambdaLayers() {
         const layers = [];
@@ -119,14 +110,12 @@ class LambdaWithIamAccess extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create lambda function
-     * @protected
      */
     createLambdaFunction() {
         this.lambdaFunction = this.lambdaManager.createLambdaFunction(`${this.id}-lambda`, this, this.props.lambda, this.lambdaRole, this.lambdaLayers, this.props.lambdaSource, this.props.lambdaHandler || 'index.handler', this.lambdaEnvironment);
     }
     /**
      * @summary Method to create iam user for the lambda function
-     * @protected
      */
     createIamUserForLambdaFunction() {
         this.lambdaIamUser = new iam.User(this, `${this.id}-lambda-user`, {
@@ -136,8 +125,8 @@ class LambdaWithIamAccess extends common_1.CommonConstruct {
             policyName: `${this.id}-policy-${this.props.stage}`,
             statements: [
                 new iam.PolicyStatement({
-                    resources: [this.lambdaFunction.functionArn],
                     actions: ['lambda:InvokeFunction'],
+                    resources: [this.lambdaFunction.functionArn],
                 }),
             ],
             users: [this.lambdaIamUser],
@@ -148,7 +137,6 @@ class LambdaWithIamAccess extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam secret for the lambda function
-     * @protected
      */
     createIamSecretForLambdaFunction() {
         this.lambdaUserAccessSecret = new secretsManager.Secret(this, `${this.id}-lambda-user-secret-${this.props.stage}`, this.props.lambdaSecret);

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

@@ -8,12 +8,9 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common';
 import { RestApiLambdaEnvironment, RestApiLambdaProps } from './types';
 /**
- * @category cdk-utils.rest-api-lambda
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a RestApi as Lambda
  *
  * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
- *
  * @example
  * import { RestApiLambda, RestApiLambdaProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -26,7 +23,6 @@ import { RestApiLambdaEnvironment, RestApiLambdaProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare abstract class RestApiLambda extends CommonConstruct {
     props: RestApiLambdaProps;
@@ -45,74 +41,60 @@ export declare abstract class RestApiLambda extends CommonConstruct {
     protected constructor(parent: Construct, id: string, props: RestApiLambdaProps);
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     protected initResources(): void;
     /**
      * @summary Method to resolve secrets from SecretsManager
      * - To be implemented in the overriding method in the implementation class
-     * @protected
      */
     protected resolveSecrets(): void;
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @protected
      */
     protected resolveHostedZone(): void;
     /**
      * @summary Method to resolve a certificate based on attributes
-     * @protected
      */
     protected resolveCertificate(): void;
     /**
      * @summary Method to create iam policy for RestApi Lambda function
-     * @protected
      */
     protected createLambdaPolicy(): void;
     /**
      * @summary Method to create iam role for RestApi Lambda function
-     * @protected
      */
     protected createLambdaRole(): void;
     /**
      * @summary Method to create environment variables for RestApi Lambda function
-     * @protected
      */
     protected createLambdaEnvironment(): void;
     /**
      * @summary Method to create layers for RestApi Lambda function
-     * @protected
      */
     protected createLambdaLayers(): void;
     /**
      * @summary Method to create lambda function for RestApi
-     * @protected
      */
     protected createLambdaFunction(): void;
     /**
      * @summary Method to create rest restApiLambda for RestApi
-     * @protected
      */
     protected createRestApi(): void;
     protected abstract createRestApiResources(): void;
     /**
      * @summary Method to create custom restApiLambda domain for RestApi
-     * @protected
      */
     protected createApiDomain(): void;
     /**
      * @summary Method to create base path mappings for RestApi
-     * @protected
      */
     protected createApiBasePathMapping(): void;
     /**
      * @summary Method to create route53 records for RestApi
-     * @protected
      */
     protected createApiRouteAssets(): void;
     /**
      * @summary Method to deploy the changes to the RestApi
-     * @protected
      */
     protected createRestApiDeployment(): void;
 }

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

@@ -28,12 +28,9 @@ const apig = __importStar(require("aws-cdk-lib/aws-apigateway"));
 const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const common_1 = require("../../common");
 /**
- * @category cdk-utils.rest-api-lambda
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a RestApi as Lambda
  *
  * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
- *
  * @example
  * import { RestApiLambda, RestApiLambdaProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -46,7 +43,6 @@ const common_1 = require("../../common");
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class RestApiLambda extends common_1.CommonConstruct {
     /* restApiLambda props */
@@ -71,7 +67,6 @@ class RestApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources() {
         this.resolveSecrets();
@@ -92,21 +87,18 @@ class RestApiLambda extends common_1.CommonConstruct {
     /**
      * @summary Method to resolve secrets from SecretsManager
      * - To be implemented in the overriding method in the implementation class
-     * @protected
      */
     resolveSecrets() {
         this.applicationSecrets = [];
     }
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @protected
      */
     resolveHostedZone() {
         this.restApiHostedZone = this.route53Manager.withHostedZoneFromFullyQualifiedDomainName(`${this.id}-hosted-zone`, this, this.props.useExistingHostedZone);
     }
     /**
      * @summary Method to resolve a certificate based on attributes
-     * @protected
      */
     resolveCertificate() {
         if (this.props.restApiCertificate.useExistingCertificate &&
@@ -118,7 +110,6 @@ class RestApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam policy for RestApi Lambda function
-     * @protected
      */
     createLambdaPolicy() {
         this.restApiLambdaPolicy = new iam.PolicyDocument({
@@ -127,25 +118,22 @@ class RestApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam role for RestApi Lambda function
-     * @protected
      */
     createLambdaRole() {
         this.restApiLambdaRole = this.iamManager.createRoleForLambda(`${this.id}-lambda-role`, this, this.restApiLambdaPolicy);
     }
     /**
      * @summary Method to create environment variables for RestApi Lambda function
-     * @protected
      */
     createLambdaEnvironment() {
         this.restApiLambdaEnvironment = {
-            NODE_ENV: this.props.nodeEnv,
             LOG_LEVEL: this.props.logLevel,
+            NODE_ENV: this.props.nodeEnv,
             TZ: this.props.timezone,
         };
     }
     /**
      * @summary Method to create layers for RestApi Lambda function
-     * @protected
      */
     createLambdaLayers() {
         const layers = [];
@@ -158,21 +146,18 @@ class RestApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create lambda function for RestApi
-     * @protected
      */
     createLambdaFunction() {
         this.restApiLambdaFunction = this.lambdaManager.createLambdaFunction(`${this.id}-restapi-server`, this, this.props.restApiLambda, this.restApiLambdaRole, this.restApiLambdaLayers, this.props.restApiSource, this.props.restApiHandler || 'index.handler', this.restApiLambdaEnvironment);
     }
     /**
      * @summary Method to create rest restApiLambda for RestApi
-     * @protected
      */
     createRestApi() {
         this.restApi = this.apiManager.createLambdaRestApi(`${this.id}-lambda-rest-api`, this, this.props.restApi, this.restApiLambdaFunction);
     }
     /**
      * @summary Method to create custom restApiLambda domain for RestApi
-     * @protected
      */
     createApiDomain() {
         this.restApiDomain = this.apiManager.createApiDomain(`${this.id}-api-domain`, this, this.isProductionStage() || this.props.skipStageForARecords
@@ -181,7 +166,6 @@ class RestApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create base path mappings for RestApi
-     * @protected
      */
     createApiBasePathMapping() {
         const apiRootPaths = this.props.apiRootPaths;
@@ -205,14 +189,12 @@ class RestApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create route53 records for RestApi
-     * @protected
      */
     createApiRouteAssets() {
         this.route53Manager.createApiGatewayARecord(`${this.id}-custom-domain-a-record`, this, this.props.apiSubDomain, this.restApiDomain, this.restApiHostedZone, this.props.skipStageForARecords);
     }
     /**
      * @summary Method to deploy the changes to the RestApi
-     * @protected
      */
     createRestApiDeployment() {
         this.apiManager.createApiDeployment(`${this.id}-deployment`, this, this.restApi);

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

@@ -2,26 +2,22 @@ import { AcmProps, LambdaEnvironment, LambdaProps, LambdaRestApiProps } from '..
 import { CommonStackProps } from '../../common';
 import { AssetCode } from 'aws-cdk-lib/aws-lambda';
 /**
- * @category cdk-utils.rest-api-lambda
- * @subcategory Types
  */
 export interface RestApiLambdaEnvironment extends LambdaEnvironment {
 }
 /**
- * @category cdk-utils.rest-api-lambda
- * @subcategory Properties
  */
 export interface RestApiLambdaProps extends CommonStackProps {
     apiRootPaths?: string[];
     apiSubDomain: string;
-    restApiCertificate: AcmProps;
+    logLevel: string;
+    nodeEnv: string;
     restApi: LambdaRestApiProps;
-    restApiLambdaLayerSources?: AssetCode[];
+    restApiCertificate: AcmProps;
     restApiHandler: string;
-    restApiSource: AssetCode;
     restApiLambda: LambdaProps;
-    useExistingHostedZone: boolean;
-    nodeEnv: string;
-    logLevel: string;
+    restApiLambdaLayerSources?: AssetCode[];
+    restApiSource: AssetCode;
     timezone: string;
+    useExistingHostedZone: boolean;
 }

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

@@ -4,13 +4,9 @@ import { Construct } from 'constructs';
 import { RestApiLambda } from '..';
 import { RestApiLambdaWithCacheProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.rest-api-lambda-with-cache
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a RestApi API as Lambda with Caching
  *
  * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
- *
  * @example
  * import { RestApiLambdaWithCacheProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -23,7 +19,6 @@ import { RestApiLambdaWithCacheProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare abstract class RestApiLambdaWithCache extends RestApiLambda {
     props: RestApiLambdaWithCacheProps;
@@ -36,32 +31,26 @@ export declare abstract class RestApiLambdaWithCache extends RestApiLambda {
     protected initResources(): void;
     /**
      * Create VPC
-     * @protected
      */
     protected resolveVpc(): void;
     /**
      * Resolve Security Group
-     * @protected
      */
     protected resolveSecurityGroup(): void;
     /**
      * Create ElastiCache
-     * @protected
      */
     protected createElastiCache(): void;
     /**
      * Create Lambda Role
-     * @protected
      */
     protected createLambdaRole(): void;
     /**
      * @summary Method to create environment variables for RestApi Lambda function
-     * @protected
      */
     protected createLambdaEnvironment(): void;
     /**
      * @summary Method to create lambda function for RestApi API
-     * @protected
      */
     protected createLambdaFunction(): void;
 }

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

@@ -30,13 +30,9 @@ const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const __1 = require("..");
 const utils = __importStar(require("../../utils"));
 /**
- * @stability stable
- * @category cdk-utils.rest-api-lambda-with-cache
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a RestApi API as Lambda with Caching
  *
  * <b>Architecture</b><br/> ![Architecture](./RestApiLambda.jpg)
- *
  * @example
  * import { RestApiLambdaWithCacheProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -49,7 +45,6 @@ const utils = __importStar(require("../../utils"));
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class RestApiLambdaWithCache extends __1.RestApiLambda {
     /* restApiLambdaWithCache props */
@@ -73,7 +68,6 @@ class RestApiLambdaWithCache extends __1.RestApiLambda {
     }
     /**
      * Create VPC
-     * @protected
      */
     resolveVpc() {
         if (this.props.useExistingVpc) {
@@ -85,7 +79,6 @@ class RestApiLambdaWithCache extends __1.RestApiLambda {
     }
     /**
      * Resolve Security Group
-     * @protected
      */
     resolveSecurityGroup() {
         if (!this.props.restApiCache) {
@@ -105,7 +98,6 @@ class RestApiLambdaWithCache extends __1.RestApiLambda {
     }
     /**
      * Create ElastiCache
-     * @protected
      */
     createElastiCache() {
         if (!this.props.restApiCache) {
@@ -113,19 +105,18 @@ class RestApiLambdaWithCache extends __1.RestApiLambda {
         }
         this.restApiCache = this.elasticacheManager.createReplicatedElastiCache(`${this.id}-elasticache`, this, this.props.restApiCache, this.restApivpc.privateSubnets.map(subnet => subnet.subnetId), [this.restApiSecurityGroup.securityGroupId]);
         this.ssmManager.writeStringToParameters(`${this.id}-elasticache-endpoint-address`, this, {
-            parameterName: `${this.id}-elasticache-endpoint-address`,
             description: `Elasticache address to use by applications`,
+            parameterName: `${this.id}-elasticache-endpoint-address`,
             stringValue: this.restApiCache.attrConfigurationEndPointAddress,
         });
         this.ssmManager.writeStringToParameters(`${this.id}-elasticache-endpoint-port`, this, {
-            parameterName: `${this.id}-elasticache-endpoint-port`,
             description: `Elasticache port to use by applications`,
+            parameterName: `${this.id}-elasticache-endpoint-port`,
             stringValue: this.restApiCache.attrConfigurationEndPointPort,
         });
     }
     /**
      * Create Lambda Role
-     * @protected
      */
     createLambdaRole() {
         super.createLambdaRole();
@@ -133,18 +124,16 @@ class RestApiLambdaWithCache extends __1.RestApiLambda {
     }
     /**
      * @summary Method to create environment variables for RestApi Lambda function
-     * @protected
      */
     createLambdaEnvironment() {
         this.restApiLambdaEnvironment = {
-            NODE_ENV: this.props.nodeEnv,
             LOG_LEVEL: this.props.logLevel,
+            NODE_ENV: this.props.nodeEnv,
             TZ: this.props.timezone,
         };
     }
     /**
      * @summary Method to create lambda function for RestApi API
-     * @protected
      */
     createLambdaFunction() {
         this.restApiLambdaFunction = this.lambdaManager.createLambdaFunction(`${this.id}-restapi-server`, this, this.props.restApiLambda, this.restApiLambdaRole, this.restApiLambdaLayers, this.props.restApiSource, this.props.restApiHandler || 'index.handler', this.restApiLambdaEnvironment, this.restApivpc, [this.restApiSecurityGroup], undefined, undefined, this.restApivpc);

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

@@ -2,12 +2,10 @@ import { RestApiLambdaProps } from '../rest-api-lambda';
 import { VpcProps } from 'aws-cdk-lib/aws-ec2';
 import { ReplicatedElastiCacheProps } from '../../services';
 /**
- * @category cdk-utils.rest-api-lambda-with-cache
- * @subcategory Properties
  */
 export interface RestApiLambdaWithCacheProps extends RestApiLambdaProps {
-    restApiVpc: VpcProps;
     restApiCache: ReplicatedElastiCacheProps;
+    restApiVpc: VpcProps;
     securityGroupExportName: string;
     useExistingVpc: boolean;
     vpcName?: string;

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

@@ -13,11 +13,7 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common';
 import { SiteWithEcsBackendProps } from './types';
 /**
- * @stability stable
- * @category cdk-utils.site-with-ecs-backend
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a site hosted with an clustered ECS/ELB backend
- *
  * @example
  * import { SiteWithEcsBackend, SiteWithEcsBackendProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -30,7 +26,6 @@ import { SiteWithEcsBackendProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class SiteWithEcsBackend extends CommonConstruct {
     props: SiteWithEcsBackendProps;
@@ -66,104 +61,84 @@ export declare class SiteWithEcsBackend extends CommonConstruct {
     constructor(parent: Construct, id: string, props: SiteWithEcsBackendProps);
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     protected initResources(): void;
     /**
      * @summary Method to resolve a hosted zone based on domain attributes
-     * @protected
      */
     protected resolveHostedZone(): void;
     /**
      * @summary Method to resolve a certificate based on attributes
-     * @protected
      */
     protected resolveCertificate(): void;
     /**
      * @summary Method to resolve secrets from SecretsManager
      * - To be implemented in the overriding method in the implementation class
-     * @protected
      */
     protected resolveSiteSecrets(): void;
     /**
      * @summary Method to resolve site domain names
-     * @protected
      */
     protected resolveSiteDomainNames(): void;
     /**
      * Create VPC
-     * @protected
      */
     protected createVpc(): void;
     /**
      * @summary Method to create iam policy for ECS Task
-     * @protected
      */
     protected createEcsPolicy(): void;
     /**
      * @summary Method to create iam role for ECS Task
-     * @protected
      */
     protected createEcsRole(): void;
     /**
      * @summary Method to create environment variables used by ECS task
-     * @protected
      */
     protected createEcsEnvironment(): void;
     /**
      * Method to create an ECS cluster
-     * @protected
      */
     protected createEcsCluster(): void;
     /**
      * Method to create log group used by ECS task
-     * @protected
      */
     protected createEcsLogGroup(): void;
     /**
      * Method to create docker build arguments for ECS Image step
-     * @protected
      */
     protected createEcsBuildArgs(): void;
     /**
      * Method to create container image for ECS task
-     * @protected
      */
     protected createEcsContainerImage(): void;
     /**
      * Method to create Application Loadbalanced ECS Fargate Service
-     * @protected
      */
     protected createEcsService(): void;
     /**
      * Method to create log bucket for site distribution
-     * @protected
      */
     protected createSiteLogBucket(): void;
     protected createSiteOrigin(): void;
     /**
      * @summary Method to create a site cloudfront function
-     * @protected
      */
     protected createSiteCloudfrontFunction(): void;
     /**
      * @summary Method to create a site cloudfront function associations
-     * @protected
      */
     protected resolveSiteFunctionAssociations(): void;
     /**
      * Method to create Site distribution
-     * @protected
      */
     protected createDistribution(): void;
     /**
      * Method to create Route53 records for distribution
-     * @protected
      */
     protected createNetworkMappings(): void;
     /**
      * Method to invalidation the cloudfront distribution cache after a deployment
-     * @protected
      */
     protected invalidateDistributionCache(): void;
 }