@ryan-pip/pulumi-fivetran 1.5.1 → 1.9.4

package/connectorSchemaConfig.js

@@ -1,11 +1,221 @@
 "use strict";
-// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
 // *** Do not edit by hand unless you're certain you know what you are doing! ***
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConnectorSchemaConfig = void 0;
-const pulumi = require("@pulumi/pulumi");
-const utilities = require("./utilities");
+const pulumi = __importStar(require("@pulumi/pulumi"));
+const utilities = __importStar(require("./utilities"));
 /**
+ * ## page_title: "Resource: fivetran.ConnectorSchemaConfig"
+ *
+ * ***
+ *
+ * # Resource: fivetran.ConnectorSchemaConfig
+ *
+ * This resource allows you to manage the Standard Configuration settings of a connector:
+ *  - Define the schema change handling settings
+ *  - Enable and disable schemas, tables, and columns
+ *
+ * The resource is in **ALPHA** state. The resource schema and behavior are subject to change without prior notice.
+ *
+ * Known issues:
+ *  - Definition of `syncMode` for table may cause infinite drifting changes in plan.
+ *  - Using `schema` field causes very slow plan preparation because of slow performance for SetTypable fields in terraform-framework, please use MapTypable `schemas` field instead.
+ *
+ * ## Usage guide
+ *
+ * Note that all configuration settings are aligned to the `schemaChangeHandling` settings,  except the settings explicitly specified in `schemas`.
+ * In `schemas`, you only override the default settings defined by the chosen `schemaChangeHandling` option.
+ * The allowed `schemaChangeHandling` options are as follows:
+ * - `ALLOW_ALL`- all schemas, tables and columns are ENABLED by default. You only need  to explicitly specify DISABLED items or hashed tables
+ * - `BLOCK_ALL` - all schemas, tables and columns are DISABLED by default, the configuration only specifies ENABLED items
+ * - `ALLOW_COLUMNS` - all schemas and tables are DISABLED by default, but all columns are ENABLED by default, the configuration specifies ENABLED schemas and tables, and DISABLED columns
+ *
+ * Note that system-enabled tables and columns (such as primary and foreign key columns, and [system tables and columns](https://fivetran.com/docs/getting-started/system-columns-and-tables)) are synced regardless of the `schemaChangeHandling` settings and configuration. You can only disable non-locked columns in the system-enabled tables. If the configuration specifies any system tables or locked system table columns as disabled ( `enabled = "false"`), the provider just ignores these statements.
+ *
+ * ## Usage examples
+ *
+ * ### Example for the ALLOW_ALL option
+ *
+ * In `schemas`,  you only need to specify schemas and tables you want to disable (`enabled = "false"`) and columns you want to disable or hash (`hashed = "true"`).
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as fivetran from "@ryan-pip/pulumi-fivetran";
+ *
+ * const schema = new fivetran.ConnectorSchemaConfig("schema", {
+ *     connectorId: "connector_id",
+ *     schemaChangeHandling: "ALLOW_ALL",
+ *     schemas: {
+ *         schema_name: {
+ *             tables: {
+ *                 table_name: {
+ *                     columns: {
+ *                         hashed_column_name: {
+ *                             hashed: true,
+ *                         },
+ *                         blocked_column_name: {
+ *                             enabled: false,
+ *                         },
+ *                     },
+ *                 },
+ *                 blocked_table_name: {
+ *                     enabled: false,
+ *                 },
+ *             },
+ *         },
+ *         blocked_schema: {
+ *             enabled: false,
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * The configuration resulting from the example request is as follows:
+ * - All new and existing schemas except `blockedSchema` are enabled
+ * - All new and existing tables in the `schemaName` schema except the `blockedTableName` table are enabled
+ * - All new and existing columns in the`tableName` of the `schemaName` schema except the `blockedColumnName` column are enabled
+ * - The `hashedColumnName` column is hashed in the `tableName` table in the `schemaName` schema
+ * - All new schemas, tables, and columns are enabled once captured by the connector during the sync except those disabled by the system
+ *
+ * ### Example for the BLOCK_ALL option
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as fivetran from "@ryan-pip/pulumi-fivetran";
+ *
+ * const schema = new fivetran.ConnectorSchemaConfig("schema", {
+ *     connectorId: "connector_id",
+ *     schemaChangeHandling: "BLOCK_ALL",
+ *     schemas: {
+ *         schema_name: {
+ *             tables: {
+ *                 table_name: {
+ *                     columns: {
+ *                         hashed_column_name: {
+ *                             hashed: true,
+ *                         },
+ *                     },
+ *                 },
+ *                 enabled_table_name: {
+ *                     enabled: true,
+ *                 },
+ *             },
+ *         },
+ *         enabled_schema: {
+ *             enabled: true,
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * The configuration resulting from the example request is as follows:
+ *
+ * - All new and existing schemas except the `enabledSchema` and `schemaName` are disabled
+ * - Only system-enabled tables and columns are enabled in the `enabledSchema` schema
+ * - All new and existing tables in the `schemaName` schema except  the `enabledTableName`, `tableName` tables and system tables are disabled
+ * - All new and existing columns in the `tableName` table of the `schemaName` schema are disabled except the `hashedColumnName` column and system columns
+ * - The `hashedColumnName` column in the `tableName`  table the `schemaName` schema is hashed
+ * - All new columns except the system-enabled columns, all schemas and tables are disabled once captured by the connector during the sync
+ *
+ * ### Example for the ALLOW_COLUMNS option
+ *
+ * In `schemas`, you only need to specify schemas and tables you want to enable `enabled = "true"`) and columns you want to disable (`enabled = "false"`) or hash (`hashed = "true"`).
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as fivetran from "@ryan-pip/pulumi-fivetran";
+ *
+ * const schema = new fivetran.ConnectorSchemaConfig("schema", {
+ *     connectorId: "connector_id",
+ *     schemaChangeHandling: "ALLOW_COLUMNS",
+ *     schemas: {
+ *         schema_name: {
+ *             tables: {
+ *                 table_name: {
+ *                     columns: {
+ *                         hashed_column_name: {
+ *                             hashed: true,
+ *                         },
+ *                         disabled_column_name: {
+ *                             enabled: false,
+ *                         },
+ *                     },
+ *                 },
+ *                 enabled_table: {
+ *                     enabled: true,
+ *                 },
+ *             },
+ *         },
+ *         enabled_schema_name: {
+ *             enabled: true,
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * The configuration resulting from the example request is as follows:
+ *
+ * - All specified existing schemas and tables are enabled and all columns inside them are enabled by default, unless `enabled = "false"` is specified for the column
+ * - All new and existing schemas except the `enabledSchemaName` and `schemaName` are disabled
+ * - Only system-enabled tables and columns would be enabled in  the`enabledSchemaName` schema
+ * - All new and existing tables in the `schemaName` schema except the `enabledTableName`, `tableName` and system-enabled tables are disabled
+ * - All new and existing columns in the`tableName` table of the `schemaName` schema except the `disabledColumnsName` and system-enabled columns are enabled
+ * - The `hashedColumnName` would be hashed in table `tableName` in schema `schemaName`
+ * - All new non system-enabled tables/schemas would be disabled once captured by connector on sync
+ * - All new non system-enabled columns inside enabled tables (including system enabled-tables) would be enabled once captured by connector on sync
+ *
+ * <a id="nestedblock--nonlocked"></a>
+ * ### Non-locked table column management in system-enabled tables
+ *
+ * You cannot manage system-enabled tables, but you can manage its non-locked columns. For example, your schema `schemaName` has a system-enabled table `systemEnabledTable` that can't be disabled, and you want to disable one of its columns named `columnName`:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as fivetran from "@ryan-pip/pulumi-fivetran";
+ *
+ * const schema = new fivetran.ConnectorSchemaConfig("schema", {
+ *     connectorId: "connector_id",
+ *     schemaChangeHandling: "ALLOW_COLUMNS",
+ *     schemas: {
+ *         schema_name: {
+ *             tables: {
+ *                 system_enabled_table: {
+ *                     columns: {
+ *                         column_name: {
+ *                             enabled: false,
+ *                         },
+ *                     },
+ *                 },
+ *             },
+ *         },
+ *     },
+ * });
+ * ```
+ *
  * ## Import
  *
  * You don't need to import this resource as it is synthetic (doesn't create new instances in upstream).
@@ -21,8 +231,10 @@ class ConnectorSchemaConfig extends pulumi.CustomResource {
      * @param opts Optional settings to control the behavior of the CustomResource.
      */
     static get(name, id, state, opts) {
-        return new ConnectorSchemaConfig(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+        return new ConnectorSchemaConfig(name, state, { ...opts, id: id });
     }
+    /** @internal */
+    static __pulumiType = 'fivetran:index/connectorSchemaConfig:ConnectorSchemaConfig';
     /**
      * Returns true if the given object is an instance of ConnectorSchemaConfig.  This is designed to work even
      * when multiple copies of the Pulumi SDK have been loaded into the same process.
@@ -38,32 +250,30 @@ class ConnectorSchemaConfig extends pulumi.CustomResource {
         opts = opts || {};
         if (opts.id) {
             const state = argsOrState;
-            resourceInputs["connectorId"] = state ? state.connectorId : undefined;
-            resourceInputs["schema"] = state ? state.schema : undefined;
-            resourceInputs["schemaChangeHandling"] = state ? state.schemaChangeHandling : undefined;
-            resourceInputs["schemas"] = state ? state.schemas : undefined;
-            resourceInputs["schemasJson"] = state ? state.schemasJson : undefined;
-            resourceInputs["timeouts"] = state ? state.timeouts : undefined;
-            resourceInputs["validationLevel"] = state ? state.validationLevel : undefined;
+            resourceInputs["connectorId"] = state?.connectorId;
+            resourceInputs["schema"] = state?.schema;
+            resourceInputs["schemaChangeHandling"] = state?.schemaChangeHandling;
+            resourceInputs["schemas"] = state?.schemas;
+            resourceInputs["schemasJson"] = state?.schemasJson;
+            resourceInputs["timeouts"] = state?.timeouts;
+            resourceInputs["validationLevel"] = state?.validationLevel;
         }
         else {
             const args = argsOrState;
-            if ((!args || args.connectorId === undefined) && !opts.urn) {
+            if (args?.connectorId === undefined && !opts.urn) {
                 throw new Error("Missing required property 'connectorId'");
             }
-            resourceInputs["connectorId"] = args ? args.connectorId : undefined;
-            resourceInputs["schema"] = args ? args.schema : undefined;
-            resourceInputs["schemaChangeHandling"] = args ? args.schemaChangeHandling : undefined;
-            resourceInputs["schemas"] = args ? args.schemas : undefined;
-            resourceInputs["schemasJson"] = args ? args.schemasJson : undefined;
-            resourceInputs["timeouts"] = args ? args.timeouts : undefined;
-            resourceInputs["validationLevel"] = args ? args.validationLevel : undefined;
+            resourceInputs["connectorId"] = args?.connectorId;
+            resourceInputs["schema"] = args?.schema;
+            resourceInputs["schemaChangeHandling"] = args?.schemaChangeHandling;
+            resourceInputs["schemas"] = args?.schemas;
+            resourceInputs["schemasJson"] = args?.schemasJson;
+            resourceInputs["timeouts"] = args?.timeouts;
+            resourceInputs["validationLevel"] = args?.validationLevel;
         }
         opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
         super(ConnectorSchemaConfig.__pulumiType, name, resourceInputs, opts);
     }
 }
 exports.ConnectorSchemaConfig = ConnectorSchemaConfig;
-/** @internal */
-ConnectorSchemaConfig.__pulumiType = 'fivetran:index/connectorSchemaConfig:ConnectorSchemaConfig';
 //# sourceMappingURL=connectorSchemaConfig.js.map

package/connectorSchemaConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"connectorSchemaConfig.js","sourceRoot":"","sources":["../connectorSchemaConfig.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,MAAM,CAAC,cAAc;IAC5D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAkC,EAAE,IAAmC;QAChI,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC5E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,qBAAqB,CAAC,YAAY,CAAC;IACtE,CAAC;IAsCD,YAAY,IAAY,EAAE,WAAoE,EAAE,IAAmC;QAC/H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAqD,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;SACjF;aAAM;YACH,MAAM,IAAI,GAAG,WAAoD,CAAC;YAClE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/E;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,qBAAqB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;;AA3FL,sDA4FC;AA9EG,gBAAgB;AACO,kCAAY,GAAG,4DAA4D,CAAC"}
+{"version":3,"file":"connectorSchemaConfig.js","sourceRoot":"","sources":["../connectorSchemaConfig.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEjF,uDAAyC;AAGzC,uDAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+LG;AACH,MAAa,qBAAsB,SAAQ,MAAM,CAAC,cAAc;IAC5D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAkC,EAAE,IAAmC;QAChI,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,YAAY,GAAG,4DAA4D,CAAC;IAEnG;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,qBAAqB,CAAC,YAAY,CAAC;IACtE,CAAC;IAuCD,YAAY,IAAY,EAAE,WAAoE,EAAE,IAAmC;QAC/H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAqD,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC;YACnD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,EAAE,oBAAoB,CAAC;YACrE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC;YACnD,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;YAC7C,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,EAAE,eAAe,CAAC;SAC9D;aAAM;YACH,MAAM,IAAI,GAAG,WAAoD,CAAC;YAClE,IAAI,IAAI,EAAE,WAAW,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC9C,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,EAAE,WAAW,CAAC;YAClD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,EAAE,oBAAoB,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;YAC1C,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,EAAE,WAAW,CAAC;YAClD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,EAAE,eAAe,CAAC;SAC7D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,qBAAqB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;;AA5FL,sDA6FC"}

package/destination.d.ts

@@ -2,33 +2,73 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "./types/input";
 import * as outputs from "./types/output";
 /**
- * ## Import
+ * This resource allows you to create, update, and delete destinations.
+ *
+ * IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's id value that we automatically generate when you create a group using our REST API, and the destination's groupId value that you specify when you create a destination using our REST API. This means that if you use our REST API to create a destination, you must create a group in your Fivetran account before you can create a destination in it.
+ *
+ * When you create a destination in your Fivetran dashboard, we automatically create a group and assign a value to its id and a destination with the same groupId value, which is unique in your Fivetran account. The group's name corresponds to the Destination name you specify in your Fivetran dashboard when creating the destination in your Fivetran dashboard.
+ *
+ * ## Example Usage
  *
- * 1. To import an existing `fivetran_destination` resource into your Terraform state, you need to get **Destination Group ID** on the destination page in your Fivetran dashboard.
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as fivetran from "@ryan-pip/pulumi-fivetran";
  *
- * To retrieve existing groups, use the [fivetran_groups data source](/providers/fivetran/fivetran/latest/docs/data-sources/groups).
+ * const dest = new fivetran.Destination("dest", {
+ *     groupId: group.id,
+ *     service: "postgres_rds_warehouse",
+ *     timeZoneOffset: "0",
+ *     region: "GCP_US_EAST4",
+ *     trustCertificates: true,
+ *     trustFingerprints: true,
+ *     daylightSavingTimeEnabled: true,
+ *     runSetupTests: true,
+ *     config: {
+ *         host: "destination.fqdn",
+ *         port: 5432,
+ *         user: "postgres",
+ *         password: "myPass",
+ *         database: "fivetran",
+ *         connectionType: "Directly",
+ *     },
+ * });
+ * ```
+ *
+ * ## Setup tests
  *
- * 2. Define an empty resource in your `.tf` configuration:
+ * The `runSetupTests` field doesn't have upstream value, it only defines local resource behavoir. This means that when you update only the `runSetupTests` value (from `false` to `true`, for example) it won't cause any upstream actions. The value will be just saved in terraform state and then used on effective field updates.
  *
- * hcl
+ * The default value is `false` - this means that no setup tests will be performed during create/update. To perform setup tests, you should set value to `true`.
+ *
+ * ## Import
  *
- * resource "fivetran_destination" "my_imported_destination" {
+ * 1. To import an existing `fivetran.Destination` resource into your Terraform state, you need to get **Destination Group ID** on the destination page in your Fivetran dashboard.
  *
- * }
+ * 2. To retrieve existing destinations, use the [fivetran.getDestinations data source](https://www.terraform.io/docs/data-sources/destinations).
  *
- * 3. Run the `pulumi import` command with the following parameters:
+ * 3. Define an empty resource in your `.tf` configuration:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as fivetran from "@ryan-pip/pulumi-fivetran";
+ *
+ * const myImportedDestination = new fivetran.Destination("my_imported_destination", {});
+ * ```
+ *
+ * 4. Run the `pulumi import` command with the following parameters:
  *
  * ```sh
- * $ pulumi import fivetran:index/destination:Destination my_imported_destination {your Destination Group ID}
+ * terraform import fivetran_destination.my_imported_destination {your Destination Group ID}
  * ```
  *
- * 4. Use the `terraform state show` command to get the values from the state:
+ * 5. Use the `terraform state show` command to get the values from the state:
  *
+ * ```sh
  * terraform state show 'fivetran_destination.my_imported_destination'
+ * ```
+ * 6. Copy the values and paste them to your `.tf` configuration.
  *
- * 5. Copy the values and paste them to your `.tf` configuration.
- *
- * -> The `config` object in the state contains all properties defined in the schema. You need to remove properties from the `config` that are not related to destinations. See the [Fivetran REST API documentation](https://fivetran.com/docs/rest-api/destinations/config) for reference to find the properties you need to keep in the `config` section.
+ * > The `config` object in the state contains all properties defined in the schema. You need to remove properties from the `config` that are not related to destinations. See the [Fivetran REST API documentation](https://fivetran.com/docs/rest-api/destinations/config) for reference to find the properties you need to keep in the `config` section.
  */
 export declare class Destination extends pulumi.CustomResource {
     /**
@@ -56,8 +96,7 @@ export declare class Destination extends pulumi.CustomResource {
      */
     readonly groupId: pulumi.Output<string>;
     /**
-     * The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the
-     * value is specified, the system will try to associate the connection with an existing agent.
+     * The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
      */
     readonly hybridDeploymentAgentId: pulumi.Output<string | undefined>;
     /**
@@ -90,15 +129,11 @@ export declare class Destination extends pulumi.CustomResource {
     readonly timeZoneOffset: pulumi.Output<string>;
     readonly timeouts: pulumi.Output<outputs.DestinationTimeouts | undefined>;
     /**
-     * Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not
-     * trusted automatically, it has to be approved with [Certificates Management API Approve a destination
-     * certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
+     * Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
      */
     readonly trustCertificates: pulumi.Output<boolean>;
     /**
-     * Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not
-     * trusted automatically, it has to be approved with [Certificates Management API Approve a destination
-     * fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).
+     * Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).
      */
     readonly trustFingerprints: pulumi.Output<boolean>;
     /**
@@ -124,8 +159,7 @@ export interface DestinationState {
      */
     groupId?: pulumi.Input<string>;
     /**
-     * The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the
-     * value is specified, the system will try to associate the connection with an existing agent.
+     * The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
      */
     hybridDeploymentAgentId?: pulumi.Input<string>;
     /**
@@ -158,15 +192,11 @@ export interface DestinationState {
     timeZoneOffset?: pulumi.Input<string>;
     timeouts?: pulumi.Input<inputs.DestinationTimeouts>;
     /**
-     * Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not
-     * trusted automatically, it has to be approved with [Certificates Management API Approve a destination
-     * certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
+     * Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
      */
     trustCertificates?: pulumi.Input<boolean>;
     /**
-     * Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not
-     * trusted automatically, it has to be approved with [Certificates Management API Approve a destination
-     * fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).
+     * Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).
      */
     trustFingerprints?: pulumi.Input<boolean>;
 }
@@ -184,8 +214,7 @@ export interface DestinationArgs {
      */
     groupId: pulumi.Input<string>;
     /**
-     * The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the
-     * value is specified, the system will try to associate the connection with an existing agent.
+     * The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
      */
     hybridDeploymentAgentId?: pulumi.Input<string>;
     /**
@@ -214,15 +243,12 @@ export interface DestinationArgs {
     timeZoneOffset: pulumi.Input<string>;
     timeouts?: pulumi.Input<inputs.DestinationTimeouts>;
     /**
-     * Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not
-     * trusted automatically, it has to be approved with [Certificates Management API Approve a destination
-     * certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
+     * Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).
      */
     trustCertificates?: pulumi.Input<boolean>;
     /**
-     * Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not
-     * trusted automatically, it has to be approved with [Certificates Management API Approve a destination
-     * fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).
+     * Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).
      */
     trustFingerprints?: pulumi.Input<boolean>;
 }
+//# sourceMappingURL=destination.d.ts.map

package/destination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"destination.d.ts","sourceRoot":"","sources":["../destination.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,WAAY,SAAQ,MAAM,CAAC,cAAc;IAClD;;;;;;;;OAQG;WACW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,WAAW;IAOxI;;;OAGG;WACW,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,WAAW;IAOtD,SAAwB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IACrF;;OAEG;IACH,SAAwB,yBAAyB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC1E;;OAEG;IACH,SAAwB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvD;;OAEG;IACH,SAAwB,uBAAuB,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACnF;;OAEG;IACH,SAAwB,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChE;;OAEG;IACH,SAAwB,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACzE;;OAEG;IACH,SAAwB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD;;OAEG;IACH,SAAwB,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D;;OAEG;IACH,SAAwB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvD;;OAEG;IACH,SAAgC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnE;;OAEG;IACH,SAAwB,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9D,SAAwB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;IACzF;;OAEG;IACH,SAAwB,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClE;;OAEG;IACH,SAAwB,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAElE;;;;;;OAMG;gBACS,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,qBAAqB;CAoDvF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChD;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACpD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChD;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACpD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;CAC7C"}