@gradientedge/cdk-utils 8.90.0 → 8.92.0

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

@@ -31,7 +31,6 @@ const lambda = __importStar(require("aws-cdk-lib/aws-lambda"));
 const common_1 = require("../../common");
 const api_1 = require("./api");
 /**
- * @mixin
  */
 class ApiToLambdaTarget extends common_1.CommonConstruct {
     props;
@@ -70,21 +69,18 @@ class ApiToLambdaTarget 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.apiToLambdaTargetRestApi.hostedZone = 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.api.useExisting)
@@ -98,38 +94,36 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration method response
-     * @protected
      */
     createApiToLambdaTargetMethodResponse() {
         if (!this.props.api.withResource)
             return;
         this.apiToLambdaTargetRestApi.methodResponse = {
             ...{
-                statusCode: '200',
                 responseParameters: {
-                    'method.response.header.Content-Type': true,
-                    'method.response.header.Access-Control-Allow-Origin': true,
                     'method.response.header.Access-Control-Allow-Credentials': true,
+                    'method.response.header.Access-Control-Allow-Origin': true,
+                    'method.response.header.Content-Type': true,
                 },
+                statusCode: '200',
             },
             ...this.props.api.methodResponse,
         };
     }
     /**
      * @summary Method to create api integration method error response
-     * @protected
      */
     createApiToLambdaTargetMethodErrorResponse() {
         if (!this.props.api.withResource)
             return;
         this.apiToLambdaTargetRestApi.methodErrorResponse = {
             ...{
-                statusCode: '400',
                 responseParameters: {
-                    'method.response.header.Content-Type': true,
-                    'method.response.header.Access-Control-Allow-Origin': true,
                     'method.response.header.Access-Control-Allow-Credentials': true,
+                    'method.response.header.Access-Control-Allow-Origin': true,
+                    'method.response.header.Content-Type': true,
                 },
+                statusCode: '400',
             },
             ...this.props.api.methodErrorResponse,
         };
@@ -139,7 +133,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create rest restApi for Api
-     * @protected
      */
     createApiToLambdaTargetRestApi() {
         if (this.props.api.useExisting && this.props.api.importedRestApiRef) {
@@ -170,7 +163,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration resource
-     * @protected
      */
     createApiToLambdaTargetResource() {
         if (!this.props.api.withResource)
@@ -178,9 +170,9 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
         let rootResource;
         if (this.props.api.withResource && this.props.api.importedRestApiRootResourceRef) {
             rootResource = apig.Resource.fromResourceAttributes(this, `${this.id}-root-resource`, {
+                path: '/',
                 resourceId: cdk.Fn.importValue(this.props.api.importedRestApiRootResourceRef),
                 restApi: this.apiToLambdaTargetRestApi.api,
-                path: '/',
             });
         }
         else {
@@ -198,7 +190,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a role for api integration
-     * @protected
      */
     createApiToLambdaTargetRole() {
         if (!this.apiToLambdaTargetRestApi.policy)
@@ -210,7 +201,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration resource method
-     * @protected
      */
     createApiToLambdaTargetIntegration() {
         this.apiToLambdaTargetRestApi.integration = new apig.LambdaIntegration(this.apiToLambdaTargetRestApi.lambda, {
@@ -220,7 +210,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration resource method
-     * @protected
      */
     createApiToLambdaTargetResourceMethod() {
         if (!this.props.api.withResource)
@@ -235,7 +224,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create custom restApi domain for Api
-     * @protected
      */
     createApiDomain() {
         if (this.props.api.useExisting)
@@ -246,7 +234,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create base path mappings for Api
-     * @protected
      */
     createApiBasePathMapping() {
         if (this.props.api.useExisting)
@@ -260,7 +247,6 @@ class ApiToLambdaTarget extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create route53 records for Api
-     * @protected
      */
     createApiRouteAssets() {
         if (this.props.api.useExisting)

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

@@ -7,8 +7,6 @@ import { IFunction } from 'aws-cdk-lib/aws-lambda';
 import { ITopic } from 'aws-cdk-lib/aws-sns';
 import { PolicyDocument, Role } from 'aws-cdk-lib/aws-iam';
 /**
- * @category cdk-utils.api-to-lambda-target
- * @subcategory Types
  */
 export interface ApiToLambdaTargetRestApiType {
     api: IRestApi;
@@ -31,35 +29,31 @@ export interface ApiToLambdaTargetRestApiType {
     method: Method;
     methodErrorResponse: MethodResponse;
     methodResponse: MethodResponse;
+    policy?: PolicyDocument;
     resource: Resource;
     responseModel: Model;
-    topic?: ITopic;
     role?: Role;
-    policy?: PolicyDocument;
+    topic?: ITopic;
 }
 /**
- * @category cdk-utils.api-to-lambda-target
- * @subcategory Properties
  */
 export interface ApiToLambdaTargetRestApiProps {
-    resource: string;
     certificate: AcmProps;
-    restApi: LambdaRestApiProps;
     importedRestApiRef?: string;
     importedRestApiRootResourceRef?: string;
-    useExisting: boolean;
-    withResource?: boolean;
     methodErrorResponse: MethodResponse;
     methodResponse: MethodResponse;
+    resource: string;
+    restApi: LambdaRestApiProps;
+    useExisting: boolean;
+    withResource?: boolean;
 }
 /**
- * @category cdk-utils.api-to-lambda-target
- * @subcategory Properties
  */
 export interface ApiToLambdaTargetProps extends CommonStackProps {
+    api: ApiToLambdaTargetRestApiProps;
     apiRootPaths?: string[];
     apiSubDomain: string;
-    api: ApiToLambdaTargetRestApiProps;
     lambdaFunctionName: string;
     logLevel: string;
     nodeEnv: string;

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

@@ -9,13 +9,9 @@ import { CommonConstruct } from '../../common';
 import { GraphQlApiLambdaEnvironment, GraphQlApiLambdaProps } from './types';
 /**
  * @deprecated Use RestApiLambda instead. This will be removed in a future release.
- *
- * @category cdk-utils.graphql-api-lambda
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a Graphql API as Lambda
  *
  * <b>Architecture</b><br/> ![Architecture](./GraphQLApiLambda.jpg)
- *
  * @example
  * import { GraphQLApiLambda, GraphQlApiLambdaProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -28,7 +24,6 @@ import { GraphQlApiLambdaEnvironment, GraphQlApiLambdaProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class GraphQLApiLambda extends CommonConstruct {
     props: GraphQlApiLambdaProps;
@@ -47,68 +42,55 @@ export declare class GraphQLApiLambda extends CommonConstruct {
     constructor(parent: Construct, id: string, props: GraphQlApiLambdaProps);
     /**
      * @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 GraphQL Lambda function
-     * @protected
      */
     protected createLambdaPolicy(): void;
     /**
      * @summary Method to create iam role for GraphQL Lambda function
-     * @protected
      */
     protected createLambdaRole(): void;
     /**
      * @summary Method to create environment variables for GraphQL Lambda function
-     * @protected
      */
     protected createLambdaEnvironment(): void;
     /**
      * @summary Method to create layers for GraphQL Lambda function
-     * @protected
      */
     protected createLambdaLayers(): void;
     /**
      * @summary Method to create lambda function for GraphQL
-     * @protected
      */
     protected createLambdaFunction(): void;
     /**
      * @summary Method to create rest restApi for GraphQL
-     * @protected
      */
     protected createRestApi(): void;
     /**
      * @summary Method to create custom restApi domain for GraphQL API
-     * @protected
      */
     protected createApiDomain(): void;
     /**
      * @summary Method to create base path mappings for GraphQL API
-     * @protected
      */
     protected createApiBasePathMapping(): void;
     /**
      * @summary Method to create route53 records for GraphQL API
-     * @protected
      */
     protected createApiRouteAssets(): void;
 }

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

@@ -29,13 +29,9 @@ const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const common_1 = require("../../common");
 /**
  * @deprecated Use RestApiLambda instead. This will be removed in a future release.
- *
- * @category cdk-utils.graphql-api-lambda
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a Graphql API as Lambda
  *
  * <b>Architecture</b><br/> ![Architecture](./GraphQLApiLambda.jpg)
- *
  * @example
  * import { GraphQLApiLambda, GraphQlApiLambdaProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -48,7 +44,6 @@ const common_1 = require("../../common");
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class GraphQLApiLambda extends common_1.CommonConstruct {
     /* graphql restApi props */
@@ -73,7 +68,6 @@ class GraphQLApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources() {
         this.resolveSecrets();
@@ -92,21 +86,18 @@ class GraphQLApiLambda 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.graphQLApiHostedZone = 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.graphQLApiCertificate.useExistingCertificate &&
@@ -118,7 +109,6 @@ class GraphQLApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam policy for GraphQL Lambda function
-     * @protected
      */
     createLambdaPolicy() {
         this.graphQLApiLambdaPolicy = new iam.PolicyDocument({
@@ -127,25 +117,22 @@ class GraphQLApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam role for GraphQL Lambda function
-     * @protected
      */
     createLambdaRole() {
         this.graphQLApiLambdaRole = this.iamManager.createRoleForLambda(`${this.id}-lambda-role`, this, this.graphQLApiLambdaPolicy);
     }
     /**
      * @summary Method to create environment variables for GraphQL Lambda function
-     * @protected
      */
     createLambdaEnvironment() {
         this.graphQLApiLambdaEnvironment = {
-            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 GraphQL Lambda function
-     * @protected
      */
     createLambdaLayers() {
         const layers = [];
@@ -158,21 +145,18 @@ class GraphQLApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create lambda function for GraphQL
-     * @protected
      */
     createLambdaFunction() {
         this.graphQLApiLambdaFunction = this.lambdaManager.createLambdaFunction(`${this.id}-graphql-server`, this, this.props.graphqlApi, this.graphQLApiLambdaRole, this.graphQLApiLambdaLayers, this.props.graphQLApiSource, this.props.graphQLApiHandler || 'index.handler', this.graphQLApiLambdaEnvironment);
     }
     /**
      * @summary Method to create rest restApi for GraphQL
-     * @protected
      */
     createRestApi() {
         this.graphQLApi = this.apiManager.createLambdaRestApi(`${this.id}-lambda-rest-api`, this, this.props.graphqlRestApi, this.graphQLApiLambdaFunction);
     }
     /**
      * @summary Method to create custom restApi domain for GraphQL API
-     * @protected
      */
     createApiDomain() {
         this.graphQLApiDomain = this.apiManager.createApiDomain(`${this.id}-api-domain`, this, this.isProductionStage() || this.props.skipStageForARecords
@@ -181,7 +165,6 @@ class GraphQLApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create base path mappings for GraphQL API
-     * @protected
      */
     createApiBasePathMapping() {
         const apiRootPaths = this.props.apiRootPaths;
@@ -205,7 +188,6 @@ class GraphQLApiLambda extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create route53 records for GraphQL API
-     * @protected
      */
     createApiRouteAssets() {
         this.route53Manager.createApiGatewayARecord(`${this.id}-custom-domain-a-record`, this, this.props.apiSubDomain, this.graphQLApiDomain, this.graphQLApiHostedZone, this.props.skipStageForARecords);

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

@@ -4,27 +4,23 @@ import { LambdaRestApiProps } from 'aws-cdk-lib/aws-apigateway';
 import { AssetCode } from 'aws-cdk-lib/aws-lambda';
 /**
  * @deprecated Use RestApiLambdaEnvironment instead. This will be removed in a future release.
- * @category cdk-utils.graphql-api-lambda
- * @subcategory Types
  */
 export interface GraphQlApiLambdaEnvironment extends LambdaEnvironment {
 }
 /**
  * @deprecated Use RestApiLambdaProps instead. This will be removed in a future release.
- * @category cdk-utils.graphql-api-lambda
- * @subcategory Properties
  */
 export interface GraphQlApiLambdaProps extends CommonStackProps {
     apiRootPaths?: string[];
     apiSubDomain: string;
     graphQLApiCertificate: AcmProps;
-    graphqlRestApi: LambdaRestApiProps;
-    graphqlApiLambdaLayerSources?: AssetCode[];
     graphQLApiHandler: string;
     graphQLApiSource: AssetCode;
     graphqlApi: LambdaProps;
-    useExistingHostedZone: boolean;
-    nodeEnv: string;
+    graphqlApiLambdaLayerSources?: AssetCode[];
+    graphqlRestApi: LambdaRestApiProps;
     logLevel: string;
+    nodeEnv: string;
     timezone: string;
+    useExistingHostedZone: boolean;
 }

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

@@ -5,13 +5,9 @@ import { GraphQLApiLambda } from '..';
 import { GraphQlApiLambdaWithCacheProps } from './types';
 /**
  * @deprecated Use RestApiLambdaWithCache instead. This will be removed in a future release.
- *
- * @category cdk-utils.graphql-api-lambda-with-cache
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a Graphql API as Lambda with Caching
  *
  * <b>Architecture</b><br/> ![Architecture](./GraphQLApiLambda.jpg)
- *
  * @example
  * import { GraphQlApiLambdaWithCacheProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -24,7 +20,6 @@ import { GraphQlApiLambdaWithCacheProps } from './types';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class GraphQLApiLambdaWithCache extends GraphQLApiLambda {
     props: GraphQlApiLambdaWithCacheProps;
@@ -37,32 +32,26 @@ export declare class GraphQLApiLambdaWithCache extends GraphQLApiLambda {
     protected initResources(): void;
     /**
      * Create VPC
-     * @protected
      */
     protected setVpc(): void;
     /**
      * Resolve Security Group
-     * @protected
      */
     protected setSecurityGroup(): void;
     /**
      * Create ElastiCache
-     * @protected
      */
     protected createElastiCache(): void;
     /**
      * Create Lambda Role
-     * @protected
      */
     protected createLambdaRole(): void;
     /**
      * @summary Method to create environment variables for GraphQL Lambda function
-     * @protected
      */
     protected createLambdaEnvironment(): void;
     /**
      * @summary Method to create lambda function for GraphQL API
-     * @protected
      */
     protected createLambdaFunction(): void;
 }

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

@@ -31,13 +31,9 @@ const __1 = require("..");
 const utils = __importStar(require("../../utils"));
 /**
  * @deprecated Use RestApiLambdaWithCache instead. This will be removed in a future release.
- *
- * @category cdk-utils.graphql-api-lambda-with-cache
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy a Graphql API as Lambda with Caching
  *
  * <b>Architecture</b><br/> ![Architecture](./GraphQLApiLambda.jpg)
- *
  * @example
  * import { GraphQlApiLambdaWithCacheProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -50,7 +46,6 @@ const utils = __importStar(require("../../utils"));
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class GraphQLApiLambdaWithCache extends __1.GraphQLApiLambda {
     /* graphql restApi props */
@@ -74,7 +69,6 @@ class GraphQLApiLambdaWithCache extends __1.GraphQLApiLambda {
     }
     /**
      * Create VPC
-     * @protected
      */
     setVpc() {
         if (this.props.useExistingVpc) {
@@ -86,7 +80,6 @@ class GraphQLApiLambdaWithCache extends __1.GraphQLApiLambda {
     }
     /**
      * Resolve Security Group
-     * @protected
      */
     setSecurityGroup() {
         if (this.props.securityGroupExportName) {
@@ -103,14 +96,12 @@ class GraphQLApiLambdaWithCache extends __1.GraphQLApiLambda {
     }
     /**
      * Create ElastiCache
-     * @protected
      */
     createElastiCache() {
         this.graphQLElastiCache = this.elasticacheManager.createReplicatedElastiCache(`${this.id}-elasticache`, this, this.props.graphQLElastiCache, this.graphQLVpc.privateSubnets.map(subnet => subnet.subnetId), [this.graphQLSecurityGroup.securityGroupId]);
     }
     /**
      * Create Lambda Role
-     * @protected
      */
     createLambdaRole() {
         super.createLambdaRole();
@@ -118,18 +109,16 @@ class GraphQLApiLambdaWithCache extends __1.GraphQLApiLambda {
     }
     /**
      * @summary Method to create environment variables for GraphQL Lambda function
-     * @protected
      */
     createLambdaEnvironment() {
         this.graphQLApiLambdaEnvironment = {
-            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 GraphQL API
-     * @protected
      */
     createLambdaFunction() {
         this.graphQLApiLambdaFunction = this.lambdaManager.createLambdaFunction(`${this.id}-graphql-server`, this, this.props.graphqlApi, this.graphQLApiLambdaRole, this.graphQLApiLambdaLayers, this.props.graphQLApiSource, this.props.graphQLApiHandler || 'index.handler', this.graphQLApiLambdaEnvironment, this.graphQLVpc, [this.graphQLSecurityGroup], undefined, undefined, this.graphQLVpc);

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

@@ -3,12 +3,10 @@ import { VpcProps } from 'aws-cdk-lib/aws-ec2';
 import { ReplicatedElastiCacheProps } from '../../services';
 /**
  * @deprecated Use RestApiLambdaWithCacheProps instead. This will be removed in a future release.
- * @category cdk-utils.graphql-api-lambda-with-cache
- * @subcategory Properties
  */
 export interface GraphQlApiLambdaWithCacheProps extends GraphQlApiLambdaProps {
-    graphQLVpc: VpcProps;
     graphQLElastiCache: ReplicatedElastiCacheProps;
+    graphQLVpc: VpcProps;
     securityGroupExportName: string;
     useExistingVpc: boolean;
     vpcName?: string;

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

@@ -5,10 +5,7 @@ import * as iam from 'aws-cdk-lib/aws-iam';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
 import * as secretsManager from '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'
@@ -21,7 +18,6 @@ import * as secretsManager from 'aws-cdk-lib/aws-secretsmanager';
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export declare class LambdaWithIamAccess extends CommonConstruct {
     props: LambdaWithIamAccessProps;
@@ -37,42 +33,34 @@ export declare class LambdaWithIamAccess extends CommonConstruct {
     constructor(parent: Construct, id: string, props: LambdaWithIamAccessProps);
     /**
      * @summary Initialise and provision resources
-     * @protected
      */
     initResources(): void;
     /**
      * @summary Method to create iam policy for Lambda function
-     * @protected
      */
     protected createLambdaPolicy(): void;
     /**
      * @summary Method to create iam role for Lambda function
-     * @protected
      */
     protected createLambdaRole(): void;
     /**
      * @summary Method to create environment variables for Lambda function
-     * @protected
      */
     protected createLambdaEnvironment(): void;
     /**
      * @summary Method to create layers for Lambda function
-     * @protected
      */
     protected createLambdaLayers(): void;
     /**
      * @summary Method to create lambda function
-     * @protected
      */
     protected createLambdaFunction(): void;
     /**
      * @summary Method to create iam user for the lambda function
-     * @protected
      */
     protected createIamUserForLambdaFunction(): void;
     /**
      * @summary Method to create iam secret for the lambda function
-     * @protected
      */
     protected createIamSecretForLambdaFunction(): void;
 }