Terraform Configuration - Connections (Alpha)
This resource is currently in alpha and is subject to change at any time.
Select a connector service to see a complete Terraform configuration of the corresponding connection in HCL (HashiCorp configuration language). The required connection-level fields (service, group_id, and destination_schema_names) are uncommented. Connector-specific config and auth fields come from Connector Metadata; required connector fields are uncommented and optional connector fields are commented out. Every optional connection-level field is also included as a commented example so that you can enable only the settings that apply to your connection. Sensitive fields use <UPPERCASE> placeholders.
See our Terraform fivetran_connection_v2 resource documentation to learn what each field means and how to use it.
resource "fivetran_connection_v2" "my_15five_connection" { service = "15five" group_id = "" destination_schema_names = "FIVETRAN_NAMING" config = { schema = "schema_name" api_key = " " } # Optional connection-level fields: # sync_frequency = 60 # Sync frequency in minutes. Allowed: 1 | 5 | 15 | 30 | 60 | 120 | 180 | 360 | 480 | 720 | 1440 # schedule_type = "auto" # Allowed: auto | manual. # pause_after_trial = true # Whether to pause after the free trial ends. # daily_sync_time = "14:00" # Requires sync_frequency = 1440. Specify in one-hour increments from "00:00" to "23:00". # connect_card_config = { # Only for the interactive Connect Card setup flow. # redirect_uri = " " # hide_setup_guide = true # all_fields = true # } # destination_configuration = { # Only for destinations that support connection-level configuration. # virtual_warehouse = " " # } # networking_method = "Directly" # Allowed: Directly | SshTunnel | ProxyAgent | PrivateLink. # proxy_agent_id = " " # Requires networking_method = "ProxyAgent". # hybrid_deployment_agent_id = " " # Only for a group that uses a hybrid deployment agent. # private_link_id = " " # Requires networking_method = "PrivateLink". # data_delay_sensitivity = "NORMAL" # Allowed: LOW | NORMAL | HIGH | CUSTOM | SYNC_FREQUENCY. # data_delay_threshold = 60 # Minutes; requires data_delay_sensitivity = "CUSTOM". # run_setup_tests = true # Run setup tests when creating or updating the connection. # trust_certificates = true # Only when certificates should be trusted automatically. # trust_fingerprints = true # Only when SSH fingerprints should be trusted automatically. }
Notes
- The generated HCL targets the
fivetran_connection_v2resource, which uses dynamicconfigandauthobject literals. - Comments beside optional connection-level fields list documented allowed values and applicability conditions. Review dependencies before uncommenting a field.
- The selector uses a connector service value. To map a connector name to a service value, call
GET /v1/metadata/connector-types(requires API authentication) orGET /public/connector-types(no API authentication needed), then use the returnedidinservice. - Fields marked
# immutablecannot be changed after the connection is created. - Fields marked
# sensitiveare write-only - the API does not return their values. Store them in External Secrets Manager or a secrets backend.