@gradientedge/cdk-utils 8.145.0 → 8.146.0

package/dist/src/lib/cloudflare/common/constants.d.ts

@@ -0,0 +1,4 @@
+export declare enum RemoteBackend {
+    local = "local",
+    s3 = "s3"
+}

package/dist/src/lib/cloudflare/common/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteBackend = void 0;
+var RemoteBackend;
+(function (RemoteBackend) {
+    RemoteBackend["local"] = "local";
+    RemoteBackend["s3"] = "s3";
+})(RemoteBackend || (exports.RemoteBackend = RemoteBackend = {}));

package/dist/src/lib/cloudflare/common/construct.d.ts

@@ -24,7 +24,11 @@ export declare class CommonCloudflareConstruct extends TerraformStack {
      * @summary Determine the account id based on the cdktf.json context
      */
     protected determineAccountId(): void;
+    /**
+     * @summary Determine the api token based on the cdktf.json context
+     */
     protected determineApiToken(): void;
+    protected determineRemoteBackend(): void;
     /**
      * @summary Utility method to determine if the initialisation is in development (dev) stage
      * This is determined by the stage property injected via cdk context

package/dist/src/lib/cloudflare/common/construct.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonCloudflareConstruct = void 0;
-const provider_1 = require("@cdktf/provider-cloudflare/lib/provider");
+const provider_1 = require("@cdktf/provider-aws/lib/provider");
+const provider_2 = require("@cdktf/provider-cloudflare/lib/provider");
 const cdktf_1 = require("cdktf");
 const common_1 = require("../../common");
 const services_1 = require("../services");
+const constants_1 = require("./constants");
+const data_aws_s3_bucket_object_1 = require("@cdktf/provider-aws/lib/data-aws-s3-bucket-object");
 class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
     id;
     fullyQualifiedDomainName;
@@ -33,7 +36,8 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
         this.determineFullyQualifiedDomain();
         this.determineAccountId();
         this.determineApiToken();
-        new provider_1.CloudflareProvider(this, `${this.id}-provider`, this.props);
+        this.determineRemoteBackend();
+        new provider_2.CloudflareProvider(this, `${this.id}-provider`, this.props);
     }
     /**
      * @summary Determine the fully qualified domain name based on domainName & subDomain
@@ -49,9 +53,43 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
     determineAccountId() {
         this.props.accountId = new cdktf_1.TerraformVariable(this, `accountId`, {}).stringValue;
     }
+    /**
+     * @summary Determine the api token based on the cdktf.json context
+     */
     determineApiToken() {
         this.props.apiToken = new cdktf_1.TerraformVariable(this, `apiToken`, {}).stringValue;
     }
+    determineRemoteBackend() {
+        const debug = this.node.tryGetContext('debug');
+        switch (this.props.remoteBackend?.type) {
+            case constants_1.RemoteBackend.s3:
+                new provider_1.AwsProvider(this, `${this.id}-aws-provider`, {
+                    profile: process.env.AWS_PROFILE ?? 'default',
+                    region: this.props.remoteBackend.region,
+                });
+                new cdktf_1.S3Backend(this, {
+                    bucket: this.props.remoteBackend.bucketName,
+                    dynamodbTable: this.props.remoteBackend.tableName,
+                    key: `${this.id}`,
+                    profile: process.env.AWS_PROFILE ?? 'default',
+                    region: this.props.remoteBackend.region,
+                });
+                new data_aws_s3_bucket_object_1.DataAwsS3BucketObject(this, `${this.id}-remote-state-ref`, {
+                    bucket: this.props.remoteBackend.bucketName,
+                    key: new cdktf_1.DataTerraformRemoteStateS3(this, `${this.id}-remote-state`, {
+                        bucket: this.props.remoteBackend.bucketName,
+                        key: `${this.id}`,
+                    }).getString('bucket_key'),
+                });
+                break;
+            case constants_1.RemoteBackend.local:
+                if (debug)
+                    console.debug(`Using local backend for ${this.id}`);
+                break;
+            default:
+                break;
+        }
+    }
     /**
      * @summary Utility method to determine if the initialisation is in development (dev) stage
      * This is determined by the stage property injected via cdk context

package/dist/src/lib/cloudflare/common/index.d.ts

@@ -1,3 +1,4 @@
+export * from './constants';
 export * from './construct';
 export * from './stack';
 export * from './types';

package/dist/src/lib/cloudflare/common/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./constants"), exports);
 __exportStar(require("./construct"), exports);
 __exportStar(require("./stack"), exports);
 __exportStar(require("./types"), exports);

package/dist/src/lib/cloudflare/common/stack.js

@@ -38,6 +38,7 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
      * @returns The stack properties
      */
     determineConstructProps(props) {
+        const stage = this.node.tryGetContext('stage');
         return {
             accountId: this.node.tryGetContext('accountId'),
             apiToken: this.node.tryGetContext('apiToken'),
@@ -46,7 +47,7 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
             features: this.node.tryGetContext('features'),
             name: this.node.tryGetContext('resourceGroupName'),
             skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
-            stage: this.node.tryGetContext('stage'),
+            stage: stage,
             subDomain: this.node.tryGetContext('subDomain'),
         };
     }

package/dist/src/lib/cloudflare/common/types.d.ts

@@ -1,9 +1,17 @@
 import { CloudflareProviderConfig } from '@cdktf/provider-cloudflare/lib/provider';
 import { BaseProps } from '../../common';
+import { RemoteBackend } from './constants';
+export interface RemoteBackendProps {
+    bucketName: string;
+    region: string;
+    tableName: string;
+    type: RemoteBackend;
+}
 /**
  */
 export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
     accountId: string;
     apiToken: string;
+    remoteBackend?: RemoteBackendProps;
     useExistingZone?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.145.0",
+  "version": "8.146.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -50,6 +50,7 @@
     "@aws-sdk/client-secrets-manager": "^3.458.0",
     "@aws-sdk/credential-providers": "^3.458.0",
     "@aws-sdk/types": "^3.451.0",
+    "@cdktf/provider-aws": "^18.0.6",
     "@cdktf/provider-azurerm": "^11.0.6",
     "@cdktf/provider-cloudflare": "^10.0.3",
     "@types/lodash": "^4.14.202",

package/src/lib/cloudflare/common/constants.ts

@@ -0,0 +1,4 @@
+export enum RemoteBackend {
+  local = 'local',
+  s3 = 's3',
+}

package/src/lib/cloudflare/common/construct.ts

@@ -1,5 +1,6 @@
+import { AwsProvider } from '@cdktf/provider-aws/lib/provider'
 import { CloudflareProvider } from '@cdktf/provider-cloudflare/lib/provider'
-import { TerraformStack, TerraformVariable } from 'cdktf'
+import { DataTerraformRemoteStateS3, S3Backend, TerraformStack, TerraformVariable } from 'cdktf'
 import { Construct } from 'constructs'
 import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
 import {
@@ -13,7 +14,9 @@ import {
   CloudflareWorkerManager,
   CloudflareZoneManager,
 } from '../services'
+import { RemoteBackend } from './constants'
 import { CommonCloudflareStackProps } from './types'
+import { DataAwsS3BucketObject } from '@cdktf/provider-aws/lib/data-aws-s3-bucket-object'
 
 export class CommonCloudflareConstruct extends TerraformStack {
   declare props: CommonCloudflareStackProps
@@ -47,13 +50,14 @@ export class CommonCloudflareConstruct extends TerraformStack {
     this.determineFullyQualifiedDomain()
     this.determineAccountId()
     this.determineApiToken()
+    this.determineRemoteBackend()
     new CloudflareProvider(this, `${this.id}-provider`, this.props)
   }
 
   /**
    * @summary Determine the fully qualified domain name based on domainName & subDomain
    */
-  protected determineFullyQualifiedDomain(): void {
+  protected determineFullyQualifiedDomain() {
     this.fullyQualifiedDomainName = this.props.subDomain
       ? `${this.props.subDomain}.${this.props.domainName}`
       : this.props.domainName
@@ -62,14 +66,49 @@ export class CommonCloudflareConstruct extends TerraformStack {
   /**
    * @summary Determine the account id based on the cdktf.json context
    */
-  protected determineAccountId(): void {
+  protected determineAccountId() {
     this.props.accountId = new TerraformVariable(this, `accountId`, {}).stringValue
   }
 
-  protected determineApiToken(): void {
+  /**
+   * @summary Determine the api token based on the cdktf.json context
+   */
+  protected determineApiToken() {
     this.props.apiToken = new TerraformVariable(this, `apiToken`, {}).stringValue
   }
 
+  protected determineRemoteBackend() {
+    const debug = this.node.tryGetContext('debug')
+    switch (this.props.remoteBackend?.type) {
+      case RemoteBackend.s3:
+        new AwsProvider(this, `${this.id}-aws-provider`, {
+          profile: process.env.AWS_PROFILE ?? 'default',
+          region: this.props.remoteBackend.region,
+        })
+        new S3Backend(this, {
+          bucket: this.props.remoteBackend.bucketName,
+          dynamodbTable: this.props.remoteBackend.tableName,
+          key: `${this.id}`,
+          profile: process.env.AWS_PROFILE ?? 'default',
+          region: this.props.remoteBackend.region,
+        })
+        new DataAwsS3BucketObject(this, `${this.id}-remote-state-ref`, {
+          bucket: this.props.remoteBackend.bucketName,
+          key: new DataTerraformRemoteStateS3(this, `${this.id}-remote-state`, {
+            bucket: this.props.remoteBackend.bucketName,
+            key: `${this.id}`,
+          }).getString('bucket_key'),
+        })
+
+        break
+      case RemoteBackend.local:
+        if (debug) console.debug(`Using local backend for ${this.id}`)
+        break
+      default:
+        break
+    }
+  }
+
   /**
    * @summary Utility method to determine if the initialisation is in development (dev) stage
    * This is determined by the stage property injected via cdk context

package/src/lib/cloudflare/common/index.ts

@@ -1,3 +1,4 @@
+export * from './constants'
 export * from './construct'
 export * from './stack'
 export * from './types'

package/src/lib/cloudflare/common/stack.ts

@@ -7,6 +7,7 @@ import { TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
 import _ from 'lodash'
 import { isDevStage } from '../../common'
+import { RemoteBackend } from './constants'
 
 /**
  * @classdesc Common stack to use as a base for all higher level constructs.
@@ -42,6 +43,7 @@ export class CommonCloudflareStack extends TerraformStack {
    * @returns The stack properties
    */
   protected determineConstructProps(props: CommonCloudflareStackProps) {
+    const stage = this.node.tryGetContext('stage')
     return {
       accountId: this.node.tryGetContext('accountId'),
       apiToken: this.node.tryGetContext('apiToken'),
@@ -50,7 +52,7 @@ export class CommonCloudflareStack extends TerraformStack {
       features: this.node.tryGetContext('features'),
       name: this.node.tryGetContext('resourceGroupName'),
       skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
-      stage: this.node.tryGetContext('stage'),
+      stage: stage,
       subDomain: this.node.tryGetContext('subDomain'),
     }
   }

package/src/lib/cloudflare/common/types.ts

@@ -1,10 +1,19 @@
 import { CloudflareProviderConfig } from '@cdktf/provider-cloudflare/lib/provider'
 import { BaseProps } from '../../common'
+import { RemoteBackend } from './constants'
+
+export interface RemoteBackendProps {
+  bucketName: string
+  region: string
+  tableName: string
+  type: RemoteBackend
+}
 
 /**
  */
 export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
   accountId: string
   apiToken: string
+  remoteBackend?: RemoteBackendProps
   useExistingZone?: boolean
 }