@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/dist/src/lib/construct/api-to-eventbridge-target-with-sns/main.js

@@ -35,14 +35,9 @@ const api_destined_lambda_1 = require("./api-destined-lambda");
 const api_to_eventbridge_target_1 = require("../api-to-eventbridge-target");
 /**
  * @deprecated Use ApiToEventBridgeTarget instead. This will be removed in a future release.
- *
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory construct
  * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
  *
  * <b>Architecture</b><br/> ![Architecture](./ApiToEventBridgeTargetWithSns.jpg)
- *
  * @example
  * import { ApiToEventBridgeTargetWithSns, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -55,7 +50,6 @@ const api_to_eventbridge_target_1 = require("../api-to-eventbridge-target");
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     props;
@@ -120,21 +114,18 @@ class ApiToEventBridgeTargetWithSns 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.apiDestinedRestApi.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)
@@ -148,7 +139,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam policy for Api Destined Lambda function
-     * @protected
      */
     createApiDestinedLambdaPolicy() {
         if (this.props.api.useExisting)
@@ -159,7 +149,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create iam role for Api Destined Lambda function
-     * @protected
      */
     createApiDestinedLambdaRole() {
         if (this.props.api.useExisting)
@@ -168,21 +157,19 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create environment variables for Api Destined Lambda function
-     * @protected
      */
     createApiDestinedLambdaEnvironment() {
         if (this.props.api.useExisting)
             return;
         this.apiDestinedLambda.environment = {
-            NODE_ENV: this.props.nodeEnv,
             LOG_LEVEL: this.props.logLevel,
-            TZ: this.props.timezone,
+            NODE_ENV: this.props.nodeEnv,
             SOURCE_ID: this.id,
+            TZ: this.props.timezone,
         };
     }
     /**
      * @summary Method to create layers for Api Destined Lambda function
-     * @protected
      */
     createApiDestinedLambdaLayers() {
         if (this.props.api.useExisting)
@@ -195,7 +182,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create destination for Api Destined function
-     * @protected
      */
     createApiDestinedLambdaDestinations() {
         if (this.props.api.useExisting)
@@ -205,7 +191,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create lambda function for Api Destined
-     * @protected
      */
     createApiDestinedLambdaFunction() {
         if (this.props.api.useExisting)
@@ -215,14 +200,13 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
         this.apiDestinedLambda.function = this.lambdaManager.createLambdaFunction(`${this.id}-lambda-destined`, this, {
             ...this.props.lambda.function,
             ...{
-                onSuccess: this.apiDestinedLambda.destinationSuccess,
                 onFailure: this.apiDestinedLambda.destinationFailure,
+                onSuccess: this.apiDestinedLambda.destinationSuccess,
             },
         }, this.apiDestinedLambda.role, this.apiDestinedLambda.layers, this.props.lambda.source, this.props.lambda.handler ?? 'lambda.handler', this.apiDestinedLambda.environment);
     }
     /**
      * @summary Method to create or use an existing eventbus for api destined payload deliveries
-     * @protected
      */
     createApiDestinedEventBus() {
         if (this.props.api.useExisting) {
@@ -235,7 +219,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a log group for successful api destined payload deliveries
-     * @protected
      */
     createApiDestinationLogGroupSuccess() {
         if (this.props.api.useExisting)
@@ -249,14 +232,12 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * Method to create EventBridge rule with lambda target for success
-     * @protected
      */
     createApiDestinationRuleSuccess() {
         if (this.props.api.useExisting)
             return;
         this.props.event.ruleSuccess = {
             ...{
-                ruleName: `${this.id}-api-destination-success`,
                 eventPattern: {
                     detail: {
                         requestContext: {
@@ -268,6 +249,7 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
                         },
                     },
                 },
+                ruleName: `${this.id}-api-destination-success`,
             },
             ...this.props.event.ruleSuccess,
         };
@@ -275,7 +257,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a log group for failed api destined payload deliveries
-     * @protected
      */
     createApiDestinationLogGroupFailure() {
         if (this.props.api.useExisting)
@@ -289,14 +270,12 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * Method to create EventBridge rule with lambda target for failure
-     * @protected
      */
     createApiDestinationRuleFailure() {
         if (this.props.api.useExisting)
             return;
         this.props.event.ruleFailure = {
             ...{
-                ruleName: `${this.id}-api-destination-failure`,
                 eventPattern: {
                     detail: {
                         responsePayload: {
@@ -304,6 +283,7 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
                         },
                     },
                 },
+                ruleName: `${this.id}-api-destination-failure`,
             },
             ...this.props.event.ruleFailure,
         };
@@ -311,7 +291,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create a role for sns topic
-     * @protected
      */
     createApiDestinedTopicRole() {
         this.apiDestinedRestApi.role = new iam.Role(this, `${this.id}-sns-rest-api-role`, {
@@ -320,7 +299,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create API destined SNS topic
-     * @protected
      */
     createApiDestinedTopic() {
         if (!this.props.api.withResource)
@@ -334,7 +312,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration request parameters
-     * @protected
      */
     createApiDestinedIntegrationRequestParameters() {
         if (!this.props.api.withResource)
@@ -345,7 +322,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration request templates
-     * @protected
      */
     createApiDestinedIntegrationRequestTemplates() {
         if (!this.props.api.withResource)
@@ -363,119 +339,113 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration response
-     * @protected
      */
     createApiDestinedIntegrationResponse() {
         if (!this.props.api.withResource)
             return;
         this.apiDestinedRestApi.integrationResponse = this.props.api.integrationResponse ?? {
             ...{
-                statusCode: '200',
                 responseTemplates: {
                     'application/json': JSON.stringify({ message: 'Payload Submitted' }),
                 },
+                statusCode: '200',
             },
         };
     }
     /**
      * @summary Method to create api integration error response
-     * @protected
      */
     createApiDestinedIntegrationErrorResponse() {
         if (!this.props.api.withResource)
             return;
         this.apiDestinedRestApi.integrationErrorResponse = {
             ...{
-                selectionPattern: '^\\[Error\\].*',
-                statusCode: '400',
+                responseParameters: {
+                    'method.response.header.Access-Control-Allow-Credentials': "'true'",
+                    'method.response.header.Access-Control-Allow-Origin': "'*'",
+                    'method.response.header.Content-Type': "'application/json'",
+                },
                 responseTemplates: {
                     'application/json': JSON.stringify({
-                        state: 'error',
                         message: "$util.escapeJavaScript($input.path('$.errorMessage'))",
+                        state: 'error',
                     }),
                 },
-                responseParameters: {
-                    'method.response.header.Content-Type': "'application/json'",
-                    'method.response.header.Access-Control-Allow-Origin': "'*'",
-                    'method.response.header.Access-Control-Allow-Credentials': "'true'",
-                },
+                selectionPattern: '^\\[Error\\].*',
+                statusCode: '400',
             },
             ...this.props.api.integrationErrorResponse,
         };
     }
     /**
      * @summary Method to create api integration
-     * @protected
      */
     createApiDestinedIntegration() {
         if (!this.props.api.withResource)
             return;
         this.apiDestinedRestApi.integration = new apig.Integration({
-            type: apig.IntegrationType.AWS,
             integrationHttpMethod: 'POST',
-            uri: `arn:aws:apigateway:${this.props.region}:sns:path//`,
             options: {
                 ...{
                     credentialsRole: this.apiDestinedRestApi.role,
-                    requestParameters: this.apiDestinedRestApi.integrationRequestParameters,
-                    requestTemplates: this.apiDestinedRestApi.integrationRequestTemplates,
-                    passthroughBehavior: apig.PassthroughBehavior.NEVER,
                     integrationResponses: [
                         this.apiDestinedRestApi.integrationResponse,
                         this.apiDestinedRestApi.integrationErrorResponse,
                     ],
+                    passthroughBehavior: apig.PassthroughBehavior.NEVER,
+                    requestParameters: this.apiDestinedRestApi.integrationRequestParameters,
+                    requestTemplates: this.apiDestinedRestApi.integrationRequestTemplates,
                 },
                 ...this.props.api.integrationOptions,
             },
+            type: apig.IntegrationType.AWS,
+            uri: `arn:aws:apigateway:${this.props.region}:sns:path//`,
         });
     }
     /**
      * @summary Method to create api integration method response
-     * @protected
      */
     createApiDestinedMethodResponse() {
         if (!this.props.api.withResource)
             return;
         this.apiDestinedRestApi.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,
-                },
                 responseModels: {
                     'application/json': this.apiDestinedRestApi.responseModel,
                 },
+                responseParameters: {
+                    '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
      */
     createApiDestinedMethodErrorResponse() {
         if (!this.props.api.withResource)
             return;
         this.apiDestinedRestApi.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,
-                },
                 responseModels: {
                     'application/json': this.apiDestinedRestApi.errorResponseModel,
                 },
+                responseParameters: {
+                    '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,
         };
     }
     /**
      * @summary Method to create rest restApi for Api
-     * @protected
      */
     createApiDestinedRestApi() {
         if (this.props.api.useExisting && this.props.api.importedRestApiRef) {
@@ -488,27 +458,27 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
         });
         this.apiDestinedRestApi.api = new apig.RestApi(this, `${this.id}-sns-rest-api`, {
             ...{
+                defaultCorsPreflightOptions: {
+                    allowHeaders: apig.Cors.DEFAULT_HEADERS,
+                    allowMethods: ['POST'],
+                    allowOrigins: apig.Cors.ALL_ORIGINS,
+                },
                 defaultIntegration: this.apiDestinedRestApi.integration,
                 defaultMethodOptions: {
                     methodResponses: [this.apiDestinedRestApi.methodResponse, this.apiDestinedRestApi.methodErrorResponse],
                 },
                 deployOptions: {
+                    accessLogDestination: new apig.LogGroupLogDestination(accessLogGroup),
+                    accessLogFormat: apig.AccessLogFormat.jsonWithStandardFields(),
                     dataTraceEnabled: true,
                     description: `${this.id} - ${this.props.stage} stage`,
                     loggingLevel: apig.MethodLoggingLevel.INFO,
                     metricsEnabled: true,
                     stageName: this.props.stage,
-                    accessLogDestination: new apig.LogGroupLogDestination(accessLogGroup),
-                    accessLogFormat: apig.AccessLogFormat.jsonWithStandardFields(),
                 },
                 endpointConfiguration: {
                     types: [apig.EndpointType.REGIONAL],
                 },
-                defaultCorsPreflightOptions: {
-                    allowOrigins: apig.Cors.ALL_ORIGINS,
-                    allowMethods: ['POST'],
-                    allowHeaders: apig.Cors.DEFAULT_HEADERS,
-                },
                 restApiName: `${this.id}-destined-rest-api-${this.props.stage}`,
             },
             ...this.props.api,
@@ -518,7 +488,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration response model
-     * @protected
      */
     createApiDestinedResponseModel() {
         if (!this.props.api.withResource)
@@ -529,10 +498,10 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
                 contentType: 'application/json',
                 modelName: 'ResponseModel',
                 schema: {
+                    properties: { message: { type: apig.JsonSchemaType.STRING } },
                     schema: apig.JsonSchemaVersion.DRAFT4,
                     title: 'pollResponse',
                     type: apig.JsonSchemaType.OBJECT,
-                    properties: { message: { type: apig.JsonSchemaType.STRING } },
                 },
             },
             ...this.props.api.responseModel,
@@ -540,7 +509,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration error response model
-     * @protected
      */
     createApiDestinedErrorResponseModel() {
         if (!this.props.api.withResource)
@@ -551,13 +519,13 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
                 contentType: 'application/json',
                 modelName: 'ErrorResponseModel',
                 schema: {
-                    schema: apig.JsonSchemaVersion.DRAFT4,
-                    title: 'errorResponse',
-                    type: apig.JsonSchemaType.OBJECT,
                     properties: {
-                        state: { type: apig.JsonSchemaType.STRING },
                         message: { type: apig.JsonSchemaType.STRING },
+                        state: { type: apig.JsonSchemaType.STRING },
                     },
+                    schema: apig.JsonSchemaVersion.DRAFT4,
+                    title: 'errorResponse',
+                    type: apig.JsonSchemaType.OBJECT,
                 },
             },
             ...this.props.api.errorResponseModel,
@@ -565,7 +533,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration resource
-     * @protected
      */
     createApiDestinedResource() {
         if (!this.props.api.withResource)
@@ -573,9 +540,9 @@ class ApiToEventBridgeTargetWithSns 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.apiDestinedRestApi.api,
-                path: '/',
             });
         }
         else {
@@ -585,7 +552,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create api integration resource method
-     * @protected
      */
     createApiDestinedResourceMethod() {
         if (!this.props.api.withResource)
@@ -597,7 +563,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create custom restApi domain for Api API
-     * @protected
      */
     createApiDomain() {
         if (this.props.api.useExisting)
@@ -608,7 +573,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create base path mappings for Api API
-     * @protected
      */
     createApiBasePathMapping() {
         if (this.props.api.useExisting)
@@ -622,7 +586,6 @@ class ApiToEventBridgeTargetWithSns extends common_1.CommonConstruct {
     }
     /**
      * @summary Method to create route53 records for Api API
-     * @protected
      */
     createApiRouteAssets() {
         if (this.props.api.useExisting)

package/dist/src/lib/construct/api-to-eventbridge-target-with-sns/types.d.ts

@@ -3,23 +3,19 @@ import { EventBridgeDestination } from 'aws-cdk-lib/aws-lambda-destinations';
 import { AssetCode, IFunction, LayerVersion } from 'aws-cdk-lib/aws-lambda';
 import { PolicyDocument, Role } from 'aws-cdk-lib/aws-iam';
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Types
  */
 export interface ApiDestinedLambdaEnvironment extends LambdaEnvironment {
     SOURCE_ID: string;
 }
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Types
  */
 export interface ApiDestinedLambdaType {
     destinationFailure: EventBridgeDestination;
     destinationSuccess: EventBridgeDestination;
     environment: ApiDestinedLambdaEnvironment;
     function: IFunction;
-    layers: LayerVersion[];
     layerSource?: AssetCode;
+    layers: LayerVersion[];
     policy: PolicyDocument;
     role: Role;
     source?: AssetCode;

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

@@ -6,9 +6,6 @@ import * as route53 from 'aws-cdk-lib/aws-route53';
 import * as sns from 'aws-cdk-lib/aws-sns';
 import { ApiToLambdaTargetRestApiType } from './types';
 /**
- * @stability stable
- * @category cdk-utils.api-to-lambda-target
- * @subcategory member
  * @classdesc Provides a construct to contain api resources for ApiToLambdaTarget
  */
 export declare class ApiToLambdaTargetRestApi implements ApiToLambdaTargetRestApiType {

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

@@ -2,9 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiToLambdaTargetRestApi = void 0;
 /**
- * @stability stable
- * @category cdk-utils.api-to-lambda-target
- * @subcategory member
  * @classdesc Provides a construct to contain api resources for ApiToLambdaTarget
  */
 class ApiToLambdaTargetRestApi {

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

@@ -3,7 +3,6 @@ import { Construct } from 'constructs';
 import { CommonConstruct } from '../../common';
 import { ApiToLambdaTargetProps, ApiToLambdaTargetRestApiType } from './types';
 /**
- * @mixin
  */
 export declare class ApiToLambdaTarget extends CommonConstruct {
     props: ApiToLambdaTargetProps;
@@ -16,69 +15,56 @@ export declare class ApiToLambdaTarget extends CommonConstruct {
     /**
      * @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 api integration method response
-     * @protected
      */
     protected createApiToLambdaTargetMethodResponse(): void;
     /**
      * @summary Method to create api integration method error response
-     * @protected
      */
     protected createApiToLambdaTargetMethodErrorResponse(): void;
     protected resolveApiToLambdaTargetFunction(): void;
     /**
      * @summary Method to create rest restApi for Api
-     * @protected
      */
     protected createApiToLambdaTargetRestApi(): void;
     /**
      * @summary Method to create api integration resource
-     * @protected
      */
     protected createApiToLambdaTargetResource(): void;
     protected createApiToLambdaTargetPolicy(): void;
     /**
      * @summary Method to create a role for api integration
-     * @protected
      */
     protected createApiToLambdaTargetRole(): void;
     /**
      * @summary Method to create api integration resource method
-     * @protected
      */
     protected createApiToLambdaTargetIntegration(): void;
     /**
      * @summary Method to create api integration resource method
-     * @protected
      */
     protected createApiToLambdaTargetResourceMethod(): void;
     /**
      * @summary Method to create custom restApi domain for Api
-     * @protected
      */
     protected createApiDomain(): void;
     /**
      * @summary Method to create base path mappings for Api
-     * @protected
      */
     protected createApiBasePathMapping(): void;
     /**
      * @summary Method to create route53 records for Api
-     * @protected
      */
     protected createApiRouteAssets(): void;
 }