terraconstructs 0.0.8

package/lib/aws/storage/util.d.ts

@@ -0,0 +1,40 @@
+import { IConstruct } from "constructs";
+import { BucketOutputs } from "./bucket";
+export declare function parseBucketArn(construct: IConstruct, outputs: BucketOutputs): string;
+export declare function parseBucketName(construct: IConstruct, outputs: BucketOutputs): string | undefined;
+/**
+ * All http request methods
+ */
+export declare enum HttpMethods {
+    /**
+     * The GET method requests a representation of the specified resource.
+     */
+    GET = "GET",
+    /**
+     * The PUT method replaces all current representations of the target resource with the request payload.
+     */
+    PUT = "PUT",
+    /**
+     * The HEAD method asks for a response identical to that of a GET request, but without the response body.
+     */
+    HEAD = "HEAD",
+    /**
+     * The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.
+     */
+    POST = "POST",
+    /**
+     * The DELETE method deletes the specified resource.
+     */
+    DELETE = "DELETE"
+}
+/**
+ * All http request methods
+ */
+export declare enum RedirectProtocol {
+    HTTP = "http",
+    HTTPS = "https"
+}
+/**
+ * Normalize windows paths to be posix-like.
+ */
+export declare function normalPath(path: string): string;

package/lib/aws/storage/util.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalPath = exports.RedirectProtocol = exports.HttpMethods = exports.parseBucketName = exports.parseBucketArn = void 0;
+const __1 = require("..");
+function parseBucketArn(construct, outputs) {
+    // if we have an explicit bucket ARN, use it.
+    if (outputs.arn) {
+        return outputs.arn;
+    }
+    if (outputs.name) {
+        return __1.AwsStack.ofAwsConstruct(construct).formatArn({
+            // S3 Bucket names are globally unique in a partition,
+            // and so their ARNs have empty region and account components
+            region: "",
+            account: "",
+            service: "s3",
+            resource: outputs.name,
+        });
+    }
+    throw new Error("Cannot determine bucket ARN. At least `bucketArn` or `bucketName` is needed");
+}
+exports.parseBucketArn = parseBucketArn;
+function parseBucketName(construct, outputs) {
+    // if we have an explicit bucket name, use it.
+    if (outputs.name) {
+        return outputs.name;
+    }
+    // extract bucket name from bucket arn
+    if (outputs.arn) {
+        return __1.AwsStack.ofAwsConstruct(construct).splitArn(outputs.arn, __1.ArnFormat.SLASH_RESOURCE_NAME).resource;
+    }
+    // no bucket name is okay since it's optional.
+    return undefined;
+}
+exports.parseBucketName = parseBucketName;
+/**
+ * All http request methods
+ */
+var HttpMethods;
+(function (HttpMethods) {
+    /**
+     * The GET method requests a representation of the specified resource.
+     */
+    HttpMethods["GET"] = "GET";
+    /**
+     * The PUT method replaces all current representations of the target resource with the request payload.
+     */
+    HttpMethods["PUT"] = "PUT";
+    /**
+     * The HEAD method asks for a response identical to that of a GET request, but without the response body.
+     */
+    HttpMethods["HEAD"] = "HEAD";
+    /**
+     * The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.
+     */
+    HttpMethods["POST"] = "POST";
+    /**
+     * The DELETE method deletes the specified resource.
+     */
+    HttpMethods["DELETE"] = "DELETE";
+})(HttpMethods || (exports.HttpMethods = HttpMethods = {}));
+/**
+ * All http request methods
+ */
+var RedirectProtocol;
+(function (RedirectProtocol) {
+    RedirectProtocol["HTTP"] = "http";
+    RedirectProtocol["HTTPS"] = "https";
+})(RedirectProtocol || (exports.RedirectProtocol = RedirectProtocol = {}));
+/**
+ * Normalize windows paths to be posix-like.
+ */
+function normalPath(path) {
+    // ref: https://github.com/winglang/wing/blob/v0.83.8/libs/wingsdk/src/shared/misc.ts#L15
+    if (process.platform === "win32") {
+        return (path
+            // force posix path separator
+            .replace(/\\+/g, "/"));
+    }
+    else {
+        return path;
+    }
+}
+exports.normalPath = normalPath;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hd3Mvc3RvcmFnZS91dGlsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLDBCQUF5QztBQUd6QyxTQUFnQixjQUFjLENBQzVCLFNBQXFCLEVBQ3JCLE9BQXNCO0lBRXRCLDZDQUE2QztJQUM3QyxJQUFJLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNoQixPQUFPLE9BQU8sQ0FBQyxHQUFHLENBQUM7SUFDckIsQ0FBQztJQUVELElBQUksT0FBTyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2pCLE9BQU8sWUFBUSxDQUFDLGNBQWMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxTQUFTLENBQUM7WUFDbEQsc0RBQXNEO1lBQ3RELDZEQUE2RDtZQUM3RCxNQUFNLEVBQUUsRUFBRTtZQUNWLE9BQU8sRUFBRSxFQUFFO1lBQ1gsT0FBTyxFQUFFLElBQUk7WUFDYixRQUFRLEVBQUUsT0FBTyxDQUFDLElBQUk7U0FDdkIsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztJQUVELE1BQU0sSUFBSSxLQUFLLENBQ2IsNkVBQTZFLENBQzlFLENBQUM7QUFDSixDQUFDO0FBdkJELHdDQXVCQztBQUVELFNBQWdCLGVBQWUsQ0FDN0IsU0FBcUIsRUFDckIsT0FBc0I7SUFFdEIsOENBQThDO0lBQzlDLElBQUksT0FBTyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2pCLE9BQU8sT0FBTyxDQUFDLElBQUksQ0FBQztJQUN0QixDQUFDO0lBRUQsc0NBQXNDO0lBQ3RDLElBQUksT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQ2hCLE9BQU8sWUFBUSxDQUFDLGNBQWMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxRQUFRLENBQ2hELE9BQU8sQ0FBQyxHQUFHLEVBQ1gsYUFBUyxDQUFDLG1CQUFtQixDQUM5QixDQUFDLFFBQVEsQ0FBQztJQUNiLENBQUM7SUFFRCw4Q0FBOEM7SUFDOUMsT0FBTyxTQUFTLENBQUM7QUFDbkIsQ0FBQztBQW5CRCwwQ0FtQkM7QUFFRDs7R0FFRztBQUNILElBQVksV0FxQlg7QUFyQkQsV0FBWSxXQUFXO0lBQ3JCOztPQUVHO0lBQ0gsMEJBQVcsQ0FBQTtJQUNYOztPQUVHO0lBQ0gsMEJBQVcsQ0FBQTtJQUNYOztPQUVHO0lBQ0gsNEJBQWEsQ0FBQTtJQUNiOztPQUVHO0lBQ0gsNEJBQWEsQ0FBQTtJQUNiOztPQUVHO0lBQ0gsZ0NBQWlCLENBQUE7QUFDbkIsQ0FBQyxFQXJCVyxXQUFXLDJCQUFYLFdBQVcsUUFxQnRCO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLGdCQUdYO0FBSEQsV0FBWSxnQkFBZ0I7SUFDMUIsaUNBQWEsQ0FBQTtJQUNiLG1DQUFlLENBQUE7QUFDakIsQ0FBQyxFQUhXLGdCQUFnQixnQ0FBaEIsZ0JBQWdCLFFBRzNCO0FBRUQ7O0dBRUc7QUFDSCxTQUFnQixVQUFVLENBQUMsSUFBWTtJQUNyQyx5RkFBeUY7SUFDekYsSUFBSSxPQUFPLENBQUMsUUFBUSxLQUFLLE9BQU8sRUFBRSxDQUFDO1FBQ2pDLE9BQU8sQ0FDTCxJQUFJO1lBQ0YsNkJBQTZCO2FBQzVCLE9BQU8sQ0FBQyxNQUFNLEVBQUUsR0FBRyxDQUFDLENBQ3hCLENBQUM7SUFDSixDQUFDO1NBQU0sQ0FBQztRQUNOLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztBQUNILENBQUM7QUFYRCxnQ0FXQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IElDb25zdHJ1Y3QgfSBmcm9tIFwiY29uc3RydWN0c1wiO1xuaW1wb3J0IHsgQXdzU3RhY2ssIEFybkZvcm1hdCB9IGZyb20gXCIuLlwiO1xuaW1wb3J0IHsgQnVja2V0T3V0cHV0cyB9IGZyb20gXCIuL2J1Y2tldFwiO1xuXG5leHBvcnQgZnVuY3Rpb24gcGFyc2VCdWNrZXRBcm4oXG4gIGNvbnN0cnVjdDogSUNvbnN0cnVjdCxcbiAgb3V0cHV0czogQnVja2V0T3V0cHV0cyxcbik6IHN0cmluZyB7XG4gIC8vIGlmIHdlIGhhdmUgYW4gZXhwbGljaXQgYnVja2V0IEFSTiwgdXNlIGl0LlxuICBpZiAob3V0cHV0cy5hcm4pIHtcbiAgICByZXR1cm4gb3V0cHV0cy5hcm47XG4gIH1cblxuICBpZiAob3V0cHV0cy5uYW1lKSB7XG4gICAgcmV0dXJuIEF3c1N0YWNrLm9mQXdzQ29uc3RydWN0KGNvbnN0cnVjdCkuZm9ybWF0QXJuKHtcbiAgICAgIC8vIFMzIEJ1Y2tldCBuYW1lcyBhcmUgZ2xvYmFsbHkgdW5pcXVlIGluIGEgcGFydGl0aW9uLFxuICAgICAgLy8gYW5kIHNvIHRoZWlyIEFSTnMgaGF2ZSBlbXB0eSByZWdpb24gYW5kIGFjY291bnQgY29tcG9uZW50c1xuICAgICAgcmVnaW9uOiBcIlwiLFxuICAgICAgYWNjb3VudDogXCJcIixcbiAgICAgIHNlcnZpY2U6IFwiczNcIixcbiAgICAgIHJlc291cmNlOiBvdXRwdXRzLm5hbWUsXG4gICAgfSk7XG4gIH1cblxuICB0aHJvdyBuZXcgRXJyb3IoXG4gICAgXCJDYW5ub3QgZGV0ZXJtaW5lIGJ1Y2tldCBBUk4uIEF0IGxlYXN0IGBidWNrZXRBcm5gIG9yIGBidWNrZXROYW1lYCBpcyBuZWVkZWRcIixcbiAgKTtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIHBhcnNlQnVja2V0TmFtZShcbiAgY29uc3RydWN0OiBJQ29uc3RydWN0LFxuICBvdXRwdXRzOiBCdWNrZXRPdXRwdXRzLFxuKTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAgLy8gaWYgd2UgaGF2ZSBhbiBleHBsaWNpdCBidWNrZXQgbmFtZSwgdXNlIGl0LlxuICBpZiAob3V0cHV0cy5uYW1lKSB7XG4gICAgcmV0dXJuIG91dHB1dHMubmFtZTtcbiAgfVxuXG4gIC8vIGV4dHJhY3QgYnVja2V0IG5hbWUgZnJvbSBidWNrZXQgYXJuXG4gIGlmIChvdXRwdXRzLmFybikge1xuICAgIHJldHVybiBBd3NTdGFjay5vZkF3c0NvbnN0cnVjdChjb25zdHJ1Y3QpLnNwbGl0QXJuKFxuICAgICAgb3V0cHV0cy5hcm4sXG4gICAgICBBcm5Gb3JtYXQuU0xBU0hfUkVTT1VSQ0VfTkFNRSxcbiAgICApLnJlc291cmNlO1xuICB9XG5cbiAgLy8gbm8gYnVja2V0IG5hbWUgaXMgb2theSBzaW5jZSBpdCdzIG9wdGlvbmFsLlxuICByZXR1cm4gdW5kZWZpbmVkO1xufVxuXG4vKipcbiAqIEFsbCBodHRwIHJlcXVlc3QgbWV0aG9kc1xuICovXG5leHBvcnQgZW51bSBIdHRwTWV0aG9kcyB7XG4gIC8qKlxuICAgKiBUaGUgR0VUIG1ldGhvZCByZXF1ZXN0cyBhIHJlcHJlc2VudGF0aW9uIG9mIHRoZSBzcGVjaWZpZWQgcmVzb3VyY2UuXG4gICAqL1xuICBHRVQgPSBcIkdFVFwiLFxuICAvKipcbiAgICogVGhlIFBVVCBtZXRob2QgcmVwbGFjZXMgYWxsIGN1cnJlbnQgcmVwcmVzZW50YXRpb25zIG9mIHRoZSB0YXJnZXQgcmVzb3VyY2Ugd2l0aCB0aGUgcmVxdWVzdCBwYXlsb2FkLlxuICAgKi9cbiAgUFVUID0gXCJQVVRcIixcbiAgLyoqXG4gICAqIFRoZSBIRUFEIG1ldGhvZCBhc2tzIGZvciBhIHJlc3BvbnNlIGlkZW50aWNhbCB0byB0aGF0IG9mIGEgR0VUIHJlcXVlc3QsIGJ1dCB3aXRob3V0IHRoZSByZXNwb25zZSBib2R5LlxuICAgKi9cbiAgSEVBRCA9IFwiSEVBRFwiLFxuICAvKipcbiAgICogVGhlIFBPU1QgbWV0aG9kIGlzIHVzZWQgdG8gc3VibWl0IGFuIGVudGl0eSB0byB0aGUgc3BlY2lmaWVkIHJlc291cmNlLCBvZnRlbiBjYXVzaW5nIGEgY2hhbmdlIGluIHN0YXRlIG9yIHNpZGUgZWZmZWN0cyBvbiB0aGUgc2VydmVyLlxuICAgKi9cbiAgUE9TVCA9IFwiUE9TVFwiLFxuICAvKipcbiAgICogVGhlIERFTEVURSBtZXRob2QgZGVsZXRlcyB0aGUgc3BlY2lmaWVkIHJlc291cmNlLlxuICAgKi9cbiAgREVMRVRFID0gXCJERUxFVEVcIixcbn1cblxuLyoqXG4gKiBBbGwgaHR0cCByZXF1ZXN0IG1ldGhvZHNcbiAqL1xuZXhwb3J0IGVudW0gUmVkaXJlY3RQcm90b2NvbCB7XG4gIEhUVFAgPSBcImh0dHBcIixcbiAgSFRUUFMgPSBcImh0dHBzXCIsXG59XG5cbi8qKlxuICogTm9ybWFsaXplIHdpbmRvd3MgcGF0aHMgdG8gYmUgcG9zaXgtbGlrZS5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIG5vcm1hbFBhdGgocGF0aDogc3RyaW5nKSB7XG4gIC8vIHJlZjogaHR0cHM6Ly9naXRodWIuY29tL3dpbmdsYW5nL3dpbmcvYmxvYi92MC44My44L2xpYnMvd2luZ3Nkay9zcmMvc2hhcmVkL21pc2MudHMjTDE1XG4gIGlmIChwcm9jZXNzLnBsYXRmb3JtID09PSBcIndpbjMyXCIpIHtcbiAgICByZXR1cm4gKFxuICAgICAgcGF0aFxuICAgICAgICAvLyBmb3JjZSBwb3NpeCBwYXRoIHNlcGFyYXRvclxuICAgICAgICAucmVwbGFjZSgvXFxcXCsvZywgXCIvXCIpXG4gICAgKTtcbiAgfSBlbHNlIHtcbiAgICByZXR1cm4gcGF0aDtcbiAgfVxufVxuIl19

package/lib/aws/storage/website-config.generated.d.ts

@@ -0,0 +1,73 @@
+import type { FileProvisioner, IResolvable, ITerraformDependable, ITerraformIterator, LocalExecProvisioner, RemoteExecProvisioner, SSHProvisionerConnection, TerraformCount, TerraformProvider, TerraformResourceLifecycle, WinrmProvisionerConnection } from 'cdktf';
+import type { s3BucketWebsiteConfiguration } from '@cdktf/provider-aws';
+/**
+ * Provides an S3 bucket website configuration resource.
+ *
+ * For more information, see [Hosting Websites on S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
+ */
+export interface WebsiteConfig {
+    /**
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/s3_bucket_website_configuration#routing_rules S3BucketWebsiteConfiguration#routing_rules}.
+     * @stability stable
+     */
+    readonly routingRules?: string;
+    /**
+     * routing_rule block.
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/s3_bucket_website_configuration#routing_rule S3BucketWebsiteConfiguration#routing_rule}
+     * @stability stable
+     */
+    readonly routingRule?: IResolvable | Array<s3BucketWebsiteConfiguration.S3BucketWebsiteConfigurationRoutingRule>;
+    /**
+     * index_document block.
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/s3_bucket_website_configuration#index_document S3BucketWebsiteConfiguration#index_document}
+     * @default index.html
+     * @stability stable
+     */
+    readonly indexDocument?: string;
+    /**
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/s3_bucket_website_configuration#id S3BucketWebsiteConfiguration#id}.
+     * Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
+     * If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
+     * @stability stable
+     */
+    readonly id?: string;
+    /**
+     * error_document block.
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/s3_bucket_website_configuration#error_document S3BucketWebsiteConfiguration#error_document}
+     * @stability stable
+     */
+    readonly errorDocument?: s3BucketWebsiteConfiguration.S3BucketWebsiteConfigurationErrorDocument;
+    /**
+     * @stability experimental
+     */
+    readonly provisioners?: Array<FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner>;
+    /**
+     * @stability experimental
+     */
+    readonly provider?: TerraformProvider;
+    /**
+     * @stability experimental
+     */
+    readonly lifecycle?: TerraformResourceLifecycle;
+    /**
+     * @stability experimental
+     */
+    readonly forEach?: ITerraformIterator;
+    /**
+     * @stability experimental
+     */
+    readonly dependsOn?: Array<ITerraformDependable>;
+    /**
+     * @stability experimental
+     */
+    readonly count?: number | TerraformCount;
+    /**
+     * @stability experimental
+     */
+    readonly connection?: SSHProvisionerConnection | WinrmProvisionerConnection;
+    /**
+     * Set this to true to enable static website hosting.
+     * @default `true`
+     */
+    readonly enabled: boolean;
+}

package/lib/aws/storage/website-config.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2Vic2l0ZS1jb25maWcuZ2VuZXJhdGVkLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2F3cy9zdG9yYWdlL3dlYnNpdGUtY29uZmlnLmdlbmVyYXRlZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLy8gfn4gR2VuZXJhdGVkIGJ5IHByb2plbi4gVG8gbW9kaWZ5LCBlZGl0IC5wcm9qZW5yYy50cyBhbmQgcnVuIFwibnB4IHByb2plblwiLlxuaW1wb3J0IHR5cGUgeyBGaWxlUHJvdmlzaW9uZXIsIElSZXNvbHZhYmxlLCBJVGVycmFmb3JtRGVwZW5kYWJsZSwgSVRlcnJhZm9ybUl0ZXJhdG9yLCBMb2NhbEV4ZWNQcm92aXNpb25lciwgUmVtb3RlRXhlY1Byb3Zpc2lvbmVyLCBTU0hQcm92aXNpb25lckNvbm5lY3Rpb24sIFRlcnJhZm9ybUNvdW50LCBUZXJyYWZvcm1Qcm92aWRlciwgVGVycmFmb3JtUmVzb3VyY2VMaWZlY3ljbGUsIFdpbnJtUHJvdmlzaW9uZXJDb25uZWN0aW9uIH0gZnJvbSAnY2RrdGYnO1xuaW1wb3J0IHR5cGUgeyBzM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uIH0gZnJvbSAnQGNka3RmL3Byb3ZpZGVyLWF3cyc7XG5cbi8qKlxuICogUHJvdmlkZXMgYW4gUzMgYnVja2V0IHdlYnNpdGUgY29uZmlndXJhdGlvbiByZXNvdXJjZS5cbiAqXG4gKiBGb3IgbW9yZSBpbmZvcm1hdGlvbiwgc2VlIFtIb3N0aW5nIFdlYnNpdGVzIG9uIFMzXShodHRwczovL2RvY3MuYXdzLmFtYXpvbi5jb20vQW1hem9uUzMvbGF0ZXN0L2Rldi9XZWJzaXRlSG9zdGluZy5odG1sKS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBXZWJzaXRlQ29uZmlnIHtcbiAgLyoqXG4gICAqIERvY3MgYXQgVGVycmFmb3JtIFJlZ2lzdHJ5OiB7QGxpbmsgaHR0cHM6Ly9yZWdpc3RyeS50ZXJyYWZvcm0uaW8vcHJvdmlkZXJzL2hhc2hpY29ycC9hd3MvNS42OC4wL2RvY3MvcmVzb3VyY2VzL3MzX2J1Y2tldF93ZWJzaXRlX2NvbmZpZ3VyYXRpb24jcm91dGluZ19ydWxlcyBTM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uI3JvdXRpbmdfcnVsZXN9LlxuICAgKiBAc3RhYmlsaXR5IHN0YWJsZVxuICAgKi9cbiAgcmVhZG9ubHkgcm91dGluZ1J1bGVzPzogc3RyaW5nO1xuICAvKipcbiAgICogcm91dGluZ19ydWxlIGJsb2NrLlxuICAgKiBEb2NzIGF0IFRlcnJhZm9ybSBSZWdpc3RyeToge0BsaW5rIGh0dHBzOi8vcmVnaXN0cnkudGVycmFmb3JtLmlvL3Byb3ZpZGVycy9oYXNoaWNvcnAvYXdzLzUuNjguMC9kb2NzL3Jlc291cmNlcy9zM19idWNrZXRfd2Vic2l0ZV9jb25maWd1cmF0aW9uI3JvdXRpbmdfcnVsZSBTM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uI3JvdXRpbmdfcnVsZX1cbiAgICogQHN0YWJpbGl0eSBzdGFibGVcbiAgICovXG4gIHJlYWRvbmx5IHJvdXRpbmdSdWxlPzogSVJlc29sdmFibGUgfCBBcnJheTxzM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uLlMzQnVja2V0V2Vic2l0ZUNvbmZpZ3VyYXRpb25Sb3V0aW5nUnVsZT47XG4gIC8qKlxuICAgKiBpbmRleF9kb2N1bWVudCBibG9jay5cbiAgICogRG9jcyBhdCBUZXJyYWZvcm0gUmVnaXN0cnk6IHtAbGluayBodHRwczovL3JlZ2lzdHJ5LnRlcnJhZm9ybS5pby9wcm92aWRlcnMvaGFzaGljb3JwL2F3cy81LjY4LjAvZG9jcy9yZXNvdXJjZXMvczNfYnVja2V0X3dlYnNpdGVfY29uZmlndXJhdGlvbiNpbmRleF9kb2N1bWVudCBTM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uI2luZGV4X2RvY3VtZW50fVxuICAgKiBAZGVmYXVsdCBpbmRleC5odG1sXG4gICAqIEBzdGFiaWxpdHkgc3RhYmxlXG4gICAqL1xuICByZWFkb25seSBpbmRleERvY3VtZW50Pzogc3RyaW5nO1xuICAvKipcbiAgICogRG9jcyBhdCBUZXJyYWZvcm0gUmVnaXN0cnk6IHtAbGluayBodHRwczovL3JlZ2lzdHJ5LnRlcnJhZm9ybS5pby9wcm92aWRlcnMvaGFzaGljb3JwL2F3cy81LjY4LjAvZG9jcy9yZXNvdXJjZXMvczNfYnVja2V0X3dlYnNpdGVfY29uZmlndXJhdGlvbiNpZCBTM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uI2lkfS5cbiAgICogUGxlYXNlIGJlIGF3YXJlIHRoYXQgdGhlIGlkIGZpZWxkIGlzIGF1dG9tYXRpY2FsbHkgYWRkZWQgdG8gYWxsIHJlc291cmNlcyBpbiBUZXJyYWZvcm0gcHJvdmlkZXJzIHVzaW5nIGEgVGVycmFmb3JtIHByb3ZpZGVyIFNESyB2ZXJzaW9uIGJlbG93IDIuXG4gICAqIElmIHlvdSBleHBlcmllbmNlIHByb2JsZW1zIHNldHRpbmcgdGhpcyB2YWx1ZSBpdCBtaWdodCBub3QgYmUgc2V0dGFibGUuIFBsZWFzZSB0YWtlIGEgbG9vayBhdCB0aGUgcHJvdmlkZXIgZG9jdW1lbnRhdGlvbiB0byBlbnN1cmUgaXQgc2hvdWxkIGJlIHNldHRhYmxlLlxuICAgKiBAc3RhYmlsaXR5IHN0YWJsZVxuICAgKi9cbiAgcmVhZG9ubHkgaWQ/OiBzdHJpbmc7XG4gIC8qKlxuICAgKiBlcnJvcl9kb2N1bWVudCBibG9jay5cbiAgICogRG9jcyBhdCBUZXJyYWZvcm0gUmVnaXN0cnk6IHtAbGluayBodHRwczovL3JlZ2lzdHJ5LnRlcnJhZm9ybS5pby9wcm92aWRlcnMvaGFzaGljb3JwL2F3cy81LjY4LjAvZG9jcy9yZXNvdXJjZXMvczNfYnVja2V0X3dlYnNpdGVfY29uZmlndXJhdGlvbiNlcnJvcl9kb2N1bWVudCBTM0J1Y2tldFdlYnNpdGVDb25maWd1cmF0aW9uI2Vycm9yX2RvY3VtZW50fVxuICAgKiBAc3RhYmlsaXR5IHN0YWJsZVxuICAgKi9cbiAgcmVhZG9ubHkgZXJyb3JEb2N1bWVudD86IHMzQnVja2V0V2Vic2l0ZUNvbmZpZ3VyYXRpb24uUzNCdWNrZXRXZWJzaXRlQ29uZmlndXJhdGlvbkVycm9yRG9jdW1lbnQ7XG4gIC8qKlxuICAgKiBAc3RhYmlsaXR5IGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgcmVhZG9ubHkgcHJvdmlzaW9uZXJzPzogQXJyYXk8RmlsZVByb3Zpc2lvbmVyIHwgTG9jYWxFeGVjUHJvdmlzaW9uZXIgfCBSZW1vdGVFeGVjUHJvdmlzaW9uZXI+O1xuICAvKipcbiAgICogQHN0YWJpbGl0eSBleHBlcmltZW50YWxcbiAgICovXG4gIHJlYWRvbmx5IHByb3ZpZGVyPzogVGVycmFmb3JtUHJvdmlkZXI7XG4gIC8qKlxuICAgKiBAc3RhYmlsaXR5IGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgcmVhZG9ubHkgbGlmZWN5Y2xlPzogVGVycmFmb3JtUmVzb3VyY2VMaWZlY3ljbGU7XG4gIC8qKlxuICAgKiBAc3RhYmlsaXR5IGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgcmVhZG9ubHkgZm9yRWFjaD86IElUZXJyYWZvcm1JdGVyYXRvcjtcbiAgLyoqXG4gICAqIEBzdGFiaWxpdHkgZXhwZXJpbWVudGFsXG4gICAqL1xuICByZWFkb25seSBkZXBlbmRzT24/OiBBcnJheTxJVGVycmFmb3JtRGVwZW5kYWJsZT47XG4gIC8qKlxuICAgKiBAc3RhYmlsaXR5IGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgcmVhZG9ubHkgY291bnQ/OiBudW1iZXIgfCBUZXJyYWZvcm1Db3VudDtcbiAgLyoqXG4gICAqIEBzdGFiaWxpdHkgZXhwZXJpbWVudGFsXG4gICAqL1xuICByZWFkb25seSBjb25uZWN0aW9uPzogU1NIUHJvdmlzaW9uZXJDb25uZWN0aW9uIHwgV2lucm1Qcm92aXNpb25lckNvbm5lY3Rpb247XG4gIC8qKlxuICAgKiBTZXQgdGhpcyB0byB0cnVlIHRvIGVuYWJsZSBzdGF0aWMgd2Vic2l0ZSBob3N0aW5nLlxuICAgKiBAZGVmYXVsdCBgdHJ1ZWBcbiAgICovXG4gIHJlYWRvbmx5IGVuYWJsZWQ6IGJvb2xlYW47XG59XG4iXX0=

package/lib/aws/util.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns a copy of `obj` without `undefined` (or `null`) values in maps or arrays.
+ */
+export declare function filterUndefined(obj: any): any;

package/lib/aws/util.js

@@ -0,0 +1,25 @@
+"use strict";
+// ref: https://github.com/aws/aws-cdk/blob/v2.150.0/packages/aws-cdk-lib/core/lib/util.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterUndefined = void 0;
+/**
+ * Returns a copy of `obj` without `undefined` (or `null`) values in maps or arrays.
+ */
+function filterUndefined(obj) {
+    if (Array.isArray(obj)) {
+        return obj.filter((x) => x != null).map((x) => filterUndefined(x));
+    }
+    if (typeof obj === "object") {
+        const ret = {};
+        for (const [key, value] of Object.entries(obj)) {
+            if (value == null) {
+                continue;
+            }
+            ret[key] = filterUndefined(value);
+        }
+        return ret;
+    }
+    return obj;
+}
+exports.filterUndefined = filterUndefined;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hd3MvdXRpbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEZBQTBGOzs7QUFFMUY7O0dBRUc7QUFDSCxTQUFnQixlQUFlLENBQUMsR0FBUTtJQUN0QyxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUN2QixPQUFPLEdBQUcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLENBQUM7SUFFRCxJQUFJLE9BQU8sR0FBRyxLQUFLLFFBQVEsRUFBRSxDQUFDO1FBQzVCLE1BQU0sR0FBRyxHQUFRLEVBQUUsQ0FBQztRQUNwQixLQUFLLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQy9DLElBQUksS0FBSyxJQUFJLElBQUksRUFBRSxDQUFDO2dCQUNsQixTQUFTO1lBQ1gsQ0FBQztZQUNELEdBQUcsQ0FBQyxHQUFHLENBQUMsR0FBRyxlQUFlLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDcEMsQ0FBQztRQUNELE9BQU8sR0FBRyxDQUFDO0lBQ2IsQ0FBQztJQUVELE9BQU8sR0FBRyxDQUFDO0FBQ2IsQ0FBQztBQWpCRCwwQ0FpQkMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyByZWY6IGh0dHBzOi8vZ2l0aHViLmNvbS9hd3MvYXdzLWNkay9ibG9iL3YyLjE1MC4wL3BhY2thZ2VzL2F3cy1jZGstbGliL2NvcmUvbGliL3V0aWwudHNcblxuLyoqXG4gKiBSZXR1cm5zIGEgY29weSBvZiBgb2JqYCB3aXRob3V0IGB1bmRlZmluZWRgIChvciBgbnVsbGApIHZhbHVlcyBpbiBtYXBzIG9yIGFycmF5cy5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGZpbHRlclVuZGVmaW5lZChvYmo6IGFueSk6IGFueSB7XG4gIGlmIChBcnJheS5pc0FycmF5KG9iaikpIHtcbiAgICByZXR1cm4gb2JqLmZpbHRlcigoeCkgPT4geCAhPSBudWxsKS5tYXAoKHgpID0+IGZpbHRlclVuZGVmaW5lZCh4KSk7XG4gIH1cblxuICBpZiAodHlwZW9mIG9iaiA9PT0gXCJvYmplY3RcIikge1xuICAgIGNvbnN0IHJldDogYW55ID0ge307XG4gICAgZm9yIChjb25zdCBba2V5LCB2YWx1ZV0gb2YgT2JqZWN0LmVudHJpZXMob2JqKSkge1xuICAgICAgaWYgKHZhbHVlID09IG51bGwpIHtcbiAgICAgICAgY29udGludWU7XG4gICAgICB9XG4gICAgICByZXRba2V5XSA9IGZpbHRlclVuZGVmaW5lZCh2YWx1ZSk7XG4gICAgfVxuICAgIHJldHVybiByZXQ7XG4gIH1cblxuICByZXR1cm4gb2JqO1xufVxuIl19

package/lib/construct-base.d.ts

@@ -0,0 +1,69 @@
+import { TerraformElement, TerraformMetaArguments, IAspect } from "cdktf";
+import { Construct, IConstruct } from "constructs";
+export interface TerraConstructProps extends TerraformMetaArguments {
+    /**
+     * The friendly name for TerraConstruct resources
+     *
+     * @default - `environmentName-id`
+     */
+    readonly friendlyName?: string;
+    /**
+     * Whether to register Terraform outputs for this TerraConstruct
+     *
+     * @default false
+     */
+    readonly registerOutputs?: boolean;
+    /**
+     * Optional override for the outputs name
+     *
+     * @default id
+     */
+    readonly outputName?: string;
+}
+export interface ITerraConstruct extends IConstruct {
+    /**
+     * Environment Name passed in from the CLI
+     */
+    readonly environmentName: string;
+    readonly gridUUID: string;
+    readonly outputs: Record<string, any>;
+}
+export declare class GridTags implements IAspect {
+    private tagsToAdd;
+    constructor(tagsToAdd: Record<string, string>);
+    visit(node: IConstruct): void;
+}
+/**
+ * Base class for all TerraConstructs
+ *
+ * Allows a TerraConstruct to lazily register its outputs with its parent Stack
+ */
+export declare abstract class TerraConstructBase extends TerraformElement implements ITerraConstruct {
+    private readonly constructId;
+    /**
+     * Returns true if the construct was created by CDKTF, and false otherwise
+     */
+    static isOwnedResource(construct: IConstruct): boolean;
+    /**
+     * The name under which the outputs are registered in the parent Scope
+     */
+    readonly outputName: string;
+    /**
+     * TerraConstruct friendly name
+     */
+    readonly friendlyName: string;
+    /**
+     * TerraConstruct unique grid identifier
+     */
+    get gridUUID(): string;
+    /**
+     * Environment Name passed in from the CLI
+     */
+    get environmentName(): string;
+    /**
+     * Outputs to register with the parent Scope or undefined if there are no outputs
+     */
+    abstract get outputs(): Record<string, any>;
+    constructor(scope: Construct, constructId: string, props?: TerraConstructProps);
+    get fqn(): string;
+}

package/lib/construct-base.js

@@ -0,0 +1,89 @@
+"use strict";
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerraConstructBase = exports.GridTags = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const cdktf_1 = require("cdktf");
+const stack_base_1 = require("./stack-base");
+function isTaggableConstruct(x) {
+    return (cdktf_1.TerraformResource.isTerraformResource(x) && "tags" in x && "tagsInput" in x);
+}
+const GRID_TAG_PREFIX = "grid";
+// Add Grid Tags to all TerraConstruct resources
+class GridTags {
+    constructor(tagsToAdd) {
+        this.tagsToAdd = tagsToAdd;
+    }
+    visit(node) {
+        if (isTaggableConstruct(node)) {
+            // https://developer.hashicorp.com/terraform/cdktf/concepts/aspects
+            const currentTags = node.tagsInput || {};
+            node.tags = { ...this.tagsToAdd, ...currentTags };
+        }
+    }
+}
+exports.GridTags = GridTags;
+_a = JSII_RTTI_SYMBOL_1;
+GridTags[_a] = { fqn: "terraconstructs.GridTags", version: "0.0.8" };
+/**
+ * Base class for all TerraConstructs
+ *
+ * Allows a TerraConstruct to lazily register its outputs with its parent Stack
+ */
+class TerraConstructBase extends cdktf_1.TerraformElement {
+    /**
+     * Returns true if the construct was created by CDKTF, and false otherwise
+     */
+    static isOwnedResource(construct) {
+        return construct.node.defaultChild
+            ? cdktf_1.TerraformResource.isTerraformResource(construct.node.defaultChild)
+            : false;
+    }
+    /**
+     * TerraConstruct unique grid identifier
+     */
+    get gridUUID() {
+        return stack_base_1.StackBase.ofTerraConstruct(this).gridUUID;
+    }
+    /**
+     * Environment Name passed in from the CLI
+     */
+    get environmentName() {
+        return stack_base_1.StackBase.ofTerraConstruct(this).environmentName;
+    }
+    constructor(scope, constructId, props = {}) {
+        super(scope, constructId);
+        this.constructId = constructId;
+        this.outputName = props.outputName || `${constructId}Outputs`;
+        this.friendlyName =
+            props.friendlyName || `${this.environmentName}-${constructId}`;
+        cdktf_1.Aspects.of(this) // Add Grid tags to every resource defined within.
+            .add(new GridTags({
+            [`${GRID_TAG_PREFIX}:EnvironmentName`]: this.environmentName,
+            [`${GRID_TAG_PREFIX}:UUID`]: this.gridUUID,
+            Name: this.friendlyName,
+        }));
+        const registerOutputs = props.registerOutputs || false;
+        if (registerOutputs) {
+            new cdktf_1.TerraformOutput(scope, this.outputName, {
+                staticId: true,
+                description: `Outputs for ${this.friendlyName}`,
+                value: cdktf_1.Lazy.anyValue({ produce: () => this.outputs || null }),
+            });
+        }
+    }
+    // force usage of node.addDependency instead of passing TerraConstructs via dependsOn
+    // Refering a TerraConstruct by fqn always triggers an error?
+    get fqn() {
+        // try {
+        //   return super.fqn;
+        // } catch (e) {
+        // ref: https://github.com/aws/constructs/blob/10.x/src/construct.ts#L345
+        throw new Error(`Use Construct node.addDependency instead of passing TerraConstruct fqn ${this.constructor.name} ${this.constructId}`);
+        // }
+    }
+}
+exports.TerraConstructBase = TerraConstructBase;
+_b = JSII_RTTI_SYMBOL_1;
+TerraConstructBase[_b] = { fqn: "terraconstructs.TerraConstructBase", version: "0.0.8" };
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"construct-base.js","sourceRoot":"","sources":["../src/construct-base.ts"],"names":[],"mappings":";;;;;AAAA,iCAQe;AAEf,6CAAyC;AAuCzC,SAAS,mBAAmB,CAAC,CAAa;IACxC,OAAO,CACL,yBAAiB,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,MAAM,IAAI,CAAC,IAAI,WAAW,IAAI,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,gDAAgD;AAChD,MAAa,QAAQ;IACnB,YAAoB,SAAiC;QAAjC,cAAS,GAAT,SAAS,CAAwB;IAAG,CAAC;IACzD,KAAK,CAAC,IAAgB;QACpB,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,mEAAmE;YACnE,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,WAAW,EAAE,CAAC;QACpD,CAAC;IACH,CAAC;;AARH,4BASC;;;AAED;;;;GAIG;AACH,MAAsB,kBACpB,SAAQ,wBAAgB;IAGxB;;OAEG;IACI,MAAM,CAAC,eAAe,CAAC,SAAqB;QACjD,OAAO,SAAS,CAAC,IAAI,CAAC,YAAY;YAChC,CAAC,CAAC,yBAAiB,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;YACpE,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC;IAYD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,sBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,sBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC;IAC1D,CAAC;IAOD,YACE,KAAgB,EACC,WAAmB,EACpC,QAA6B,EAAE;QAE/B,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAHT,gBAAW,GAAX,WAAW,CAAQ;QAIpC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,GAAG,WAAW,SAAS,CAAC;QAC9D,IAAI,CAAC,YAAY;YACf,KAAK,CAAC,YAAY,IAAI,GAAG,IAAI,CAAC,eAAe,IAAI,WAAW,EAAE,CAAC;QAEjE,eAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,kDAAkD;aAChE,GAAG,CACF,IAAI,QAAQ,CAAC;YACX,CAAC,GAAG,eAAe,kBAAkB,CAAC,EAAE,IAAI,CAAC,eAAe;YAC5D,CAAC,GAAG,eAAe,OAAO,CAAC,EAAE,IAAI,CAAC,QAAQ;YAC1C,IAAI,EAAE,IAAI,CAAC,YAAY;SACxB,CAAC,CACH,CAAC;QACJ,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC;QACvD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,uBAAe,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE;gBAC1C,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,eAAe,IAAI,CAAC,YAAY,EAAE;gBAC/C,KAAK,EAAE,YAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;aAC9D,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,qFAAqF;IACrF,6DAA6D;IAC7D,IAAW,GAAG;QACZ,QAAQ;QACR,sBAAsB;QACtB,gBAAgB;QAChB,yEAAyE;QACzE,MAAM,IAAI,KAAK,CACb,0EAA0E,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CACtH,CAAC;QACF,IAAI;IACN,CAAC;;AAjFH,gDAkFC","sourcesContent":["import {\n  Lazy,\n  TerraformResource,\n  TerraformElement,\n  TerraformOutput,\n  TerraformMetaArguments,\n  Aspects,\n  IAspect,\n} from \"cdktf\";\nimport { Construct, IConstruct } from \"constructs\";\nimport { StackBase } from \"./stack-base\";\n\nexport interface TerraConstructProps extends TerraformMetaArguments {\n  /**\n   * The friendly name for TerraConstruct resources\n   *\n   * @default - `environmentName-id`\n   */\n  readonly friendlyName?: string;\n\n  /**\n   * Whether to register Terraform outputs for this TerraConstruct\n   *\n   * @default false\n   */\n  readonly registerOutputs?: boolean;\n\n  /**\n   * Optional override for the outputs name\n   *\n   * @default id\n   */\n  readonly outputName?: string;\n}\n\nexport interface ITerraConstruct extends IConstruct {\n  /**\n   * Environment Name passed in from the CLI\n   */\n  readonly environmentName: string;\n  readonly gridUUID: string;\n  readonly outputs: Record<string, any>;\n}\n\ntype TaggableConstruct = IConstruct & {\n  tags?: { [key: string]: string };\n  tagsInput?: { [key: string]: string };\n};\n\nfunction isTaggableConstruct(x: IConstruct): x is TaggableConstruct {\n  return (\n    TerraformResource.isTerraformResource(x) && \"tags\" in x && \"tagsInput\" in x\n  );\n}\n\nconst GRID_TAG_PREFIX = \"grid\";\n\n// Add Grid Tags to all TerraConstruct resources\nexport class GridTags implements IAspect {\n  constructor(private tagsToAdd: Record<string, string>) {}\n  visit(node: IConstruct) {\n    if (isTaggableConstruct(node)) {\n      // https://developer.hashicorp.com/terraform/cdktf/concepts/aspects\n      const currentTags = node.tagsInput || {};\n      node.tags = { ...this.tagsToAdd, ...currentTags };\n    }\n  }\n}\n\n/**\n * Base class for all TerraConstructs\n *\n * Allows a TerraConstruct to lazily register its outputs with its parent Stack\n */\nexport abstract class TerraConstructBase\n  extends TerraformElement\n  implements ITerraConstruct\n{\n  /**\n   * Returns true if the construct was created by CDKTF, and false otherwise\n   */\n  public static isOwnedResource(construct: IConstruct): boolean {\n    return construct.node.defaultChild\n      ? TerraformResource.isTerraformResource(construct.node.defaultChild)\n      : false;\n  }\n\n  /**\n   * The name under which the outputs are registered in the parent Scope\n   */\n  public readonly outputName: string;\n\n  /**\n   * TerraConstruct friendly name\n   */\n  public readonly friendlyName: string;\n\n  /**\n   * TerraConstruct unique grid identifier\n   */\n  public get gridUUID(): string {\n    return StackBase.ofTerraConstruct(this).gridUUID;\n  }\n\n  /**\n   * Environment Name passed in from the CLI\n   */\n  public get environmentName(): string {\n    return StackBase.ofTerraConstruct(this).environmentName;\n  }\n\n  /**\n   * Outputs to register with the parent Scope or undefined if there are no outputs\n   */\n  public abstract get outputs(): Record<string, any>; // TODO: should be allowed to be undefined?\n\n  constructor(\n    scope: Construct,\n    private readonly constructId: string,\n    props: TerraConstructProps = {},\n  ) {\n    super(scope, constructId);\n    this.outputName = props.outputName || `${constructId}Outputs`;\n    this.friendlyName =\n      props.friendlyName || `${this.environmentName}-${constructId}`;\n\n    Aspects.of(this) // Add Grid tags to every resource defined within.\n      .add(\n        new GridTags({\n          [`${GRID_TAG_PREFIX}:EnvironmentName`]: this.environmentName,\n          [`${GRID_TAG_PREFIX}:UUID`]: this.gridUUID,\n          Name: this.friendlyName,\n        }),\n      );\n    const registerOutputs = props.registerOutputs || false;\n    if (registerOutputs) {\n      new TerraformOutput(scope, this.outputName, {\n        staticId: true,\n        description: `Outputs for ${this.friendlyName}`,\n        value: Lazy.anyValue({ produce: () => this.outputs || null }),\n      });\n    }\n  }\n\n  // force usage of node.addDependency instead of passing TerraConstructs via dependsOn\n  // Refering a TerraConstruct by fqn always triggers an error?\n  public get fqn(): string {\n    // try {\n    //   return super.fqn;\n    // } catch (e) {\n    // ref: https://github.com/aws/constructs/blob/10.x/src/construct.ts#L345\n    throw new Error(\n      `Use Construct node.addDependency instead of passing TerraConstruct fqn ${this.constructor.name} ${this.constructId}`,\n    );\n    // }\n  }\n}\n"]}

package/lib/duration.d.ts

@@ -0,0 +1,160 @@
+/**
+ * Represents a length of time.
+ *
+ * The amount can be specified either as a literal value (e.g: `10`) which
+ * cannot be negative, or as an unresolved number token.
+ *
+ * When the amount is passed as a token, unit conversion is not possible.
+ */
+export declare class Duration {
+    /**
+     * Create a Duration representing an amount of milliseconds
+     *
+     * @param amount the amount of Milliseconds the `Duration` will represent.
+     * @returns a new `Duration` representing `amount` ms.
+     */
+    static millis(amount: number): Duration;
+    /**
+     * Create a Duration representing an amount of seconds
+     *
+     * @param amount the amount of Seconds the `Duration` will represent.
+     * @returns a new `Duration` representing `amount` Seconds.
+     */
+    static seconds(amount: number): Duration;
+    /**
+     * Create a Duration representing an amount of minutes
+     *
+     * @param amount the amount of Minutes the `Duration` will represent.
+     * @returns a new `Duration` representing `amount` Minutes.
+     */
+    static minutes(amount: number): Duration;
+    /**
+     * Create a Duration representing an amount of hours
+     *
+     * @param amount the amount of Hours the `Duration` will represent.
+     * @returns a new `Duration` representing `amount` Hours.
+     */
+    static hours(amount: number): Duration;
+    /**
+     * Create a Duration representing an amount of days
+     *
+     * @param amount the amount of Days the `Duration` will represent.
+     * @returns a new `Duration` representing `amount` Days.
+     */
+    static days(amount: number): Duration;
+    /**
+     * Parse a period formatted according to the ISO 8601 standard
+     *
+     * Days are the largest ISO duration supported, i.e.,
+     * weeks, months, and years are not supported.
+     *
+     * @example
+     * // This represents 1 day, 2 hours, 3 minutes, 4 seconds, and 567 milliseconds.
+     * 'P1DT2H3M4.567S'
+     *
+     * @see https://www.iso.org/standard/70907.html
+     * @param duration an ISO-formatted duration to be parsed.
+     * @returns the parsed `Duration`.
+     */
+    static parse(duration: string): Duration;
+    private readonly amount;
+    private readonly unit;
+    private constructor();
+    /**
+     * Add two Durations together
+     */
+    plus(rhs: Duration): Duration;
+    /**
+     * Substract two Durations together
+     */
+    minus(rhs: Duration): Duration;
+    /**
+     * Return the total number of milliseconds in this Duration
+     *
+     * @returns the value of this `Duration` expressed in Milliseconds.
+     */
+    toMilliseconds(opts?: TimeConversionOptions): number;
+    /**
+     * Return the total number of seconds in this Duration
+     *
+     * @returns the value of this `Duration` expressed in Seconds.
+     */
+    toSeconds(opts?: TimeConversionOptions): number;
+    /**
+     * Return the total number of minutes in this Duration
+     *
+     * @returns the value of this `Duration` expressed in Minutes.
+     */
+    toMinutes(opts?: TimeConversionOptions): number;
+    /**
+     * Return the total number of hours in this Duration
+     *
+     * @returns the value of this `Duration` expressed in Hours.
+     */
+    toHours(opts?: TimeConversionOptions): number;
+    /**
+     * Return the total number of days in this Duration
+     *
+     * @returns the value of this `Duration` expressed in Days.
+     */
+    toDays(opts?: TimeConversionOptions): number;
+    /**
+     * Return an ISO 8601 representation of this period
+     *
+     * @returns a string starting with 'P' describing the period
+     * @see https://www.iso.org/standard/70907.html
+     */
+    toIsoString(): string;
+    /**
+     * Return an ISO 8601 representation of this period
+     *
+     * @returns a string starting with 'P' describing the period
+     * @see https://www.iso.org/standard/70907.html
+     * @deprecated Use `toIsoString()` instead.
+     */
+    toISOString(): string;
+    /**
+     * Turn this duration into a human-readable string
+     */
+    toHumanString(): string;
+    /**
+     * Returns a string representation of this `Duration`
+     *
+     * This is is never the right function to use when you want to use the `Duration`
+     * object in a template. Use `toSeconds()`, `toMinutes()`, `toDays()`, etc. instead.
+     */
+    toString(): string;
+    /**
+     * Return the duration in a set of whole numbered time components, ordered from largest to smallest
+     *
+     * Only components != 0 will be returned.
+     *
+     * Can combine millis and seconds together for the benefit of toIsoString,
+     * makes the logic in there simpler.
+     */
+    private components;
+    /**
+     * Checks if duration is a token or a resolvable object
+     */
+    isUnresolved(): boolean;
+    /**
+     * Returns unit of the duration
+     */
+    unitLabel(): string;
+    /**
+     * Returns stringified number of duration
+     */
+    formatTokenToNumber(): string;
+}
+/**
+ * Options for how to convert time to a different unit.
+ */
+export interface TimeConversionOptions {
+    /**
+     * If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`) will fail if the result is not an
+     * integer.
+     *
+     * @default true
+     */
+    readonly integral?: boolean;
+}