@gradientedge/cdk-utils 8.91.0 → 8.92.0

package/src/lib/construct/api-to-eventbridge-target/main.ts

@@ -15,13 +15,9 @@ import { ApiToEventbridgeTargetEvent } from './event'
 import { ApiToEventbridgeTargetRestApi } from './api'
 
 /**
- * @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](./ApiToEventBridgeTarget.jpg)
- *
  * @example
  * import { ApiToEventBridgeTarget, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
  * import { Construct } from 'constructs'
@@ -34,7 +30,6 @@ import { ApiToEventbridgeTargetRestApi } from './api'
  *     this.initResources()
  *   }
  * }
- * @mixin
  */
 export class ApiToEventBridgeTarget extends CommonConstruct {
   props: ApiToEventBridgeTargetProps
@@ -100,7 +95,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
   /**
    * @summary Method to resolve secrets from SecretsManager
    * - To be implemented in the overriding method in the implementation class
-   * @protected
    */
   protected resolveSecrets() {
     this.applicationSecrets = []
@@ -108,7 +102,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to resolve a hosted zone based on domain attributes
-   * @protected
    */
   protected resolveHostedZone() {
     this.apiToEventBridgeTargetRestApi.hostedZone = this.route53Manager.withHostedZoneFromFullyQualifiedDomainName(
@@ -120,7 +113,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to resolve a certificate based on attributes
-   * @protected
    */
   protected resolveCertificate() {
     if (this.props.api.useExisting) return
@@ -146,7 +138,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create or use an existing eventbus for api payload deliveries
-   * @protected
    */
   protected createApiToEventBridgeTargetEventBus() {
     if (this.props.api.useExisting) {
@@ -164,7 +155,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create a log group for successful api payload deliveries
-   * @protected
    */
   protected createApiToEventBridgeTargetLogGroup() {
     if (this.props.api.useExisting) return
@@ -178,16 +168,15 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * Method to create EventBridge rule with lambda target for success
-   * @protected
    */
   protected createApiToEventBridgeTargetRule() {
     if (this.props.api.useExisting) return
     this.props.event.rule = {
       ...{
-        ruleName: `${this.id}-api-to-eventbridge-target`,
         eventPattern: {
           source: ['api-to-eventbridge-target'],
         },
+        ruleName: `${this.id}-api-to-eventbridge-target`,
       },
       ...this.props.event.rule,
     }
@@ -208,7 +197,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create a role for api integration
-   * @protected
    */
   protected createApiToEventBridgeTargetRole() {
     if (!this.apiToEventBridgeTargetRestApi.policy) throw 'Policy undefined'
@@ -221,7 +209,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration request parameters
-   * @protected
    */
   protected createApiToEventBridgeTargetIntegrationRequestParameters() {
     if (!this.props.api.withResource) return
@@ -232,7 +219,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration request templates
-   * @protected
    */
   protected createApiToEventBridgeTargetIntegrationRequestTemplates() {
     if (!this.props.api.withResource) return
@@ -256,41 +242,39 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration response
-   * @protected
    */
   protected createApiToEventBridgeTargetIntegrationResponse() {
     if (!this.props.api.withResource) return
     this.apiToEventBridgeTargetRestApi.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
    */
   protected createApiToEventBridgeTargetIntegrationErrorResponse() {
     if (!this.props.api.withResource) return
     this.apiToEventBridgeTargetRestApi.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,
     }
@@ -298,47 +282,45 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration
-   * @protected
    */
   protected createApiToEventBridgeTargetIntegration() {
     if (!this.props.api.withResource) return
     this.apiToEventBridgeTargetRestApi.integration = new apig.Integration({
-      type: apig.IntegrationType.AWS,
       integrationHttpMethod: 'POST',
-      uri: `arn:aws:apigateway:${this.props.region}:events:path//`,
       options: {
         ...{
           credentialsRole: this.apiToEventBridgeTargetRestApi.role,
-          requestParameters: this.apiToEventBridgeTargetRestApi.integrationRequestParameters,
-          requestTemplates: this.apiToEventBridgeTargetRestApi.integrationRequestTemplates,
-          passthroughBehavior: apig.PassthroughBehavior.NEVER,
           integrationResponses: [
             this.apiToEventBridgeTargetRestApi.integrationResponse,
             this.apiToEventBridgeTargetRestApi.integrationErrorResponse,
           ],
+          passthroughBehavior: apig.PassthroughBehavior.NEVER,
+          requestParameters: this.apiToEventBridgeTargetRestApi.integrationRequestParameters,
+          requestTemplates: this.apiToEventBridgeTargetRestApi.integrationRequestTemplates,
         },
         ...this.props.api.integrationOptions,
       },
+      type: apig.IntegrationType.AWS,
+      uri: `arn:aws:apigateway:${this.props.region}:events:path//`,
     })
   }
 
   /**
    * @summary Method to create api integration method response
-   * @protected
    */
   protected createApiToEventBridgeTargetMethodResponse() {
     if (!this.props.api.withResource) return
     this.apiToEventBridgeTargetRestApi.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.apiToEventBridgeTargetRestApi.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,
     }
@@ -346,21 +328,20 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration method error response
-   * @protected
    */
   protected createApiToEventBridgeTargetMethodErrorResponse() {
     if (!this.props.api.withResource) return
     this.apiToEventBridgeTargetRestApi.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.apiToEventBridgeTargetRestApi.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,
     }
@@ -379,7 +360,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create rest restApi for Api
-   * @protected
    */
   protected createApiToEventBridgeTargetRestApi() {
     if (this.props.api.useExisting && this.props.api.importedRestApiRef) {
@@ -394,6 +374,11 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
     this.apiToEventBridgeTargetRestApi.api = new apig.RestApi(this, `${this.id}-rest-api`, {
       ...{
         cloudWatchRole: this.props.api.restApi?.cloudWatchRole ?? true,
+        defaultCorsPreflightOptions: {
+          allowHeaders: apig.Cors.DEFAULT_HEADERS,
+          allowMethods: ['POST'],
+          allowOrigins: apig.Cors.ALL_ORIGINS,
+        },
         defaultIntegration: this.apiToEventBridgeTargetRestApi.integration,
         defaultMethodOptions: {
           methodResponses: [
@@ -403,23 +388,18 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
         },
         deploy: this.props.api.restApi?.deploy ?? true,
         deployOptions: {
-          tracingEnabled: this.props.api.restApi?.deployOptions?.tracingEnabled,
+          accessLogDestination: new apig.LogGroupLogDestination(this.apiToEventBridgeTargetRestApi.accessLogGroup),
+          accessLogFormat: apig.AccessLogFormat.jsonWithStandardFields(),
           dataTraceEnabled: this.props.api.restApi?.deployOptions?.dataTraceEnabled,
           description: `${this.id} - ${this.props.stage} stage`,
           loggingLevel: apig.MethodLoggingLevel.INFO,
           metricsEnabled: true,
           stageName: this.props.stage,
-          accessLogDestination: new apig.LogGroupLogDestination(this.apiToEventBridgeTargetRestApi.accessLogGroup),
-          accessLogFormat: apig.AccessLogFormat.jsonWithStandardFields(),
+          tracingEnabled: this.props.api.restApi?.deployOptions?.tracingEnabled,
         },
         endpointConfiguration: {
           types: [apig.EndpointType.REGIONAL],
         },
-        defaultCorsPreflightOptions: {
-          allowOrigins: apig.Cors.ALL_ORIGINS,
-          allowMethods: ['POST'],
-          allowHeaders: apig.Cors.DEFAULT_HEADERS,
-        },
         restApiName: `${this.id}-rest-api-${this.props.stage}`,
       },
       ...this.props.api.restApi,
@@ -430,7 +410,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration response model
-   * @protected
    */
   protected createApiToEventBridgeTargetResponseModel() {
     if (!this.props.api.withResource) return
@@ -440,10 +419,10 @@ export class ApiToEventBridgeTarget extends 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,
@@ -452,7 +431,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration error response model
-   * @protected
    */
   protected createApiToEventBridgeTargetErrorResponseModel() {
     if (!this.props.api.withResource) return
@@ -462,13 +440,13 @@ export class ApiToEventBridgeTarget extends 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,
@@ -477,7 +455,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration resource
-   * @protected
    */
   protected createApiToEventBridgeTargetResource() {
     if (!this.props.api.withResource) return
@@ -485,9 +462,9 @@ export class ApiToEventBridgeTarget extends 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.apiToEventBridgeTargetRestApi.api,
-        path: '/',
       })
     } else {
       rootResource = this.apiToEventBridgeTargetRestApi.api.root
@@ -498,7 +475,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create api integration resource method
-   * @protected
    */
   protected createApiToEventBridgeTargetResourceMethod() {
     if (!this.props.api.withResource) return
@@ -517,7 +493,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create custom restApi domain for Api
-   * @protected
    */
   protected createApiDomain() {
     if (this.props.api.useExisting) return
@@ -533,7 +508,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create base path mappings for Api
-   * @protected
    */
   protected createApiBasePathMapping() {
     if (this.props.api.useExisting) return
@@ -547,7 +521,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   /**
    * @summary Method to create route53 records for Api
-   * @protected
    */
   protected createApiRouteAssets() {
     if (this.props.api.useExisting) return

package/src/lib/construct/api-to-eventbridge-target/types.ts

@@ -23,8 +23,6 @@ import { AcmProps, EventRuleProps, LambdaProps, LogProps } from '../../services'
 import { AssetCode } from 'aws-cdk-lib/aws-lambda'
 
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Types
  */
 export interface ApiToEventBridgeTargetEventType {
   eventBus: IEventBus
@@ -37,8 +35,6 @@ export interface ApiToEventBridgeTargetEventType {
 }
 
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Types
  */
 export interface ApiToEventBridgeTargetRestApiType {
   accessLogGroup: LogGroup
@@ -56,67 +52,59 @@ export interface ApiToEventBridgeTargetRestApiType {
   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-eventbridge-target
- * @subcategory Properties
  */
 export interface ApiToEventBridgeTargetRestApiProps {
   certificate: AcmProps
-  integrationResponse?: IntegrationResponse
+  errorResponseModel?: ModelOptions
+  importedRestApiRef?: string
+  importedRestApiRootResourceRef?: string
   integrationErrorResponse?: IntegrationResponse
-  methodResponse?: MethodResponse
-  methodErrorResponse?: MethodResponse
   integrationOptions?: IntegrationOptions
+  integrationResponse?: IntegrationResponse
+  methodErrorResponse?: MethodResponse
+  methodResponse?: MethodResponse
   resource: string
-  errorResponseModel?: ModelOptions
   responseModel?: ModelOptions
   restApi?: RestApiProps
-  importedRestApiRef?: string
-  importedRestApiRootResourceRef?: string
   useExisting: boolean
   withResource?: boolean
 }
 
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Properties
  */
 interface ApiToEventBridgeTargetLambdaProps {
-  handler?: string
   function: LambdaProps
-  source?: AssetCode
+  handler?: string
   layerSource?: AssetCode
+  source?: AssetCode
 }
 
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Properties
  */
 interface ApiToEventBridgeTargetEventProps {
   eventBusName?: string
   logGroup?: LogProps
-  logGroupSuccess?: LogProps
   logGroupFailure?: LogProps
+  logGroupSuccess?: LogProps
   rule: EventRuleProps
-  ruleSuccess: EventRuleProps
   ruleFailure: EventRuleProps
+  ruleSuccess: EventRuleProps
 }
 
 /**
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory Properties
  */
 export interface ApiToEventBridgeTargetProps extends CommonStackProps {
+  api: ApiToEventBridgeTargetRestApiProps
   apiRootPaths?: string[]
   apiSubDomain: string
-  api: ApiToEventBridgeTargetRestApiProps
   event: ApiToEventBridgeTargetEventProps
   lambda?: ApiToEventBridgeTargetLambdaProps
   logLevel: string

package/src/lib/construct/api-to-eventbridge-target-with-sns/api-destined-lambda.ts

@@ -4,9 +4,6 @@ import * as destinations from 'aws-cdk-lib/aws-lambda-destinations'
 import { ApiDestinedLambdaEnvironment, ApiDestinedLambdaType } from './types'
 
 /**
- * @stability stable
- * @category cdk-utils.api-to-eventbridge-target
- * @subcategory member
  * @classdesc Provides a construct to contain lambda resources for ApiToEventBridgeTargetWithSns
  */
 export class ApiDestinedLambda implements ApiDestinedLambdaType {