@gradientedge/cdk-utils 4.6.4 → 4.6.5

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

@@ -20,10 +20,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiToEventBridgeTarget = void 0;
+const cdk = __importStar(require("aws-cdk-lib"));
 const apig = __importStar(require("aws-cdk-lib/aws-apigateway"));
 const eventstargets = __importStar(require("aws-cdk-lib/aws-events-targets"));
 const iam = __importStar(require("aws-cdk-lib/aws-iam"));
 const destinations = __importStar(require("aws-cdk-lib/aws-lambda-destinations"));
+const sns = __importStar(require("aws-cdk-lib/aws-sns"));
 const common_1 = require("../../common");
 const api_destination_event_1 = require("./api-destination-event");
 const api_destined_lambda_1 = require("./api-destined-lambda");
@@ -131,6 +133,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     resolveCertificate() {
+        if (this.props.api.useExisting)
+            return;
         if (this.props.api.certificate.useExistingCertificate &&
             this.props.api.certificate.certificateSsmName &&
             this.props.api.certificate.certificateRegion) {
@@ -143,6 +147,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedLambdaPolicy() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedLambda.policy = new iam.PolicyDocument({
             statements: [this.iamManager.statementForReadSecrets(this), this.iamManager.statementForPutEvents()],
         });
@@ -152,6 +158,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedLambdaRole() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedLambda.role = this.iamManager.createRoleForLambda(`${this.id}-lambda-destined-role`, this, this.apiDestinedLambda.policy);
     }
     /**
@@ -159,6 +167,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedLambdaEnvironment() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedLambda.environment = {
             NODE_ENV: this.props.nodeEnv,
             LOG_LEVEL: this.props.logLevel,
@@ -171,6 +181,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedLambdaLayers() {
+        if (this.props.api.useExisting)
+            return;
         const layers = [];
         if (this.props.lambda.layerSource) {
             layers.push(this.lambdaManager.createLambdaLayer(`${this.id}-lambda-destined-layer`, this, this.props.lambda.layerSource));
@@ -182,6 +194,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedLambdaDestinations() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedLambda.destinationSuccess = new destinations.EventBridgeDestination(this.apiEvent.eventBus);
         this.apiDestinedLambda.destinationFailure = new destinations.EventBridgeDestination(this.apiEvent.eventBus);
     }
@@ -190,6 +204,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedLambdaFunction() {
+        if (this.props.api.useExisting)
+            return;
         if (!this.props.lambda.source)
             throw 'Api Destined Lambda props undefined';
         this.apiDestinedLambda.function = this.lambdaManager.createLambdaFunction(`${this.id}-lambda-destined`, this, {
@@ -201,11 +217,15 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         }, this.apiDestinedLambda.role, this.apiDestinedLambda.layers, this.props.lambda.source, this.props.lambda.handler ?? 'lambda.handler', this.apiDestinedLambda.environment);
     }
     createApiDestinedEventBus() {
+        if (this.props.api.useExisting)
+            return;
         this.apiEvent.eventBus = this.eventManager.createEventBus(`${this.id}-destined-event-bus`, this, {
             eventBusName: `${this.props.event.eventBusName}`,
         });
     }
     createApiDestinationLogGroupSuccess() {
+        if (this.props.api.useExisting)
+            return;
         this.apiEvent.logGroupSuccess = this.logManager.createLogGroup(`${this.id}-destination-success-log`, this, {
             ...{
                 logGroupName: `/${this.id}/events/api-destination-success`,
@@ -218,6 +238,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinationRuleSuccess() {
+        if (this.props.api.useExisting)
+            return;
         this.props.event.ruleSuccess = {
             ...{
                 ruleName: `${this.id}-api-destination-success`,
@@ -238,6 +260,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         this.apiEvent.ruleSuccess = this.eventManager.createRule(`${this.id}-api-destination-rule-success`, this, this.props.event.ruleSuccess, this.apiEvent.eventBus, [new eventstargets.CloudWatchLogGroup(this.apiEvent.logGroupSuccess)]);
     }
     createApiDestinationLogGroupFailure() {
+        if (this.props.api.useExisting)
+            return;
         this.apiEvent.logGroupFailure = this.logManager.createLogGroup(`${this.id}-destination-failure-log`, this, {
             ...{
                 logGroupName: `/${this.id}/events/api-destination-failure`,
@@ -250,6 +274,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinationRuleFailure() {
+        if (this.props.api.useExisting)
+            return;
         this.props.event.ruleFailure = {
             ...{
                 ruleName: `${this.id}-api-destination-failure`,
@@ -266,11 +292,16 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         this.apiEvent.ruleFailure = this.eventManager.createRule(`${this.id}-api-destination-rule-failure`, this, this.props.event.ruleFailure, this.apiEvent.eventBus, [new eventstargets.CloudWatchLogGroup(this.apiEvent.logGroupFailure)]);
     }
     createApiDestinedTopicRole() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedRestApi.topicRole = new iam.Role(this, `${this.id}-sns-rest-api-role`, {
             assumedBy: new iam.ServicePrincipal('apigateway.amazonaws.com'),
         });
     }
     createApiDestinedTopic() {
+        if (this.props.api.useExisting) {
+            this.apiDestinedRestApi.topic = sns.Topic.fromTopicArn(this, `${this.id}-destined-topic`, `arn:aws:sns:${this.props.region}:${cdk.Stack.of(this).account}:${this.id}-destined-topic-${this.props.stage}`);
+        }
         this.apiDestinedRestApi.topic = this.snsManager.createLambdaNotificationService(`${this.id}-destined-topic`, this, {
             topicName: `${this.id}-destined-topic`,
         }, this.apiDestinedLambda.function);
@@ -281,6 +312,9 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDestinedRestApi() {
+        if (this.props.api.useExisting) {
+            this.apiDestinedRestApi.api = apig.RestApi.fromRestApiId(this, `${this.id}-sns-rest-api`, cdk.Fn.importValue('importedRestApiRef'));
+        }
         this.apiDestinedRestApi.api = new apig.RestApi(this, `${this.id}-sns-rest-api`, {
             ...{
                 deployOptions: {
@@ -302,8 +336,11 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
             },
             ...this.props.api,
         });
+        this.addCfnOutput(`${this.id}-restApiId`, this.apiDestinedRestApi.api.restApiId);
     }
     createApiDestinedResponseModel() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedRestApi.responseModel = this.apiDestinedRestApi.api.addModel(`${this.id}-response-model`, {
             ...{
                 contentType: 'application/json',
@@ -319,6 +356,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
         });
     }
     createApiDestinedErrorResponseModel() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedRestApi.errorResponseModel = this.apiDestinedRestApi.api.addModel(`${this.id}-error-response-model`, {
             ...{
                 contentType: 'application/json',
@@ -465,6 +504,8 @@ class ApiToEventBridgeTarget extends common_1.CommonConstruct {
      * @protected
      */
     createApiDomain() {
+        if (this.props.api.useExisting)
+            return;
         this.apiDestinedRestApi.domain = this.apiManager.createApiDomain(`${this.id}-api-domain`, this, this.isProductionStage()
             ? `${this.props.apiSubDomain}.${this.fullyQualifiedDomainName}`
             : `${this.props.apiSubDomain}-${this.props.stage}.${this.fullyQualifiedDomainName}`, this.apiDestinedRestApi.certificate);

package/dist/src/lib/types/aws/index.d.ts

@@ -170,7 +170,7 @@ export interface ApiDestinationEventType {
  * @subcategory Types
  */
 export interface ApiDestinedRestApiType {
-    api: apig.RestApi;
+    api: apig.IRestApi;
     certificate: acm.ICertificate;
     domain: apig.DomainName;
     errorResponseModel: apig.Model;
@@ -189,7 +189,7 @@ export interface ApiDestinedRestApiType {
     methodResponse: apig.MethodResponse;
     resource: apig.Resource;
     responseModel: apig.Model;
-    topic: sns.Topic;
+    topic: sns.ITopic;
     topicRole: iam.Role;
 }
 /**
@@ -212,7 +212,6 @@ export interface ApiDestinedLambdaType {
  * @subcategory Properties
  */
 export interface ApiToEventBridgeTargetRestApiProps {
-    withResource?: boolean;
     certificate: AcmProps;
     integrationResponse?: apig.IntegrationResponse;
     integrationErrorResponse?: apig.IntegrationResponse;
@@ -223,6 +222,8 @@ export interface ApiToEventBridgeTargetRestApiProps {
     errorResponseModel?: apig.ModelOptions;
     responseModel?: apig.ModelOptions;
     restApi?: apig.RestApiProps;
+    useExisting: boolean;
+    withResource?: boolean;
 }
 /**
  * @category cdk-utils.api-to-eventbridge-target

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "4.6.4",
+  "version": "4.6.5",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

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

@@ -1,9 +1,11 @@
+import * as cdk from 'aws-cdk-lib'
 import * as apig from 'aws-cdk-lib/aws-apigateway'
 import * as eventstargets from 'aws-cdk-lib/aws-events-targets'
 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
 import * as destinations from 'aws-cdk-lib/aws-lambda-destinations'
 import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager'
+import * as sns from 'aws-cdk-lib/aws-sns'
 import { Construct } from 'constructs'
 import { CommonConstruct } from '../../common'
 import * as types from '../../types'
@@ -134,6 +136,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected resolveCertificate() {
+    if (this.props.api.useExisting) return
     if (
       this.props.api.certificate.useExistingCertificate &&
       this.props.api.certificate.certificateSsmName &&
@@ -159,6 +162,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedLambdaPolicy() {
+    if (this.props.api.useExisting) return
     this.apiDestinedLambda.policy = new iam.PolicyDocument({
       statements: [this.iamManager.statementForReadSecrets(this), this.iamManager.statementForPutEvents()],
     })
@@ -169,6 +173,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedLambdaRole() {
+    if (this.props.api.useExisting) return
     this.apiDestinedLambda.role = this.iamManager.createRoleForLambda(
       `${this.id}-lambda-destined-role`,
       this,
@@ -181,6 +186,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedLambdaEnvironment() {
+    if (this.props.api.useExisting) return
     this.apiDestinedLambda.environment = {
       NODE_ENV: this.props.nodeEnv,
       LOG_LEVEL: this.props.logLevel,
@@ -194,6 +200,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedLambdaLayers() {
+    if (this.props.api.useExisting) return
     const layers: lambda.LayerVersion[] = []
     if (this.props.lambda.layerSource) {
       layers.push(
@@ -209,6 +216,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedLambdaDestinations() {
+    if (this.props.api.useExisting) return
     this.apiDestinedLambda.destinationSuccess = new destinations.EventBridgeDestination(this.apiEvent.eventBus)
     this.apiDestinedLambda.destinationFailure = new destinations.EventBridgeDestination(this.apiEvent.eventBus)
   }
@@ -218,6 +226,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedLambdaFunction() {
+    if (this.props.api.useExisting) return
     if (!this.props.lambda.source) throw 'Api Destined Lambda props undefined'
 
     this.apiDestinedLambda.function = this.lambdaManager.createLambdaFunction(
@@ -239,12 +248,14 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
   }
 
   protected createApiDestinedEventBus() {
+    if (this.props.api.useExisting) return
     this.apiEvent.eventBus = this.eventManager.createEventBus(`${this.id}-destined-event-bus`, this, {
       eventBusName: `${this.props.event.eventBusName}`,
     })
   }
 
   protected createApiDestinationLogGroupSuccess() {
+    if (this.props.api.useExisting) return
     this.apiEvent.logGroupSuccess = this.logManager.createLogGroup(`${this.id}-destination-success-log`, this, {
       ...{
         logGroupName: `/${this.id}/events/api-destination-success`,
@@ -258,6 +269,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinationRuleSuccess() {
+    if (this.props.api.useExisting) return
     this.props.event.ruleSuccess = {
       ...{
         ruleName: `${this.id}-api-destination-success`,
@@ -285,6 +297,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
   }
 
   protected createApiDestinationLogGroupFailure() {
+    if (this.props.api.useExisting) return
     this.apiEvent.logGroupFailure = this.logManager.createLogGroup(`${this.id}-destination-failure-log`, this, {
       ...{
         logGroupName: `/${this.id}/events/api-destination-failure`,
@@ -298,6 +311,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinationRuleFailure() {
+    if (this.props.api.useExisting) return
     this.props.event.ruleFailure = {
       ...{
         ruleName: `${this.id}-api-destination-failure`,
@@ -321,12 +335,20 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
   }
 
   protected createApiDestinedTopicRole() {
+    if (this.props.api.useExisting) return
     this.apiDestinedRestApi.topicRole = new iam.Role(this, `${this.id}-sns-rest-api-role`, {
       assumedBy: new iam.ServicePrincipal('apigateway.amazonaws.com'),
     })
   }
 
   protected createApiDestinedTopic() {
+    if (this.props.api.useExisting) {
+      this.apiDestinedRestApi.topic = sns.Topic.fromTopicArn(
+        this,
+        `${this.id}-destined-topic`,
+        `arn:aws:sns:${this.props.region}:${cdk.Stack.of(this).account}:${this.id}-destined-topic-${this.props.stage}`
+      )
+    }
     this.apiDestinedRestApi.topic = this.snsManager.createLambdaNotificationService(
       `${this.id}-destined-topic`,
       this,
@@ -344,6 +366,13 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDestinedRestApi() {
+    if (this.props.api.useExisting) {
+      this.apiDestinedRestApi.api = apig.RestApi.fromRestApiId(
+        this,
+        `${this.id}-sns-rest-api`,
+        cdk.Fn.importValue('importedRestApiRef')
+      )
+    }
     this.apiDestinedRestApi.api = new apig.RestApi(this, `${this.id}-sns-rest-api`, {
       ...{
         deployOptions: {
@@ -365,26 +394,32 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
       },
       ...this.props.api,
     })
+    this.addCfnOutput(`${this.id}-restApiId`, this.apiDestinedRestApi.api.restApiId)
   }
 
   protected createApiDestinedResponseModel() {
-    this.apiDestinedRestApi.responseModel = this.apiDestinedRestApi.api.addModel(`${this.id}-response-model`, {
-      ...{
-        contentType: 'application/json',
-        modelName: 'ResponseModel',
-        schema: {
-          schema: apig.JsonSchemaVersion.DRAFT4,
-          title: 'pollResponse',
-          type: apig.JsonSchemaType.OBJECT,
-          properties: { message: { type: apig.JsonSchemaType.STRING } },
+    if (this.props.api.useExisting) return
+    this.apiDestinedRestApi.responseModel = (this.apiDestinedRestApi.api as apig.RestApi).addModel(
+      `${this.id}-response-model`,
+      {
+        ...{
+          contentType: 'application/json',
+          modelName: 'ResponseModel',
+          schema: {
+            schema: apig.JsonSchemaVersion.DRAFT4,
+            title: 'pollResponse',
+            type: apig.JsonSchemaType.OBJECT,
+            properties: { message: { type: apig.JsonSchemaType.STRING } },
+          },
         },
-      },
-      ...this.props.api.responseModel,
-    })
+        ...this.props.api.responseModel,
+      }
+    )
   }
 
   protected createApiDestinedErrorResponseModel() {
-    this.apiDestinedRestApi.errorResponseModel = this.apiDestinedRestApi.api.addModel(
+    if (this.props.api.useExisting) return
+    this.apiDestinedRestApi.errorResponseModel = (this.apiDestinedRestApi.api as apig.RestApi).addModel(
       `${this.id}-error-response-model`,
       {
         ...{
@@ -407,7 +442,6 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
 
   protected createApiDestinedResource() {
     if (!this.props.api.withResource) return
-
     this.apiDestinedRestApi.resource = this.apiDestinedRestApi.api.root.addResource(
       this.props.api.resource ?? this.apiResource
     )
@@ -541,6 +575,7 @@ export class ApiToEventBridgeTarget extends CommonConstruct {
    * @protected
    */
   protected createApiDomain() {
+    if (this.props.api.useExisting) return
     this.apiDestinedRestApi.domain = this.apiManager.createApiDomain(
       `${this.id}-api-domain`,
       this,

package/src/lib/types/aws/index.ts

@@ -181,7 +181,7 @@ export interface ApiDestinationEventType {
  * @subcategory Types
  */
 export interface ApiDestinedRestApiType {
-  api: apig.RestApi
+  api: apig.IRestApi
   certificate: acm.ICertificate
   domain: apig.DomainName
   errorResponseModel: apig.Model
@@ -196,7 +196,7 @@ export interface ApiDestinedRestApiType {
   methodResponse: apig.MethodResponse
   resource: apig.Resource
   responseModel: apig.Model
-  topic: sns.Topic
+  topic: sns.ITopic
   topicRole: iam.Role
 }
 
@@ -221,7 +221,6 @@ export interface ApiDestinedLambdaType {
  * @subcategory Properties
  */
 export interface ApiToEventBridgeTargetRestApiProps {
-  withResource?: boolean
   certificate: AcmProps
   integrationResponse?: apig.IntegrationResponse
   integrationErrorResponse?: apig.IntegrationResponse
@@ -232,6 +231,8 @@ export interface ApiToEventBridgeTargetRestApiProps {
   errorResponseModel?: apig.ModelOptions
   responseModel?: apig.ModelOptions
   restApi?: apig.RestApiProps
+  useExisting: boolean
+  withResource?: boolean
 }
 
 /**