Breadcrumbs

Fivetran - Update Connector

Overview

Update the settings of a connector in Fivetran. The connector must already exist in the Fivetran interface. By default, every option is set to `No Change`. This ensures that existing settings will not be overwritten by running this Blueprint. However, this Blueprint requires that at least one setting be changed, otherwise it will result in an error. The settings that can be updated with this Blueprint: - Switch the connector's schedule between manual and auto. - Pause and Unpause the connector - Trigger a historical sync for the connector The response for this request will always be stored at `shipyard-artifacts/fivetran-blueprints/responses/update_{connector_id}_response.json` The full list of settings that can be changed can be found [here](https://fivetran.com/docs/rest-api/connectors#modifyaconnector).

Variables

Name

Reference

Type

Required

Default

Options

Description

API Key

FIVETRAN_API_KEY

Password

✅

None

-

Your account's unique API Key for Fivetran.

API Secret

FIVETRAN_API_SECRET

Password

✅

None

-

Your account's unique API Secret for Fivetran.

Connector ID

FIVETRAN_CONNECTOR_ID

Alphanumeric

✅

None

-

The unique ID associated with a connector. Typically two words separated by an underscore.

Set Schedule Type

FIVETRAN_SCHEDULE_TYPE

Select

✅

None

No Change: None

Manual: manual

Auto: auto

Set your connector's schedule to sync automatically, manually, or make no change.

Set Connector State

FIVETRAN_PAUSED

Select

✅

None

No Change: None

Paused: TRUE

Enabled: FALSE

Set your connector to paused, enabled, or make no change.

Trigger Historical Sync?

FIVETRAN_HISTORICAL_SYNC

Select

✅

None

No Change: None

Yes: TRUE

Set your connector to start a historical sync, or make no change.

Custom Update

FIVETRAN_CUSTOM_UPDATE

Alphanumeric

➖

None

-

Additional connector parameters you would like to update, provided in a JSON format. These can be found at https://fivetran.com/docs/rest-api/connectors#modifyaconnector

YAML

Below is the YAML template

YAML

source:
  template: Fivetran - Update Connector
  inputs:
    FIVETRAN_API_KEY:
    FIVETRAN_API_SECRET:
    FIVETRAN_CONNECTOR_ID:
    FIVETRAN_SCHEDULE_TYPE: None
    FIVETRAN_PAUSED: None
    FIVETRAN_HISTORICAL_SYNC: None
    FIVETRAN_CUSTOM_UPDATE:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 202
    - 204
    - 211
    - 210