@gradientedge/cdk-utils 8.72.0 → 8.74.0

package/dist/src/lib/manager/aws/lambda-manager.js

@@ -215,6 +215,7 @@ class LambdaManager {
                 filesystem: accessPoint
                     ? lambda.FileSystem.fromEfsAccessPoint(accessPoint, mountPath || '/mnt/msg')
                     : undefined,
+                logRetention: scope.props.logRetention ?? props.logRetention,
                 reservedConcurrentExecutions: props.reservedConcurrentExecutions,
                 role: role instanceof iam.Role ? role : undefined,
                 securityGroups: securityGroups,

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

@@ -249,12 +249,20 @@ export interface ApiDestinedLambdaEnvironment extends LambdaEnvironment {
     SOURCE_ID: string;
 }
 /**
+ * @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 {
 }
 /**
+ * @category cdk-utils.rest-api-lambda
+ * @subcategory Types
+ */
+export interface RestApiLambdaEnvironment extends LambdaEnvironment {
+}
+/**
+ * @deprecated Use RestApiLambdaProps instead. This will be removed in a future release.
  * @category cdk-utils.graphql-api-lambda
  * @subcategory Properties
  */
@@ -273,6 +281,25 @@ export interface GraphQlApiLambdaProps extends CommonStackProps {
     timezone: string;
 }
 /**
+ * @category cdk-utils.rest-api-lambda
+ * @subcategory Properties
+ */
+export interface RestApiLambdaProps extends CommonStackProps {
+    apiRootPaths?: string[];
+    apiSubDomain: string;
+    restApiCertificate: AcmProps;
+    restApi: apig.LambdaRestApiProps;
+    restApiLambdaLayerSources?: lambda.AssetCode[];
+    restApiHandler: string;
+    restApiSource: lambda.AssetCode;
+    restApiLambda: LambdaProps;
+    useExistingHostedZone: boolean;
+    nodeEnv: string;
+    logLevel: string;
+    timezone: string;
+}
+/**
+ * @deprecated Use RestApiLambdaWithCacheProps instead. This will be removed in a future release.
  * @category cdk-utils.graphql-api-lambda-with-cache
  * @subcategory Properties
  */
@@ -283,6 +310,17 @@ export interface GraphQlApiLambdaWithCacheProps extends GraphQlApiLambdaProps {
     useExistingVpc: boolean;
     vpcName?: string;
 }
+/**
+ * @category cdk-utils.rest-api-lambda-with-cache
+ * @subcategory Properties
+ */
+export interface RestApiLambdaWithCacheProps extends RestApiLambdaProps {
+    restApiVpc: ec2.VpcProps;
+    restApiElastiCache: ReplicatedElastiCacheProps;
+    securityGroupExportName: string;
+    useExistingVpc: boolean;
+    vpcName?: string;
+}
 /**
  * @category cdk-utils.api-to-eventbridge-target
  * @subcategory Types

package/dist/src/lib/utils/index.js

@@ -38,7 +38,7 @@ var LogLevel;
     LogLevel["TRACE"] = "TRACE";
     LogLevel["ERROR"] = "ERROR";
     LogLevel["CRITICAL"] = "CRITICAL";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
 /**
  * @category cdk-utils.utils
  * @param stage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.72.0",
+  "version": "8.74.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -46,13 +46,13 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.341.0",
+    "@aws-sdk/client-secrets-manager": "^3.344.0",
     "@types/lodash": "^4.14.195",
     "@types/node": "^20.2.5",
     "@types/uuid": "^9.0.1",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.81.0",
-    "constructs": "^10.2.37",
+    "aws-cdk-lib": "^2.82.0",
+    "constructs": "^10.2.40",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "nconf": "^0.12.0",
@@ -64,19 +64,19 @@
     "@babel/core": "^7.22.1",
     "@babel/eslint-parser": "^7.21.8",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@types/jest": "^29.5.1",
+    "@types/jest": "^29.5.2",
     "@typescript-eslint/eslint-plugin": "^5.59.8",
     "@typescript-eslint/parser": "^5.59.8",
-    "aws-cdk": "^2.81.0",
+    "aws-cdk": "^2.82.0",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
     "docdash": "^2.0.1",
-    "dotenv": "^16.0.3",
+    "dotenv": "^16.1.3",
     "eslint": "^8.41.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^45.0.0",
+    "eslint-plugin-jsdoc": "^46.1.0",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
     "jest-extended": "^3.2.4",
@@ -93,7 +93,7 @@
     "taffydb": "^2.7.3",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.1.3"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1",

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

@@ -8,7 +8,8 @@ import { GraphQlApiLambdaWithCacheProps } from '../../types'
 import * as utils from '../../utils'
 
 /**
- * @stability stable
+ * @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

package/src/lib/construct/index.ts

@@ -3,5 +3,7 @@ export * from './api-to-eventbridge-target-with-sns'
 export * from './api-to-lambda-target'
 export * from './graphql-api-lambda'
 export * from './graphql-api-lambda-with-cache'
+export * from './rest-api-lambda'
+export * from './rest-api-lambda-with-cache'
 export * from './site-with-ecs-backend'
 export * from './static-site'

package/src/lib/construct/rest-api-lambda/index.ts

@@ -0,0 +1 @@
+export * from './main'

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

@@ -0,0 +1,261 @@
+import * as apig from 'aws-cdk-lib/aws-apigateway'
+import * as acm from 'aws-cdk-lib/aws-certificatemanager'
+import * as iam from 'aws-cdk-lib/aws-iam'
+import * as lambda from 'aws-cdk-lib/aws-lambda'
+import * as route53 from 'aws-cdk-lib/aws-route53'
+import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager'
+import { Construct } from 'constructs'
+import { CommonConstruct } from '../../common'
+import { RestApiLambdaEnvironment, RestApiLambdaProps } from '../../types'
+
+/**
+ * @deprecated Use RestApiLambda instead. This will be removed in a future release.
+ *
+ * @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'
+ *
+ * class CustomConstruct extends RestApiLambda {
+ *   constructor(parent: Construct, id: string, props: RestApiLambdaProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ * @mixin
+ */
+export class RestApiLambda extends CommonConstruct {
+  /* restApiLambda props */
+  props: RestApiLambdaProps
+  id: string
+
+  /* restApiLambda resources */
+  applicationSecrets: secretsmanager.ISecret[]
+  restApiLambdaPolicy: iam.PolicyDocument
+  restApiLambdaRole: iam.Role
+  restApiLambdaEnvironment: RestApiLambdaEnvironment
+  restApiLambdaLayers: lambda.LayerVersion[] = []
+  restApiLambdaFunction: lambda.Function
+  restApi: apig.RestApi
+  restApiHostedZone: route53.IHostedZone
+  restApiCertificate: acm.ICertificate
+  restApiDomain: apig.DomainName
+  restApiBasePathMappings: apig.BasePathMapping[] = []
+
+  constructor(parent: Construct, id: string, props: RestApiLambdaProps) {
+    super(parent, id, props)
+
+    this.props = props
+    this.id = id
+  }
+
+  /**
+   * @summary Initialise and provision resources
+   * @protected
+   */
+  protected initResources() {
+    this.resolveSecrets()
+    this.resolveHostedZone()
+    this.resolveCertificate()
+    this.createLambdaPolicy()
+    this.createLambdaRole()
+    this.createLambdaEnvironment()
+    this.createLambdaLayers()
+    this.createLambdaFunction()
+    this.createRestApi()
+    this.createApiDomain()
+    this.createApiBasePathMapping()
+    this.createApiRouteAssets()
+  }
+
+  /**
+   * @summary Method to resolve secrets from SecretsManager
+   * - To be implemented in the overriding method in the implementation class
+   * @protected
+   */
+  protected resolveSecrets() {
+    this.applicationSecrets = []
+  }
+
+  /**
+   * @summary Method to resolve a hosted zone based on domain attributes
+   * @protected
+   */
+  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
+   */
+  protected resolveCertificate() {
+    if (
+      this.props.restApiCertificate.useExistingCertificate &&
+      this.props.restApiCertificate.certificateSsmName &&
+      this.props.restApiCertificate.certificateRegion
+    ) {
+      this.props.restApiCertificate.certificateArn = this.ssmManager.readStringParameterFromRegion(
+        `${this.id}-certificate-param`,
+        this,
+        this.props.restApiCertificate.certificateSsmName,
+        this.props.restApiCertificate.certificateRegion
+      )
+    }
+
+    this.restApiCertificate = this.acmManager.resolveCertificate(
+      `${this.id}-certificate`,
+      this,
+      this.props.restApiCertificate
+    )
+  }
+
+  /**
+   * @summary Method to create iam policy for RestApi Lambda function
+   * @protected
+   */
+  protected createLambdaPolicy() {
+    this.restApiLambdaPolicy = new iam.PolicyDocument({
+      statements: [this.iamManager.statementForCreateAnyLogStream()],
+    })
+  }
+
+  /**
+   * @summary Method to create iam role for RestApi Lambda function
+   * @protected
+   */
+  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
+   */
+  protected createLambdaEnvironment() {
+    this.restApiLambdaEnvironment = {
+      NODE_ENV: this.props.nodeEnv,
+      LOG_LEVEL: this.props.logLevel,
+      TZ: this.props.timezone,
+    }
+  }
+
+  /**
+   * @summary Method to create layers for RestApi Lambda function
+   * @protected
+   */
+  protected createLambdaLayers() {
+    const layers: lambda.LayerVersion[] = []
+
+    if (!this.props.restApiLambdaLayerSources) return
+
+    this.props.restApiLambdaLayerSources.forEach((source: lambda.AssetCode, index: number) => {
+      layers.push(this.lambdaManager.createLambdaLayer(`${this.id}-layer-${index}`, this, source))
+    })
+
+    this.restApiLambdaLayers = layers
+  }
+
+  /**
+   * @summary Method to create lambda function for RestApi
+   * @protected
+   */
+  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
+   */
+  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 API
+   * @protected
+   */
+  protected createApiDomain() {
+    this.restApiDomain = this.apiManager.createApiDomain(
+      `${this.id}-api-domain`,
+      this,
+      this.isProductionStage() || this.props.skipStageForARecords
+        ? `${this.props.apiSubDomain}.${this.fullyQualifiedDomainName}`
+        : `${this.props.apiSubDomain}-${this.props.stage}.${this.fullyQualifiedDomainName}`,
+      this.restApiCertificate
+    )
+  }
+
+  /**
+   * @summary Method to create base path mappings for RestApi API
+   * @protected
+   */
+  protected createApiBasePathMapping() {
+    const apiRootPaths = this.props.apiRootPaths
+    if (apiRootPaths && apiRootPaths.length > 0) {
+      apiRootPaths.forEach((apiRootPath: string) => {
+        this.restApiBasePathMappings.push(
+          new apig.BasePathMapping(this, `${this.id}-base-bath-mapping-${apiRootPath}`, {
+            basePath: apiRootPath,
+            domainName: this.restApiDomain,
+            restApi: this.restApi,
+            stage: this.restApi.deploymentStage,
+          })
+        )
+      })
+      return
+    }
+
+    // add default mapping if apiRootPaths not set
+    new apig.BasePathMapping(this, `${this.id}-base-bath-mapping`, {
+      domainName: this.restApiDomain,
+      restApi: this.restApi,
+      stage: this.restApi.deploymentStage,
+    })
+  }
+
+  /**
+   * @summary Method to create route53 records for RestApi API
+   * @protected
+   */
+  protected createApiRouteAssets() {
+    this.route53Manager.createApiGatewayARecord(
+      `${this.id}-custom-domain-a-record`,
+      this,
+      this.props.apiSubDomain,
+      this.restApiDomain,
+      this.restApiHostedZone,
+      this.props.skipStageForARecords
+    )
+  }
+}

package/src/lib/construct/rest-api-lambda-with-cache/index.ts

@@ -0,0 +1 @@
+export * from './main'

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

@@ -0,0 +1,151 @@
+import * as cdk from 'aws-cdk-lib'
+import * as ec2 from 'aws-cdk-lib/aws-ec2'
+import * as elasticache from 'aws-cdk-lib/aws-elasticache'
+import * as iam from 'aws-cdk-lib/aws-iam'
+import { Construct } from 'constructs'
+import { RestApiLambda } from '..'
+import { RestApiLambdaWithCacheProps } from '../../types'
+import * as utils from '../../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'
+ *
+ * class CustomConstruct extends RestApiLambdaWithCache {
+ *   constructor(parent: Construct, id: string, props: RestApiLambdaWithCacheProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ * @mixin
+ */
+export class RestApiLambdaWithCache extends RestApiLambda {
+  /* restApiLambdaWithCache props */
+  props: RestApiLambdaWithCacheProps
+  id: string
+
+  /* restApiLambda resources */
+  restApivpc: ec2.IVpc
+  restApiCache: elasticache.CfnReplicationGroup
+  restApiSecurityGroup: ec2.ISecurityGroup
+  restApiSecurityGroupExportName: string
+
+  constructor(parent: Construct, id: string, props: RestApiLambdaWithCacheProps) {
+    super(parent, id, props)
+
+    this.props = props
+    this.id = id
+  }
+
+  protected initResources() {
+    this.resolveVpc()
+    this.resolveSecurityGroup()
+    this.createElastiCache()
+    super.initResources()
+  }
+
+  /**
+   * Create VPC
+   * @protected
+   */
+  protected resolveVpc() {
+    if (this.props.useExistingVpc) {
+      this.restApivpc = this.vpcManager.retrieveCommonVpc(`${this.id}`, this, this.props.vpcName)
+    } else {
+      this.restApivpc = this.vpcManager.createCommonVpc(this, this.props.restApiVpc, this.props.restApiVpc.vpcName)
+    }
+  }
+
+  /**
+   * Resolve Security Group
+   * @protected
+   */
+  protected resolveSecurityGroup() {
+    if (this.props.securityGroupExportName) {
+      this.restApiSecurityGroup = ec2.SecurityGroup.fromSecurityGroupId(
+        this,
+        `${this.id}`,
+        cdk.Fn.importValue(this.props.securityGroupExportName)
+      )
+    } else {
+      this.restApiSecurityGroup = new ec2.SecurityGroup(this, `${this.id}-security-group-${this.props.stage}`, {
+        securityGroupName: `${this.id}-security-group-${this.props.stage}`,
+        vpc: this.restApivpc,
+      })
+
+      this.restApiSecurityGroup.addIngressRule(ec2.Peer.anyIpv4(), ec2.Port.allTraffic(), 'All Traffic')
+
+      utils.createCfnOutput(`${this.id}-security-group-id`, this, this.restApiSecurityGroup.securityGroupId)
+    }
+  }
+
+  /**
+   * Create ElastiCache
+   * @protected
+   */
+  protected createElastiCache() {
+    this.restApiCache = this.elasticacheManager.createReplicatedElastiCache(
+      `${this.id}-elasticache`,
+      this,
+      this.props.restApiElastiCache,
+      this.restApivpc.privateSubnets.map(subnet => subnet.subnetId),
+      [this.restApiSecurityGroup.securityGroupId]
+    )
+  }
+
+  /**
+   * Create Lambda Role
+   * @protected
+   */
+  protected createLambdaRole() {
+    super.createLambdaRole()
+
+    this.restApiLambdaRole.addManagedPolicy(
+      iam.ManagedPolicy.fromAwsManagedPolicyName('service-role/AWSLambdaVPCAccessExecutionRole')
+    )
+  }
+
+  /**
+   * @summary Method to create environment variables for RestApi Lambda function
+   * @protected
+   */
+  protected createLambdaEnvironment() {
+    this.restApiLambdaEnvironment = {
+      NODE_ENV: this.props.nodeEnv,
+      LOG_LEVEL: this.props.logLevel,
+      TZ: this.props.timezone,
+    }
+  }
+
+  /**
+   * @summary Method to create lambda function for RestApi API
+   * @protected
+   */
+  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/src/lib/manager/aws/iam-manager.ts

@@ -117,6 +117,42 @@ export class IamManager {
     })
   }
 
+  /**
+   * @summary Method to create iam statement to access app config
+   * @param {string[]} resourceArns list of ARNs to allow access to
+   */
+  public statementForAppConfigExecution(resourceArns?: string[]) {
+    return new iam.PolicyStatement({
+      effect: iam.Effect.ALLOW,
+      actions: ['appconfig:GetLatestConfiguration', 'appconfig:StartConfigurationSession'],
+      resources: resourceArns ?? ['*'],
+    })
+  }
+
+  /**
+   * @summary Method to create iam statement to put xray telemetry
+   * @param {string[]} resourceArns list of ARNs to allow access to
+   */
+  public statementForPutXrayTelemetry(resourceArns?: string[]) {
+    return new iam.PolicyStatement({
+      effect: iam.Effect.ALLOW,
+      actions: ['xray:PutTraceSegments', 'xray:PutTelemetryRecords'],
+      resources: resourceArns ?? ['*'],
+    })
+  }
+
+  /**
+   * @summary Method to create iam statement to decrypt kms
+   * @param {string[]} resourceArns list of ARNs to allow access to
+   */
+  public statementForDecryptKms(resourceArns?: string[]) {
+    return new iam.PolicyStatement({
+      effect: iam.Effect.ALLOW,
+      actions: ['kms:Decrypt'],
+      resources: resourceArns ?? ['*'],
+    })
+  }
+
   /**
    * @summary Method to create iam statement to list s3 buckets
    * @param {common.CommonConstruct} scope scope in which this resource is defined

package/src/lib/manager/aws/lambda-manager.ts

@@ -270,6 +270,7 @@ export class LambdaManager {
         filesystem: accessPoint
           ? lambda.FileSystem.fromEfsAccessPoint(accessPoint, mountPath || '/mnt/msg')
           : undefined,
+        logRetention: scope.props.logRetention ?? props.logRetention,
         reservedConcurrentExecutions: props.reservedConcurrentExecutions,
         role: role instanceof iam.Role ? role : undefined,
         securityGroups: securityGroups,

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

@@ -270,12 +270,20 @@ export interface ApiDestinedLambdaEnvironment extends LambdaEnvironment {
 }
 
 /**
+ * @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 {}
 
 /**
+ * @category cdk-utils.rest-api-lambda
+ * @subcategory Types
+ */
+export interface RestApiLambdaEnvironment extends LambdaEnvironment {}
+
+/**
+ * @deprecated Use RestApiLambdaProps instead. This will be removed in a future release.
  * @category cdk-utils.graphql-api-lambda
  * @subcategory Properties
  */
@@ -295,6 +303,26 @@ export interface GraphQlApiLambdaProps extends CommonStackProps {
 }
 
 /**
+ * @category cdk-utils.rest-api-lambda
+ * @subcategory Properties
+ */
+export interface RestApiLambdaProps extends CommonStackProps {
+  apiRootPaths?: string[]
+  apiSubDomain: string
+  restApiCertificate: AcmProps
+  restApi: apig.LambdaRestApiProps
+  restApiLambdaLayerSources?: lambda.AssetCode[]
+  restApiHandler: string
+  restApiSource: lambda.AssetCode
+  restApiLambda: LambdaProps
+  useExistingHostedZone: boolean
+  nodeEnv: string
+  logLevel: string
+  timezone: string
+}
+
+/**
+ * @deprecated Use RestApiLambdaWithCacheProps instead. This will be removed in a future release.
  * @category cdk-utils.graphql-api-lambda-with-cache
  * @subcategory Properties
  */
@@ -306,6 +334,18 @@ export interface GraphQlApiLambdaWithCacheProps extends GraphQlApiLambdaProps {
   vpcName?: string
 }
 
+/**
+ * @category cdk-utils.rest-api-lambda-with-cache
+ * @subcategory Properties
+ */
+export interface RestApiLambdaWithCacheProps extends RestApiLambdaProps {
+  restApiVpc: ec2.VpcProps
+  restApiElastiCache: ReplicatedElastiCacheProps
+  securityGroupExportName: string
+  useExistingVpc: boolean
+  vpcName?: string
+}
+
 /**
  * @category cdk-utils.api-to-eventbridge-target
  * @subcategory Types