fivetran 1.6.1, Mar 31 25

fivetran 1.6.1 published on Monday, Mar 31, 2025 by fivetran

fivetran.getDestination

Explore with Pulumi AI

fivetran 1.6.1 published on Monday, Mar 31, 2025 by fivetran

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as fivetran from "@pulumi/fivetran";

const dest = fivetran.getDestination({
    id: "anonymous_mystery",
});

import pulumi
import pulumi_fivetran as fivetran

dest = fivetran.get_destination(id="anonymous_mystery")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.LookupDestination(ctx, &fivetran.LookupDestinationArgs{
			Id: "anonymous_mystery",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fivetran = Pulumi.Fivetran;

return await Deployment.RunAsync(() => 
{
    var dest = Fivetran.GetDestination.Invoke(new()
    {
        Id = "anonymous_mystery",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.FivetranFunctions;
import com.pulumi.fivetran.inputs.GetDestinationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var dest = FivetranFunctions.getDestination(GetDestinationArgs.builder()
            .id("anonymous_mystery")
            .build());

    }
}

variables:
  dest:
    fn::invoke:
      function: fivetran:getDestination
      arguments:
        id: anonymous_mystery

Using getDestination

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getDestination(args: GetDestinationArgs, opts?: InvokeOptions): Promise<GetDestinationResult>
function getDestinationOutput(args: GetDestinationOutputArgs, opts?: InvokeOptions): Output<GetDestinationResult>

def get_destination(config: Optional[GetDestinationConfig] = None,
                    id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDestinationResult
def get_destination_output(config: Optional[pulumi.Input[GetDestinationConfigArgs]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDestinationResult]

func LookupDestination(ctx *Context, args *LookupDestinationArgs, opts ...InvokeOption) (*LookupDestinationResult, error)
func LookupDestinationOutput(ctx *Context, args *LookupDestinationOutputArgs, opts ...InvokeOption) LookupDestinationResultOutput

> Note: This function is named LookupDestination in the Go SDK.

public static class GetDestination 
{
    public static Task<GetDestinationResult> InvokeAsync(GetDestinationArgs args, InvokeOptions? opts = null)
    public static Output<GetDestinationResult> Invoke(GetDestinationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDestinationResult> getDestination(GetDestinationArgs args, InvokeOptions options)
public static Output<GetDestinationResult> getDestination(GetDestinationArgs args, InvokeOptions options)

fn::invoke:
  function: fivetran:index/getDestination:getDestination
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Config GetDestinationConfig

Id string
Config GetDestinationConfig

id String
config GetDestinationConfig

id string
config GetDestinationConfig

id str
config GetDestinationConfig

id String
config Property Map

getDestination Result

The following output properties are available:

DaylightSavingTimeEnabled bool
GroupId string
HybridDeploymentAgentId string
Id string
NetworkingMethod string
PrivateLinkId string
Region string
Service string
SetupStatus string
TimeZoneOffset string
Config GetDestinationConfig

DaylightSavingTimeEnabled bool
GroupId string
HybridDeploymentAgentId string
Id string
NetworkingMethod string
PrivateLinkId string
Region string
Service string
SetupStatus string
TimeZoneOffset string
Config GetDestinationConfig

daylightSavingTimeEnabled Boolean
groupId String
hybridDeploymentAgentId String
id String
networkingMethod String
privateLinkId String
region String
service String
setupStatus String
timeZoneOffset String
config GetDestinationConfig

daylightSavingTimeEnabled boolean
groupId string
hybridDeploymentAgentId string
id string
networkingMethod string
privateLinkId string
region string
service string
setupStatus string
timeZoneOffset string
config GetDestinationConfig

daylight_saving_time_enabled bool
group_id str
hybrid_deployment_agent_id str
id str
networking_method str
private_link_id str
region str
service str
setup_status str
time_zone_offset str
config GetDestinationConfig

daylightSavingTimeEnabled Boolean
groupId String
hybridDeploymentAgentId String
id String
networkingMethod String
privateLinkId String
region String
service String
setupStatus String
timeZoneOffset String
config Property Map

Supporting Types

GetDestinationConfig

AlwaysEncrypted bool: Field usage depends on service value: - Service aurora_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service panoply: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service redshift: Require TLS through Tunnel - Service sql_server_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel.
Auth string: Field usage depends on service value: - Service snowflake: Password-based or key-based authentication type
AuthType string: Field usage depends on service value: - Service adls: Authentication type - Service databricks: Authentication type - Service new_s3_datalake: Authentication type - Service onelake: Authentication type - Service redshift: Authentication type. Default value: PASSWORD.
AwsAccessKeyId string: Field usage depends on service value: - Service new_s3_datalake: AWS access key to access the S3 bucket and AWS Glue
AwsSecretAccessKey string: Field usage depends on service value: - Service new_s3_datalake: AWS secret access key to access the S3 bucket and AWS Glue
BootstrapServers List<string>: Field usage depends on service value: - Service confluent_cloud_wh: Comma-separated list of Confluent Cloud servers in the server:port format.
Bucket string: Field usage depends on service value: - Service big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service big_query_dts: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service managed_big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service new_s3_datalake: (Immutable) The name of the bucket to be used as destination
Catalog string: Field usage depends on service value: - Service adls: Catalog name - Service databricks: Catalog name - Service new_s3_datalake: Catalog name - Service onelake: Catalog name
ClientId string: Field usage depends on service value: - Service adls: Client id of service principal - Service onelake: Client ID of service principal
CloudProvider string: Field usage depends on service value: - Service databricks: Databricks deployment cloud
ClusterId string: Field usage depends on service value: - Service panoply: Cluster ID. - Service periscope_warehouse: Cluster ID. - Service redshift: Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
ClusterRegion string: Field usage depends on service value: - Service panoply: Cluster region. - Service periscope_warehouse: Cluster region. - Service redshift: Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
ConnectionMethod string
ConnectionType string: Field usage depends on service value: - Service adls: Connection method. Default value: Directly. - Service aurora_postgres_warehouse: Connection method. Default value: Directly. - Service aurora_warehouse: Connection method. Default value: Directly. - Service azure_postgres_warehouse: Connection method. Default value: Directly. - Service azure_sql_data_warehouse: Connection method. Default value: Directly. - Service azure_sql_database: Connection method. Default value: Directly. - Service azure_sql_managed_db_warehouse: Connection method. Default value: Directly. - Service databricks: Connection method. Default value: Directly. - Service maria_rds_warehouse: Connection method. Default value: Directly. - Service maria_warehouse: Connection method. Default value: Directly. - Service mysql_rds_warehouse: Connection method. Default value: Directly. - Service mysql_warehouse: Connection method. Default value: Directly. - Service panoply: Connection method. Default value: Directly. - Service periscope_warehouse: Connection method. Default value: Directly. - Service postgres_gcp_warehouse: Connection method. Default value: Directly. - Service postgres_rds_warehouse: Connection method. Default value: Directly. - Service postgres_warehouse: Connection method. Default value: Directly. - Service redshift: Connection method. Default value: Directly. - Service snowflake: Connection method. Default value: Directly. - Service sql_server_rds_warehouse: Connection method. Default value: Directly. - Service sql_server_warehouse: Connection method. Default value: Directly.
ContainerName string: Field usage depends on service value: - Service adls: (Immutable) Container to store delta table files - Service onelake: Workspace name to store delta table files
ControllerId string
CreateExternalTables bool: Field usage depends on service value: - Service databricks: Whether to create external tables
DataFormat string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud message format.
DataSetLocation string: Field usage depends on service value: - Service big_query: Data location. Datasets will reside in this location. - Service big_query_dts: Data location. Datasets will reside in this location. - Service managed_big_query: Data location. Datasets will reside in this location.
Database string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database name - Service aurora_warehouse: Database name - Service azure_postgres_warehouse: Database name - Service azure_sql_data_warehouse: Database name - Service azure_sql_database: Database name - Service azure_sql_managed_db_warehouse: Database name - Service maria_rds_warehouse: Database name - Service maria_warehouse: Database name - Service mysql_rds_warehouse: Database name - Service mysql_warehouse: Database name - Service panoply: Database name - Service periscope_warehouse: Database name - Service postgres_gcp_warehouse: Database name - Service postgres_rds_warehouse: Database name - Service postgres_warehouse: Database name - Service redshift: Database name - Service snowflake: Database name - Service sql_server_rds_warehouse: Database name - Service sql_server_warehouse: Database name
DatabricksConnectionType string: Field usage depends on service value: - Service adls: Databricks Connection method. Default value: Directly. - Service new_s3_datalake: Databricks Connection method. Default value: Directly. - Service onelake: Databricks Connection method. Default value: Directly.
EnableRemoteExecution bool
ExternalId string: Field usage depends on service value: - Service aws_msk_wh: Fivetran generated External ID - Service panoply: Fivetran generated External ID - Service periscope_warehouse: Fivetran generated External ID - Service redshift: Fivetran generated External ID
ExternalLocation string: Field usage depends on service value: - Service databricks: External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path.
FivetranGlueRoleArn string
FivetranMskRoleArn string
FivetranRoleArn string: Field usage depends on service value: - Service new_s3_datalake: ARN of the role which you created with different required policy mentioned in our setup guide
Host string: Field usage depends on service value: - Service aurora_postgres_warehouse: Server name - Service aurora_warehouse: Server name - Service azure_postgres_warehouse: Server name - Service azure_sql_data_warehouse: Server name - Service azure_sql_database: Server name - Service azure_sql_managed_db_warehouse: Server name - Service maria_rds_warehouse: Server name - Service maria_warehouse: Server name - Service mysql_rds_warehouse: Server name - Service mysql_warehouse: Server name - Service panoply: Server name - Service periscope_warehouse: Server name - Service postgres_gcp_warehouse: Server name - Service postgres_rds_warehouse: Server name - Service postgres_warehouse: Server name - Service redshift: Server name - Service snowflake: Server name - Service sql_server_rds_warehouse: Server name - Service sql_server_warehouse: Server name
HttpPath string: Field usage depends on service value: - Service adls: HTTP path - Service databricks: HTTP path - Service new_s3_datalake: HTTP path - Service onelake: HTTP path
IsPrivateKeyEncrypted bool: Field usage depends on service value: - Service snowflake: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
IsPrivateLinkRequired bool: Field usage depends on service value: - Service new_s3_datalake: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
IsRedshiftServerless bool: Field usage depends on service value: - Service redshift: Is your destination Redshift Serverless
LakehouseGuid string: Field usage depends on service value: - Service onelake: (Immutable) OneLake lakehouse GUID
LakehouseName string: Field usage depends on service value: - Service onelake: (Immutable) Name of your lakehouse
MskStsRegion string
NumOfPartitions double: Field usage depends on service value: - Service confluent_cloud_wh: Number of partitions per topic.
Oauth2ClientId string: Field usage depends on service value: - Service adls: OAuth 2.0 client ID - Service databricks: OAuth 2.0 client ID - Service new_s3_datalake: OAuth 2.0 client ID - Service onelake: OAuth 2.0 client ID
Oauth2Secret string: Field usage depends on service value: - Service adls: OAuth 2.0 secret - Service databricks: OAuth 2.0 secret - Service new_s3_datalake: OAuth 2.0 secret - Service onelake: OAuth 2.0 secret
Passphrase string: Field usage depends on service value: - Service snowflake: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
Password string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user password - Service aurora_warehouse: Database user password - Service azure_postgres_warehouse: Database user password - Service azure_sql_data_warehouse: Database user password - Service azure_sql_database: Database user password - Service azure_sql_managed_db_warehouse: Database user password - Service maria_rds_warehouse: Database user password - Service maria_warehouse: Database user password - Service mysql_rds_warehouse: Database user password - Service mysql_warehouse: Database user password - Service panoply: Database user password - Service periscope_warehouse: Database user password - Service postgres_gcp_warehouse: Database user password - Service postgres_rds_warehouse: Database user password - Service postgres_warehouse: Database user password - Service redshift: Database user password. Required if authentication type is PASSWORD. - Service snowflake: Database user password. The field should be specified if authentication type is PASSWORD. - Service sql_server_rds_warehouse: Database user password - Service sql_server_warehouse: Database user password
PersonalAccessToken string: Field usage depends on service value: - Service adls: Personal access token - Service databricks: Personal access token - Service new_s3_datalake: Personal access token - Service onelake: Personal access token
Port double: Field usage depends on service value: - Service adls: Server port number - Service aurora_postgres_warehouse: Server port number - Service aurora_warehouse: Server port number - Service azure_postgres_warehouse: Server port number - Service azure_sql_data_warehouse: Server port number - Service azure_sql_database: Server port number - Service azure_sql_managed_db_warehouse: Server port number - Service databricks: Server port number - Service maria_rds_warehouse: Server port number - Service maria_warehouse: Server port number - Service mysql_rds_warehouse: Server port number - Service mysql_warehouse: Server port number - Service new_s3_datalake: Server port number - Service onelake: Server port number - Service panoply: Server port number - Service periscope_warehouse: Server port number - Service postgres_gcp_warehouse: Server port number - Service postgres_rds_warehouse: Server port number - Service postgres_warehouse: Server port number - Service redshift: Server port number - Service snowflake: Server port number - Service sql_server_rds_warehouse: Server port number - Service sql_server_warehouse: Server port number
PrefixPath string: Field usage depends on service value: - Service adls: (Immutable) path/to/data within the container - Service new_s3_datalake: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy - Service onelake: (Immutable) path/to/data within your lakehouse inside the Files directory
PrivateKey string: Field usage depends on service value: - Service snowflake: Private access key. The field should be specified if authentication type is KEY_PAIR.
ProjectId string: Field usage depends on service value: - Service big_query: BigQuery project ID
PublicKey string: Field usage depends on service value: - Service aurora_postgres_warehouse: Public Key - Service aurora_warehouse: Public Key - Service azure_postgres_warehouse: Public Key - Service azure_sql_data_warehouse: Public Key - Service azure_sql_database: Public Key - Service azure_sql_managed_db_warehouse: Public Key - Service maria_rds_warehouse: Public Key - Service maria_warehouse: Public Key - Service mysql_rds_warehouse: Public Key - Service mysql_warehouse: Public Key - Service panoply: Public Key - Service periscope_warehouse: Public Key - Service postgres_gcp_warehouse: Public Key - Service postgres_rds_warehouse: Public Key - Service postgres_warehouse: Public Key - Service redshift: Public Key - Service sql_server_rds_warehouse: Public Key - Service sql_server_warehouse: Public Key
Region string: Field usage depends on service value: - Service new_s3_datalake: Region of your AWS S3 bucket
RegistryName string
RegistryStsRegion string
ReplicationFactor double: Field usage depends on service value: - Service confluent_cloud_wh: Replication factor.
ResourceId string: Field usage depends on service value: - Service aurora_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service aurora_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_data_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_database: Field to test Self serve Private Link - Service azure_sql_managed_db_warehouse: Field to test Self serve Private Link - Service databricks: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service panoply: This field is currently being introduced to test the Self-serve Private Link functionality - Service periscope_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_gcp_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service redshift: This field is currently being introduced to test the Self-serve Private Link functionality - Service snowflake: This field is currently being introduced to test the Self-serve Private Link functionality - Service sql_server_rds_warehouse: Field to test Self serve Private Link - Service sql_server_warehouse: Field to test Self serve Private Link
Role string: Field usage depends on service value: - Service snowflake: If not specified, Fivetran will use the user's default role
RoleArn string: Field usage depends on service value: - Service redshift: Role ARN with Redshift permissions. Required if authentication type is IAM.
SaslMechanism string: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
SaslPlainKey string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL key.
SaslPlainSecret string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL secret.
SchemaCompatibility string
SchemaRegistry string: Field usage depends on service value: - Service confluent_cloud_wh: Schema Registry
SchemaRegistryApiKey string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API key.
SchemaRegistryApiSecret string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API secret.
SchemaRegistryUrl string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry URL.
SecretKey string: Field usage depends on service value: - Service big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service big_query_dts: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service managed_big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
SecretValue string: Field usage depends on service value: - Service adls: Secret value for service principal - Service onelake: Secret value for service principal
SecurityProtocol string: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
ServerHostName string: Field usage depends on service value: - Service adls: Server Host name - Service databricks: Server name - Service new_s3_datalake: Server host name - Service onelake: Server Host name
ShouldMaintainTablesInDatabricks bool: Field usage depends on service value: - Service adls: Should maintain tables in Databricks - Service new_s3_datalake: Should maintain tables in Databricks - Service onelake: Should maintain tables in Databricks
SnapshotRetentionPeriod string: Field usage depends on service value: - Service adls: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service new_s3_datalake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service onelake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
SnowflakeCloud string
SnowflakeRegion string
StorageAccountName string: Field usage depends on service value: - Service adls: (Immutable) Storage account for Azure Data Lake Storage Gen2 name - Service onelake: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
TableFormat string: Field usage depends on service value: - Service new_s3_datalake: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
TenantId string: Field usage depends on service value: - Service adls: Tenant id of service principal - Service onelake: Tenant ID of service principal
TunnelHost string: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel.
TunnelPort double: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel.
TunnelUser string: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel.
User string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user name - Service aurora_warehouse: Database user name - Service azure_postgres_warehouse: Database user name - Service azure_sql_data_warehouse: Database user name - Service azure_sql_database: Database user name - Service azure_sql_managed_db_warehouse: Database user name - Service maria_rds_warehouse: Database user name - Service maria_warehouse: Database user name - Service mysql_rds_warehouse: Database user name - Service mysql_warehouse: Database user name - Service panoply: Database user name - Service periscope_warehouse: Database user name - Service postgres_gcp_warehouse: Database user name - Service postgres_rds_warehouse: Database user name - Service postgres_warehouse: Database user name - Service redshift: Database user name - Service snowflake: Database user name - Service sql_server_rds_warehouse: Database user name - Service sql_server_warehouse: Database user name
WorkspaceGuid string: Field usage depends on service value: - Service onelake: (Immutable) OneLake workspace GUID
WorkspaceName string: Field usage depends on service value: - Service onelake: OneLake workspace name

AlwaysEncrypted bool: Field usage depends on service value: - Service aurora_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service panoply: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service redshift: Require TLS through Tunnel - Service sql_server_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel.
Auth string: Field usage depends on service value: - Service snowflake: Password-based or key-based authentication type
AuthType string: Field usage depends on service value: - Service adls: Authentication type - Service databricks: Authentication type - Service new_s3_datalake: Authentication type - Service onelake: Authentication type - Service redshift: Authentication type. Default value: PASSWORD.
AwsAccessKeyId string: Field usage depends on service value: - Service new_s3_datalake: AWS access key to access the S3 bucket and AWS Glue
AwsSecretAccessKey string: Field usage depends on service value: - Service new_s3_datalake: AWS secret access key to access the S3 bucket and AWS Glue
BootstrapServers []string: Field usage depends on service value: - Service confluent_cloud_wh: Comma-separated list of Confluent Cloud servers in the server:port format.
Bucket string: Field usage depends on service value: - Service big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service big_query_dts: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service managed_big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service new_s3_datalake: (Immutable) The name of the bucket to be used as destination
Catalog string: Field usage depends on service value: - Service adls: Catalog name - Service databricks: Catalog name - Service new_s3_datalake: Catalog name - Service onelake: Catalog name
ClientId string: Field usage depends on service value: - Service adls: Client id of service principal - Service onelake: Client ID of service principal
CloudProvider string: Field usage depends on service value: - Service databricks: Databricks deployment cloud
ClusterId string: Field usage depends on service value: - Service panoply: Cluster ID. - Service periscope_warehouse: Cluster ID. - Service redshift: Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
ClusterRegion string: Field usage depends on service value: - Service panoply: Cluster region. - Service periscope_warehouse: Cluster region. - Service redshift: Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
ConnectionMethod string
ConnectionType string: Field usage depends on service value: - Service adls: Connection method. Default value: Directly. - Service aurora_postgres_warehouse: Connection method. Default value: Directly. - Service aurora_warehouse: Connection method. Default value: Directly. - Service azure_postgres_warehouse: Connection method. Default value: Directly. - Service azure_sql_data_warehouse: Connection method. Default value: Directly. - Service azure_sql_database: Connection method. Default value: Directly. - Service azure_sql_managed_db_warehouse: Connection method. Default value: Directly. - Service databricks: Connection method. Default value: Directly. - Service maria_rds_warehouse: Connection method. Default value: Directly. - Service maria_warehouse: Connection method. Default value: Directly. - Service mysql_rds_warehouse: Connection method. Default value: Directly. - Service mysql_warehouse: Connection method. Default value: Directly. - Service panoply: Connection method. Default value: Directly. - Service periscope_warehouse: Connection method. Default value: Directly. - Service postgres_gcp_warehouse: Connection method. Default value: Directly. - Service postgres_rds_warehouse: Connection method. Default value: Directly. - Service postgres_warehouse: Connection method. Default value: Directly. - Service redshift: Connection method. Default value: Directly. - Service snowflake: Connection method. Default value: Directly. - Service sql_server_rds_warehouse: Connection method. Default value: Directly. - Service sql_server_warehouse: Connection method. Default value: Directly.
ContainerName string: Field usage depends on service value: - Service adls: (Immutable) Container to store delta table files - Service onelake: Workspace name to store delta table files
ControllerId string
CreateExternalTables bool: Field usage depends on service value: - Service databricks: Whether to create external tables
DataFormat string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud message format.
DataSetLocation string: Field usage depends on service value: - Service big_query: Data location. Datasets will reside in this location. - Service big_query_dts: Data location. Datasets will reside in this location. - Service managed_big_query: Data location. Datasets will reside in this location.
Database string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database name - Service aurora_warehouse: Database name - Service azure_postgres_warehouse: Database name - Service azure_sql_data_warehouse: Database name - Service azure_sql_database: Database name - Service azure_sql_managed_db_warehouse: Database name - Service maria_rds_warehouse: Database name - Service maria_warehouse: Database name - Service mysql_rds_warehouse: Database name - Service mysql_warehouse: Database name - Service panoply: Database name - Service periscope_warehouse: Database name - Service postgres_gcp_warehouse: Database name - Service postgres_rds_warehouse: Database name - Service postgres_warehouse: Database name - Service redshift: Database name - Service snowflake: Database name - Service sql_server_rds_warehouse: Database name - Service sql_server_warehouse: Database name
DatabricksConnectionType string: Field usage depends on service value: - Service adls: Databricks Connection method. Default value: Directly. - Service new_s3_datalake: Databricks Connection method. Default value: Directly. - Service onelake: Databricks Connection method. Default value: Directly.
EnableRemoteExecution bool
ExternalId string: Field usage depends on service value: - Service aws_msk_wh: Fivetran generated External ID - Service panoply: Fivetran generated External ID - Service periscope_warehouse: Fivetran generated External ID - Service redshift: Fivetran generated External ID
ExternalLocation string: Field usage depends on service value: - Service databricks: External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path.
FivetranGlueRoleArn string
FivetranMskRoleArn string
FivetranRoleArn string: Field usage depends on service value: - Service new_s3_datalake: ARN of the role which you created with different required policy mentioned in our setup guide
Host string: Field usage depends on service value: - Service aurora_postgres_warehouse: Server name - Service aurora_warehouse: Server name - Service azure_postgres_warehouse: Server name - Service azure_sql_data_warehouse: Server name - Service azure_sql_database: Server name - Service azure_sql_managed_db_warehouse: Server name - Service maria_rds_warehouse: Server name - Service maria_warehouse: Server name - Service mysql_rds_warehouse: Server name - Service mysql_warehouse: Server name - Service panoply: Server name - Service periscope_warehouse: Server name - Service postgres_gcp_warehouse: Server name - Service postgres_rds_warehouse: Server name - Service postgres_warehouse: Server name - Service redshift: Server name - Service snowflake: Server name - Service sql_server_rds_warehouse: Server name - Service sql_server_warehouse: Server name
HttpPath string: Field usage depends on service value: - Service adls: HTTP path - Service databricks: HTTP path - Service new_s3_datalake: HTTP path - Service onelake: HTTP path
IsPrivateKeyEncrypted bool: Field usage depends on service value: - Service snowflake: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
IsPrivateLinkRequired bool: Field usage depends on service value: - Service new_s3_datalake: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
IsRedshiftServerless bool: Field usage depends on service value: - Service redshift: Is your destination Redshift Serverless
LakehouseGuid string: Field usage depends on service value: - Service onelake: (Immutable) OneLake lakehouse GUID
LakehouseName string: Field usage depends on service value: - Service onelake: (Immutable) Name of your lakehouse
MskStsRegion string
NumOfPartitions float64: Field usage depends on service value: - Service confluent_cloud_wh: Number of partitions per topic.
Oauth2ClientId string: Field usage depends on service value: - Service adls: OAuth 2.0 client ID - Service databricks: OAuth 2.0 client ID - Service new_s3_datalake: OAuth 2.0 client ID - Service onelake: OAuth 2.0 client ID
Oauth2Secret string: Field usage depends on service value: - Service adls: OAuth 2.0 secret - Service databricks: OAuth 2.0 secret - Service new_s3_datalake: OAuth 2.0 secret - Service onelake: OAuth 2.0 secret
Passphrase string: Field usage depends on service value: - Service snowflake: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
Password string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user password - Service aurora_warehouse: Database user password - Service azure_postgres_warehouse: Database user password - Service azure_sql_data_warehouse: Database user password - Service azure_sql_database: Database user password - Service azure_sql_managed_db_warehouse: Database user password - Service maria_rds_warehouse: Database user password - Service maria_warehouse: Database user password - Service mysql_rds_warehouse: Database user password - Service mysql_warehouse: Database user password - Service panoply: Database user password - Service periscope_warehouse: Database user password - Service postgres_gcp_warehouse: Database user password - Service postgres_rds_warehouse: Database user password - Service postgres_warehouse: Database user password - Service redshift: Database user password. Required if authentication type is PASSWORD. - Service snowflake: Database user password. The field should be specified if authentication type is PASSWORD. - Service sql_server_rds_warehouse: Database user password - Service sql_server_warehouse: Database user password
PersonalAccessToken string: Field usage depends on service value: - Service adls: Personal access token - Service databricks: Personal access token - Service new_s3_datalake: Personal access token - Service onelake: Personal access token
Port float64: Field usage depends on service value: - Service adls: Server port number - Service aurora_postgres_warehouse: Server port number - Service aurora_warehouse: Server port number - Service azure_postgres_warehouse: Server port number - Service azure_sql_data_warehouse: Server port number - Service azure_sql_database: Server port number - Service azure_sql_managed_db_warehouse: Server port number - Service databricks: Server port number - Service maria_rds_warehouse: Server port number - Service maria_warehouse: Server port number - Service mysql_rds_warehouse: Server port number - Service mysql_warehouse: Server port number - Service new_s3_datalake: Server port number - Service onelake: Server port number - Service panoply: Server port number - Service periscope_warehouse: Server port number - Service postgres_gcp_warehouse: Server port number - Service postgres_rds_warehouse: Server port number - Service postgres_warehouse: Server port number - Service redshift: Server port number - Service snowflake: Server port number - Service sql_server_rds_warehouse: Server port number - Service sql_server_warehouse: Server port number
PrefixPath string: Field usage depends on service value: - Service adls: (Immutable) path/to/data within the container - Service new_s3_datalake: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy - Service onelake: (Immutable) path/to/data within your lakehouse inside the Files directory
PrivateKey string: Field usage depends on service value: - Service snowflake: Private access key. The field should be specified if authentication type is KEY_PAIR.
ProjectId string: Field usage depends on service value: - Service big_query: BigQuery project ID
PublicKey string: Field usage depends on service value: - Service aurora_postgres_warehouse: Public Key - Service aurora_warehouse: Public Key - Service azure_postgres_warehouse: Public Key - Service azure_sql_data_warehouse: Public Key - Service azure_sql_database: Public Key - Service azure_sql_managed_db_warehouse: Public Key - Service maria_rds_warehouse: Public Key - Service maria_warehouse: Public Key - Service mysql_rds_warehouse: Public Key - Service mysql_warehouse: Public Key - Service panoply: Public Key - Service periscope_warehouse: Public Key - Service postgres_gcp_warehouse: Public Key - Service postgres_rds_warehouse: Public Key - Service postgres_warehouse: Public Key - Service redshift: Public Key - Service sql_server_rds_warehouse: Public Key - Service sql_server_warehouse: Public Key
Region string: Field usage depends on service value: - Service new_s3_datalake: Region of your AWS S3 bucket
RegistryName string
RegistryStsRegion string
ReplicationFactor float64: Field usage depends on service value: - Service confluent_cloud_wh: Replication factor.
ResourceId string: Field usage depends on service value: - Service aurora_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service aurora_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_data_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_database: Field to test Self serve Private Link - Service azure_sql_managed_db_warehouse: Field to test Self serve Private Link - Service databricks: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service panoply: This field is currently being introduced to test the Self-serve Private Link functionality - Service periscope_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_gcp_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service redshift: This field is currently being introduced to test the Self-serve Private Link functionality - Service snowflake: This field is currently being introduced to test the Self-serve Private Link functionality - Service sql_server_rds_warehouse: Field to test Self serve Private Link - Service sql_server_warehouse: Field to test Self serve Private Link
Role string: Field usage depends on service value: - Service snowflake: If not specified, Fivetran will use the user's default role
RoleArn string: Field usage depends on service value: - Service redshift: Role ARN with Redshift permissions. Required if authentication type is IAM.
SaslMechanism string: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
SaslPlainKey string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL key.
SaslPlainSecret string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL secret.
SchemaCompatibility string
SchemaRegistry string: Field usage depends on service value: - Service confluent_cloud_wh: Schema Registry
SchemaRegistryApiKey string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API key.
SchemaRegistryApiSecret string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API secret.
SchemaRegistryUrl string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry URL.
SecretKey string: Field usage depends on service value: - Service big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service big_query_dts: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service managed_big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
SecretValue string: Field usage depends on service value: - Service adls: Secret value for service principal - Service onelake: Secret value for service principal
SecurityProtocol string: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
ServerHostName string: Field usage depends on service value: - Service adls: Server Host name - Service databricks: Server name - Service new_s3_datalake: Server host name - Service onelake: Server Host name
ShouldMaintainTablesInDatabricks bool: Field usage depends on service value: - Service adls: Should maintain tables in Databricks - Service new_s3_datalake: Should maintain tables in Databricks - Service onelake: Should maintain tables in Databricks
SnapshotRetentionPeriod string: Field usage depends on service value: - Service adls: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service new_s3_datalake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service onelake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
SnowflakeCloud string
SnowflakeRegion string
StorageAccountName string: Field usage depends on service value: - Service adls: (Immutable) Storage account for Azure Data Lake Storage Gen2 name - Service onelake: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
TableFormat string: Field usage depends on service value: - Service new_s3_datalake: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
TenantId string: Field usage depends on service value: - Service adls: Tenant id of service principal - Service onelake: Tenant ID of service principal
TunnelHost string: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel.
TunnelPort float64: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel.
TunnelUser string: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel.
User string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user name - Service aurora_warehouse: Database user name - Service azure_postgres_warehouse: Database user name - Service azure_sql_data_warehouse: Database user name - Service azure_sql_database: Database user name - Service azure_sql_managed_db_warehouse: Database user name - Service maria_rds_warehouse: Database user name - Service maria_warehouse: Database user name - Service mysql_rds_warehouse: Database user name - Service mysql_warehouse: Database user name - Service panoply: Database user name - Service periscope_warehouse: Database user name - Service postgres_gcp_warehouse: Database user name - Service postgres_rds_warehouse: Database user name - Service postgres_warehouse: Database user name - Service redshift: Database user name - Service snowflake: Database user name - Service sql_server_rds_warehouse: Database user name - Service sql_server_warehouse: Database user name
WorkspaceGuid string: Field usage depends on service value: - Service onelake: (Immutable) OneLake workspace GUID
WorkspaceName string: Field usage depends on service value: - Service onelake: OneLake workspace name

alwaysEncrypted Boolean: Field usage depends on service value: - Service aurora_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service panoply: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service redshift: Require TLS through Tunnel - Service sql_server_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel.
auth String: Field usage depends on service value: - Service snowflake: Password-based or key-based authentication type
authType String: Field usage depends on service value: - Service adls: Authentication type - Service databricks: Authentication type - Service new_s3_datalake: Authentication type - Service onelake: Authentication type - Service redshift: Authentication type. Default value: PASSWORD.
awsAccessKeyId String: Field usage depends on service value: - Service new_s3_datalake: AWS access key to access the S3 bucket and AWS Glue
awsSecretAccessKey String: Field usage depends on service value: - Service new_s3_datalake: AWS secret access key to access the S3 bucket and AWS Glue
bootstrapServers List<String>: Field usage depends on service value: - Service confluent_cloud_wh: Comma-separated list of Confluent Cloud servers in the server:port format.
bucket String: Field usage depends on service value: - Service big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service big_query_dts: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service managed_big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service new_s3_datalake: (Immutable) The name of the bucket to be used as destination
catalog String: Field usage depends on service value: - Service adls: Catalog name - Service databricks: Catalog name - Service new_s3_datalake: Catalog name - Service onelake: Catalog name
clientId String: Field usage depends on service value: - Service adls: Client id of service principal - Service onelake: Client ID of service principal
cloudProvider String: Field usage depends on service value: - Service databricks: Databricks deployment cloud
clusterId String: Field usage depends on service value: - Service panoply: Cluster ID. - Service periscope_warehouse: Cluster ID. - Service redshift: Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
clusterRegion String: Field usage depends on service value: - Service panoply: Cluster region. - Service periscope_warehouse: Cluster region. - Service redshift: Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
connectionMethod String
connectionType String: Field usage depends on service value: - Service adls: Connection method. Default value: Directly. - Service aurora_postgres_warehouse: Connection method. Default value: Directly. - Service aurora_warehouse: Connection method. Default value: Directly. - Service azure_postgres_warehouse: Connection method. Default value: Directly. - Service azure_sql_data_warehouse: Connection method. Default value: Directly. - Service azure_sql_database: Connection method. Default value: Directly. - Service azure_sql_managed_db_warehouse: Connection method. Default value: Directly. - Service databricks: Connection method. Default value: Directly. - Service maria_rds_warehouse: Connection method. Default value: Directly. - Service maria_warehouse: Connection method. Default value: Directly. - Service mysql_rds_warehouse: Connection method. Default value: Directly. - Service mysql_warehouse: Connection method. Default value: Directly. - Service panoply: Connection method. Default value: Directly. - Service periscope_warehouse: Connection method. Default value: Directly. - Service postgres_gcp_warehouse: Connection method. Default value: Directly. - Service postgres_rds_warehouse: Connection method. Default value: Directly. - Service postgres_warehouse: Connection method. Default value: Directly. - Service redshift: Connection method. Default value: Directly. - Service snowflake: Connection method. Default value: Directly. - Service sql_server_rds_warehouse: Connection method. Default value: Directly. - Service sql_server_warehouse: Connection method. Default value: Directly.
containerName String: Field usage depends on service value: - Service adls: (Immutable) Container to store delta table files - Service onelake: Workspace name to store delta table files
controllerId String
createExternalTables Boolean: Field usage depends on service value: - Service databricks: Whether to create external tables
dataFormat String: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud message format.
dataSetLocation String: Field usage depends on service value: - Service big_query: Data location. Datasets will reside in this location. - Service big_query_dts: Data location. Datasets will reside in this location. - Service managed_big_query: Data location. Datasets will reside in this location.
database String: Field usage depends on service value: - Service aurora_postgres_warehouse: Database name - Service aurora_warehouse: Database name - Service azure_postgres_warehouse: Database name - Service azure_sql_data_warehouse: Database name - Service azure_sql_database: Database name - Service azure_sql_managed_db_warehouse: Database name - Service maria_rds_warehouse: Database name - Service maria_warehouse: Database name - Service mysql_rds_warehouse: Database name - Service mysql_warehouse: Database name - Service panoply: Database name - Service periscope_warehouse: Database name - Service postgres_gcp_warehouse: Database name - Service postgres_rds_warehouse: Database name - Service postgres_warehouse: Database name - Service redshift: Database name - Service snowflake: Database name - Service sql_server_rds_warehouse: Database name - Service sql_server_warehouse: Database name
databricksConnectionType String: Field usage depends on service value: - Service adls: Databricks Connection method. Default value: Directly. - Service new_s3_datalake: Databricks Connection method. Default value: Directly. - Service onelake: Databricks Connection method. Default value: Directly.
enableRemoteExecution Boolean
externalId String: Field usage depends on service value: - Service aws_msk_wh: Fivetran generated External ID - Service panoply: Fivetran generated External ID - Service periscope_warehouse: Fivetran generated External ID - Service redshift: Fivetran generated External ID
externalLocation String: Field usage depends on service value: - Service databricks: External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path.
fivetranGlueRoleArn String
fivetranMskRoleArn String
fivetranRoleArn String: Field usage depends on service value: - Service new_s3_datalake: ARN of the role which you created with different required policy mentioned in our setup guide
host String: Field usage depends on service value: - Service aurora_postgres_warehouse: Server name - Service aurora_warehouse: Server name - Service azure_postgres_warehouse: Server name - Service azure_sql_data_warehouse: Server name - Service azure_sql_database: Server name - Service azure_sql_managed_db_warehouse: Server name - Service maria_rds_warehouse: Server name - Service maria_warehouse: Server name - Service mysql_rds_warehouse: Server name - Service mysql_warehouse: Server name - Service panoply: Server name - Service periscope_warehouse: Server name - Service postgres_gcp_warehouse: Server name - Service postgres_rds_warehouse: Server name - Service postgres_warehouse: Server name - Service redshift: Server name - Service snowflake: Server name - Service sql_server_rds_warehouse: Server name - Service sql_server_warehouse: Server name
httpPath String: Field usage depends on service value: - Service adls: HTTP path - Service databricks: HTTP path - Service new_s3_datalake: HTTP path - Service onelake: HTTP path
isPrivateKeyEncrypted Boolean: Field usage depends on service value: - Service snowflake: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
isPrivateLinkRequired Boolean: Field usage depends on service value: - Service new_s3_datalake: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
isRedshiftServerless Boolean: Field usage depends on service value: - Service redshift: Is your destination Redshift Serverless
lakehouseGuid String: Field usage depends on service value: - Service onelake: (Immutable) OneLake lakehouse GUID
lakehouseName String: Field usage depends on service value: - Service onelake: (Immutable) Name of your lakehouse
mskStsRegion String
numOfPartitions Double: Field usage depends on service value: - Service confluent_cloud_wh: Number of partitions per topic.
oauth2ClientId String: Field usage depends on service value: - Service adls: OAuth 2.0 client ID - Service databricks: OAuth 2.0 client ID - Service new_s3_datalake: OAuth 2.0 client ID - Service onelake: OAuth 2.0 client ID
oauth2Secret String: Field usage depends on service value: - Service adls: OAuth 2.0 secret - Service databricks: OAuth 2.0 secret - Service new_s3_datalake: OAuth 2.0 secret - Service onelake: OAuth 2.0 secret
passphrase String: Field usage depends on service value: - Service snowflake: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password String: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user password - Service aurora_warehouse: Database user password - Service azure_postgres_warehouse: Database user password - Service azure_sql_data_warehouse: Database user password - Service azure_sql_database: Database user password - Service azure_sql_managed_db_warehouse: Database user password - Service maria_rds_warehouse: Database user password - Service maria_warehouse: Database user password - Service mysql_rds_warehouse: Database user password - Service mysql_warehouse: Database user password - Service panoply: Database user password - Service periscope_warehouse: Database user password - Service postgres_gcp_warehouse: Database user password - Service postgres_rds_warehouse: Database user password - Service postgres_warehouse: Database user password - Service redshift: Database user password. Required if authentication type is PASSWORD. - Service snowflake: Database user password. The field should be specified if authentication type is PASSWORD. - Service sql_server_rds_warehouse: Database user password - Service sql_server_warehouse: Database user password
personalAccessToken String: Field usage depends on service value: - Service adls: Personal access token - Service databricks: Personal access token - Service new_s3_datalake: Personal access token - Service onelake: Personal access token
port Double: Field usage depends on service value: - Service adls: Server port number - Service aurora_postgres_warehouse: Server port number - Service aurora_warehouse: Server port number - Service azure_postgres_warehouse: Server port number - Service azure_sql_data_warehouse: Server port number - Service azure_sql_database: Server port number - Service azure_sql_managed_db_warehouse: Server port number - Service databricks: Server port number - Service maria_rds_warehouse: Server port number - Service maria_warehouse: Server port number - Service mysql_rds_warehouse: Server port number - Service mysql_warehouse: Server port number - Service new_s3_datalake: Server port number - Service onelake: Server port number - Service panoply: Server port number - Service periscope_warehouse: Server port number - Service postgres_gcp_warehouse: Server port number - Service postgres_rds_warehouse: Server port number - Service postgres_warehouse: Server port number - Service redshift: Server port number - Service snowflake: Server port number - Service sql_server_rds_warehouse: Server port number - Service sql_server_warehouse: Server port number
prefixPath String: Field usage depends on service value: - Service adls: (Immutable) path/to/data within the container - Service new_s3_datalake: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy - Service onelake: (Immutable) path/to/data within your lakehouse inside the Files directory
privateKey String: Field usage depends on service value: - Service snowflake: Private access key. The field should be specified if authentication type is KEY_PAIR.
projectId String: Field usage depends on service value: - Service big_query: BigQuery project ID
publicKey String: Field usage depends on service value: - Service aurora_postgres_warehouse: Public Key - Service aurora_warehouse: Public Key - Service azure_postgres_warehouse: Public Key - Service azure_sql_data_warehouse: Public Key - Service azure_sql_database: Public Key - Service azure_sql_managed_db_warehouse: Public Key - Service maria_rds_warehouse: Public Key - Service maria_warehouse: Public Key - Service mysql_rds_warehouse: Public Key - Service mysql_warehouse: Public Key - Service panoply: Public Key - Service periscope_warehouse: Public Key - Service postgres_gcp_warehouse: Public Key - Service postgres_rds_warehouse: Public Key - Service postgres_warehouse: Public Key - Service redshift: Public Key - Service sql_server_rds_warehouse: Public Key - Service sql_server_warehouse: Public Key
region String: Field usage depends on service value: - Service new_s3_datalake: Region of your AWS S3 bucket
registryName String
registryStsRegion String
replicationFactor Double: Field usage depends on service value: - Service confluent_cloud_wh: Replication factor.
resourceId String: Field usage depends on service value: - Service aurora_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service aurora_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_data_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_database: Field to test Self serve Private Link - Service azure_sql_managed_db_warehouse: Field to test Self serve Private Link - Service databricks: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service panoply: This field is currently being introduced to test the Self-serve Private Link functionality - Service periscope_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_gcp_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service redshift: This field is currently being introduced to test the Self-serve Private Link functionality - Service snowflake: This field is currently being introduced to test the Self-serve Private Link functionality - Service sql_server_rds_warehouse: Field to test Self serve Private Link - Service sql_server_warehouse: Field to test Self serve Private Link
role String: Field usage depends on service value: - Service snowflake: If not specified, Fivetran will use the user's default role
roleArn String: Field usage depends on service value: - Service redshift: Role ARN with Redshift permissions. Required if authentication type is IAM.
saslMechanism String: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
saslPlainKey String: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL key.
saslPlainSecret String: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL secret.
schemaCompatibility String
schemaRegistry String: Field usage depends on service value: - Service confluent_cloud_wh: Schema Registry
schemaRegistryApiKey String: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API key.
schemaRegistryApiSecret String: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API secret.
schemaRegistryUrl String: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry URL.
secretKey String: Field usage depends on service value: - Service big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service big_query_dts: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service managed_big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
secretValue String: Field usage depends on service value: - Service adls: Secret value for service principal - Service onelake: Secret value for service principal
securityProtocol String: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
serverHostName String: Field usage depends on service value: - Service adls: Server Host name - Service databricks: Server name - Service new_s3_datalake: Server host name - Service onelake: Server Host name
shouldMaintainTablesInDatabricks Boolean: Field usage depends on service value: - Service adls: Should maintain tables in Databricks - Service new_s3_datalake: Should maintain tables in Databricks - Service onelake: Should maintain tables in Databricks
snapshotRetentionPeriod String: Field usage depends on service value: - Service adls: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service new_s3_datalake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service onelake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
snowflakeCloud String
snowflakeRegion String
storageAccountName String: Field usage depends on service value: - Service adls: (Immutable) Storage account for Azure Data Lake Storage Gen2 name - Service onelake: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
tableFormat String: Field usage depends on service value: - Service new_s3_datalake: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
tenantId String: Field usage depends on service value: - Service adls: Tenant id of service principal - Service onelake: Tenant ID of service principal
tunnelHost String: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel.
tunnelPort Double: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel.
tunnelUser String: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel.
user String: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user name - Service aurora_warehouse: Database user name - Service azure_postgres_warehouse: Database user name - Service azure_sql_data_warehouse: Database user name - Service azure_sql_database: Database user name - Service azure_sql_managed_db_warehouse: Database user name - Service maria_rds_warehouse: Database user name - Service maria_warehouse: Database user name - Service mysql_rds_warehouse: Database user name - Service mysql_warehouse: Database user name - Service panoply: Database user name - Service periscope_warehouse: Database user name - Service postgres_gcp_warehouse: Database user name - Service postgres_rds_warehouse: Database user name - Service postgres_warehouse: Database user name - Service redshift: Database user name - Service snowflake: Database user name - Service sql_server_rds_warehouse: Database user name - Service sql_server_warehouse: Database user name
workspaceGuid String: Field usage depends on service value: - Service onelake: (Immutable) OneLake workspace GUID
workspaceName String: Field usage depends on service value: - Service onelake: OneLake workspace name

alwaysEncrypted boolean: Field usage depends on service value: - Service aurora_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service panoply: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service redshift: Require TLS through Tunnel - Service sql_server_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel.
auth string: Field usage depends on service value: - Service snowflake: Password-based or key-based authentication type
authType string: Field usage depends on service value: - Service adls: Authentication type - Service databricks: Authentication type - Service new_s3_datalake: Authentication type - Service onelake: Authentication type - Service redshift: Authentication type. Default value: PASSWORD.
awsAccessKeyId string: Field usage depends on service value: - Service new_s3_datalake: AWS access key to access the S3 bucket and AWS Glue
awsSecretAccessKey string: Field usage depends on service value: - Service new_s3_datalake: AWS secret access key to access the S3 bucket and AWS Glue
bootstrapServers string[]: Field usage depends on service value: - Service confluent_cloud_wh: Comma-separated list of Confluent Cloud servers in the server:port format.
bucket string: Field usage depends on service value: - Service big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service big_query_dts: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service managed_big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service new_s3_datalake: (Immutable) The name of the bucket to be used as destination
catalog string: Field usage depends on service value: - Service adls: Catalog name - Service databricks: Catalog name - Service new_s3_datalake: Catalog name - Service onelake: Catalog name
clientId string: Field usage depends on service value: - Service adls: Client id of service principal - Service onelake: Client ID of service principal
cloudProvider string: Field usage depends on service value: - Service databricks: Databricks deployment cloud
clusterId string: Field usage depends on service value: - Service panoply: Cluster ID. - Service periscope_warehouse: Cluster ID. - Service redshift: Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
clusterRegion string: Field usage depends on service value: - Service panoply: Cluster region. - Service periscope_warehouse: Cluster region. - Service redshift: Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
connectionMethod string
connectionType string: Field usage depends on service value: - Service adls: Connection method. Default value: Directly. - Service aurora_postgres_warehouse: Connection method. Default value: Directly. - Service aurora_warehouse: Connection method. Default value: Directly. - Service azure_postgres_warehouse: Connection method. Default value: Directly. - Service azure_sql_data_warehouse: Connection method. Default value: Directly. - Service azure_sql_database: Connection method. Default value: Directly. - Service azure_sql_managed_db_warehouse: Connection method. Default value: Directly. - Service databricks: Connection method. Default value: Directly. - Service maria_rds_warehouse: Connection method. Default value: Directly. - Service maria_warehouse: Connection method. Default value: Directly. - Service mysql_rds_warehouse: Connection method. Default value: Directly. - Service mysql_warehouse: Connection method. Default value: Directly. - Service panoply: Connection method. Default value: Directly. - Service periscope_warehouse: Connection method. Default value: Directly. - Service postgres_gcp_warehouse: Connection method. Default value: Directly. - Service postgres_rds_warehouse: Connection method. Default value: Directly. - Service postgres_warehouse: Connection method. Default value: Directly. - Service redshift: Connection method. Default value: Directly. - Service snowflake: Connection method. Default value: Directly. - Service sql_server_rds_warehouse: Connection method. Default value: Directly. - Service sql_server_warehouse: Connection method. Default value: Directly.
containerName string: Field usage depends on service value: - Service adls: (Immutable) Container to store delta table files - Service onelake: Workspace name to store delta table files
controllerId string
createExternalTables boolean: Field usage depends on service value: - Service databricks: Whether to create external tables
dataFormat string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud message format.
dataSetLocation string: Field usage depends on service value: - Service big_query: Data location. Datasets will reside in this location. - Service big_query_dts: Data location. Datasets will reside in this location. - Service managed_big_query: Data location. Datasets will reside in this location.
database string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database name - Service aurora_warehouse: Database name - Service azure_postgres_warehouse: Database name - Service azure_sql_data_warehouse: Database name - Service azure_sql_database: Database name - Service azure_sql_managed_db_warehouse: Database name - Service maria_rds_warehouse: Database name - Service maria_warehouse: Database name - Service mysql_rds_warehouse: Database name - Service mysql_warehouse: Database name - Service panoply: Database name - Service periscope_warehouse: Database name - Service postgres_gcp_warehouse: Database name - Service postgres_rds_warehouse: Database name - Service postgres_warehouse: Database name - Service redshift: Database name - Service snowflake: Database name - Service sql_server_rds_warehouse: Database name - Service sql_server_warehouse: Database name
databricksConnectionType string: Field usage depends on service value: - Service adls: Databricks Connection method. Default value: Directly. - Service new_s3_datalake: Databricks Connection method. Default value: Directly. - Service onelake: Databricks Connection method. Default value: Directly.
enableRemoteExecution boolean
externalId string: Field usage depends on service value: - Service aws_msk_wh: Fivetran generated External ID - Service panoply: Fivetran generated External ID - Service periscope_warehouse: Fivetran generated External ID - Service redshift: Fivetran generated External ID
externalLocation string: Field usage depends on service value: - Service databricks: External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path.
fivetranGlueRoleArn string
fivetranMskRoleArn string
fivetranRoleArn string: Field usage depends on service value: - Service new_s3_datalake: ARN of the role which you created with different required policy mentioned in our setup guide
host string: Field usage depends on service value: - Service aurora_postgres_warehouse: Server name - Service aurora_warehouse: Server name - Service azure_postgres_warehouse: Server name - Service azure_sql_data_warehouse: Server name - Service azure_sql_database: Server name - Service azure_sql_managed_db_warehouse: Server name - Service maria_rds_warehouse: Server name - Service maria_warehouse: Server name - Service mysql_rds_warehouse: Server name - Service mysql_warehouse: Server name - Service panoply: Server name - Service periscope_warehouse: Server name - Service postgres_gcp_warehouse: Server name - Service postgres_rds_warehouse: Server name - Service postgres_warehouse: Server name - Service redshift: Server name - Service snowflake: Server name - Service sql_server_rds_warehouse: Server name - Service sql_server_warehouse: Server name
httpPath string: Field usage depends on service value: - Service adls: HTTP path - Service databricks: HTTP path - Service new_s3_datalake: HTTP path - Service onelake: HTTP path
isPrivateKeyEncrypted boolean: Field usage depends on service value: - Service snowflake: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
isPrivateLinkRequired boolean: Field usage depends on service value: - Service new_s3_datalake: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
isRedshiftServerless boolean: Field usage depends on service value: - Service redshift: Is your destination Redshift Serverless
lakehouseGuid string: Field usage depends on service value: - Service onelake: (Immutable) OneLake lakehouse GUID
lakehouseName string: Field usage depends on service value: - Service onelake: (Immutable) Name of your lakehouse
mskStsRegion string
numOfPartitions number: Field usage depends on service value: - Service confluent_cloud_wh: Number of partitions per topic.
oauth2ClientId string: Field usage depends on service value: - Service adls: OAuth 2.0 client ID - Service databricks: OAuth 2.0 client ID - Service new_s3_datalake: OAuth 2.0 client ID - Service onelake: OAuth 2.0 client ID
oauth2Secret string: Field usage depends on service value: - Service adls: OAuth 2.0 secret - Service databricks: OAuth 2.0 secret - Service new_s3_datalake: OAuth 2.0 secret - Service onelake: OAuth 2.0 secret
passphrase string: Field usage depends on service value: - Service snowflake: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user password - Service aurora_warehouse: Database user password - Service azure_postgres_warehouse: Database user password - Service azure_sql_data_warehouse: Database user password - Service azure_sql_database: Database user password - Service azure_sql_managed_db_warehouse: Database user password - Service maria_rds_warehouse: Database user password - Service maria_warehouse: Database user password - Service mysql_rds_warehouse: Database user password - Service mysql_warehouse: Database user password - Service panoply: Database user password - Service periscope_warehouse: Database user password - Service postgres_gcp_warehouse: Database user password - Service postgres_rds_warehouse: Database user password - Service postgres_warehouse: Database user password - Service redshift: Database user password. Required if authentication type is PASSWORD. - Service snowflake: Database user password. The field should be specified if authentication type is PASSWORD. - Service sql_server_rds_warehouse: Database user password - Service sql_server_warehouse: Database user password
personalAccessToken string: Field usage depends on service value: - Service adls: Personal access token - Service databricks: Personal access token - Service new_s3_datalake: Personal access token - Service onelake: Personal access token
port number: Field usage depends on service value: - Service adls: Server port number - Service aurora_postgres_warehouse: Server port number - Service aurora_warehouse: Server port number - Service azure_postgres_warehouse: Server port number - Service azure_sql_data_warehouse: Server port number - Service azure_sql_database: Server port number - Service azure_sql_managed_db_warehouse: Server port number - Service databricks: Server port number - Service maria_rds_warehouse: Server port number - Service maria_warehouse: Server port number - Service mysql_rds_warehouse: Server port number - Service mysql_warehouse: Server port number - Service new_s3_datalake: Server port number - Service onelake: Server port number - Service panoply: Server port number - Service periscope_warehouse: Server port number - Service postgres_gcp_warehouse: Server port number - Service postgres_rds_warehouse: Server port number - Service postgres_warehouse: Server port number - Service redshift: Server port number - Service snowflake: Server port number - Service sql_server_rds_warehouse: Server port number - Service sql_server_warehouse: Server port number
prefixPath string: Field usage depends on service value: - Service adls: (Immutable) path/to/data within the container - Service new_s3_datalake: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy - Service onelake: (Immutable) path/to/data within your lakehouse inside the Files directory
privateKey string: Field usage depends on service value: - Service snowflake: Private access key. The field should be specified if authentication type is KEY_PAIR.
projectId string: Field usage depends on service value: - Service big_query: BigQuery project ID
publicKey string: Field usage depends on service value: - Service aurora_postgres_warehouse: Public Key - Service aurora_warehouse: Public Key - Service azure_postgres_warehouse: Public Key - Service azure_sql_data_warehouse: Public Key - Service azure_sql_database: Public Key - Service azure_sql_managed_db_warehouse: Public Key - Service maria_rds_warehouse: Public Key - Service maria_warehouse: Public Key - Service mysql_rds_warehouse: Public Key - Service mysql_warehouse: Public Key - Service panoply: Public Key - Service periscope_warehouse: Public Key - Service postgres_gcp_warehouse: Public Key - Service postgres_rds_warehouse: Public Key - Service postgres_warehouse: Public Key - Service redshift: Public Key - Service sql_server_rds_warehouse: Public Key - Service sql_server_warehouse: Public Key
region string: Field usage depends on service value: - Service new_s3_datalake: Region of your AWS S3 bucket
registryName string
registryStsRegion string
replicationFactor number: Field usage depends on service value: - Service confluent_cloud_wh: Replication factor.
resourceId string: Field usage depends on service value: - Service aurora_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service aurora_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_data_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_database: Field to test Self serve Private Link - Service azure_sql_managed_db_warehouse: Field to test Self serve Private Link - Service databricks: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service panoply: This field is currently being introduced to test the Self-serve Private Link functionality - Service periscope_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_gcp_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service redshift: This field is currently being introduced to test the Self-serve Private Link functionality - Service snowflake: This field is currently being introduced to test the Self-serve Private Link functionality - Service sql_server_rds_warehouse: Field to test Self serve Private Link - Service sql_server_warehouse: Field to test Self serve Private Link
role string: Field usage depends on service value: - Service snowflake: If not specified, Fivetran will use the user's default role
roleArn string: Field usage depends on service value: - Service redshift: Role ARN with Redshift permissions. Required if authentication type is IAM.
saslMechanism string: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
saslPlainKey string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL key.
saslPlainSecret string: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL secret.
schemaCompatibility string
schemaRegistry string: Field usage depends on service value: - Service confluent_cloud_wh: Schema Registry
schemaRegistryApiKey string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API key.
schemaRegistryApiSecret string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API secret.
schemaRegistryUrl string: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry URL.
secretKey string: Field usage depends on service value: - Service big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service big_query_dts: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service managed_big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
secretValue string: Field usage depends on service value: - Service adls: Secret value for service principal - Service onelake: Secret value for service principal
securityProtocol string: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
serverHostName string: Field usage depends on service value: - Service adls: Server Host name - Service databricks: Server name - Service new_s3_datalake: Server host name - Service onelake: Server Host name
shouldMaintainTablesInDatabricks boolean: Field usage depends on service value: - Service adls: Should maintain tables in Databricks - Service new_s3_datalake: Should maintain tables in Databricks - Service onelake: Should maintain tables in Databricks
snapshotRetentionPeriod string: Field usage depends on service value: - Service adls: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service new_s3_datalake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service onelake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
snowflakeCloud string
snowflakeRegion string
storageAccountName string: Field usage depends on service value: - Service adls: (Immutable) Storage account for Azure Data Lake Storage Gen2 name - Service onelake: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
tableFormat string: Field usage depends on service value: - Service new_s3_datalake: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
tenantId string: Field usage depends on service value: - Service adls: Tenant id of service principal - Service onelake: Tenant ID of service principal
tunnelHost string: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel.
tunnelPort number: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel.
tunnelUser string: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel.
user string: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user name - Service aurora_warehouse: Database user name - Service azure_postgres_warehouse: Database user name - Service azure_sql_data_warehouse: Database user name - Service azure_sql_database: Database user name - Service azure_sql_managed_db_warehouse: Database user name - Service maria_rds_warehouse: Database user name - Service maria_warehouse: Database user name - Service mysql_rds_warehouse: Database user name - Service mysql_warehouse: Database user name - Service panoply: Database user name - Service periscope_warehouse: Database user name - Service postgres_gcp_warehouse: Database user name - Service postgres_rds_warehouse: Database user name - Service postgres_warehouse: Database user name - Service redshift: Database user name - Service snowflake: Database user name - Service sql_server_rds_warehouse: Database user name - Service sql_server_warehouse: Database user name
workspaceGuid string: Field usage depends on service value: - Service onelake: (Immutable) OneLake workspace GUID
workspaceName string: Field usage depends on service value: - Service onelake: OneLake workspace name

always_encrypted bool: Field usage depends on service value: - Service aurora_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service panoply: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service redshift: Require TLS through Tunnel - Service sql_server_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel.
auth str: Field usage depends on service value: - Service snowflake: Password-based or key-based authentication type
auth_type str: Field usage depends on service value: - Service adls: Authentication type - Service databricks: Authentication type - Service new_s3_datalake: Authentication type - Service onelake: Authentication type - Service redshift: Authentication type. Default value: PASSWORD.
aws_access_key_id str: Field usage depends on service value: - Service new_s3_datalake: AWS access key to access the S3 bucket and AWS Glue
aws_secret_access_key str: Field usage depends on service value: - Service new_s3_datalake: AWS secret access key to access the S3 bucket and AWS Glue
bootstrap_servers Sequence[str]: Field usage depends on service value: - Service confluent_cloud_wh: Comma-separated list of Confluent Cloud servers in the server:port format.
bucket str: Field usage depends on service value: - Service big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service big_query_dts: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service managed_big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service new_s3_datalake: (Immutable) The name of the bucket to be used as destination
catalog str: Field usage depends on service value: - Service adls: Catalog name - Service databricks: Catalog name - Service new_s3_datalake: Catalog name - Service onelake: Catalog name
client_id str: Field usage depends on service value: - Service adls: Client id of service principal - Service onelake: Client ID of service principal
cloud_provider str: Field usage depends on service value: - Service databricks: Databricks deployment cloud
cluster_id str: Field usage depends on service value: - Service panoply: Cluster ID. - Service periscope_warehouse: Cluster ID. - Service redshift: Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
cluster_region str: Field usage depends on service value: - Service panoply: Cluster region. - Service periscope_warehouse: Cluster region. - Service redshift: Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
connection_method str
connection_type str: Field usage depends on service value: - Service adls: Connection method. Default value: Directly. - Service aurora_postgres_warehouse: Connection method. Default value: Directly. - Service aurora_warehouse: Connection method. Default value: Directly. - Service azure_postgres_warehouse: Connection method. Default value: Directly. - Service azure_sql_data_warehouse: Connection method. Default value: Directly. - Service azure_sql_database: Connection method. Default value: Directly. - Service azure_sql_managed_db_warehouse: Connection method. Default value: Directly. - Service databricks: Connection method. Default value: Directly. - Service maria_rds_warehouse: Connection method. Default value: Directly. - Service maria_warehouse: Connection method. Default value: Directly. - Service mysql_rds_warehouse: Connection method. Default value: Directly. - Service mysql_warehouse: Connection method. Default value: Directly. - Service panoply: Connection method. Default value: Directly. - Service periscope_warehouse: Connection method. Default value: Directly. - Service postgres_gcp_warehouse: Connection method. Default value: Directly. - Service postgres_rds_warehouse: Connection method. Default value: Directly. - Service postgres_warehouse: Connection method. Default value: Directly. - Service redshift: Connection method. Default value: Directly. - Service snowflake: Connection method. Default value: Directly. - Service sql_server_rds_warehouse: Connection method. Default value: Directly. - Service sql_server_warehouse: Connection method. Default value: Directly.
container_name str: Field usage depends on service value: - Service adls: (Immutable) Container to store delta table files - Service onelake: Workspace name to store delta table files
controller_id str
create_external_tables bool: Field usage depends on service value: - Service databricks: Whether to create external tables
data_format str: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud message format.
data_set_location str: Field usage depends on service value: - Service big_query: Data location. Datasets will reside in this location. - Service big_query_dts: Data location. Datasets will reside in this location. - Service managed_big_query: Data location. Datasets will reside in this location.
database str: Field usage depends on service value: - Service aurora_postgres_warehouse: Database name - Service aurora_warehouse: Database name - Service azure_postgres_warehouse: Database name - Service azure_sql_data_warehouse: Database name - Service azure_sql_database: Database name - Service azure_sql_managed_db_warehouse: Database name - Service maria_rds_warehouse: Database name - Service maria_warehouse: Database name - Service mysql_rds_warehouse: Database name - Service mysql_warehouse: Database name - Service panoply: Database name - Service periscope_warehouse: Database name - Service postgres_gcp_warehouse: Database name - Service postgres_rds_warehouse: Database name - Service postgres_warehouse: Database name - Service redshift: Database name - Service snowflake: Database name - Service sql_server_rds_warehouse: Database name - Service sql_server_warehouse: Database name
databricks_connection_type str: Field usage depends on service value: - Service adls: Databricks Connection method. Default value: Directly. - Service new_s3_datalake: Databricks Connection method. Default value: Directly. - Service onelake: Databricks Connection method. Default value: Directly.
enable_remote_execution bool
external_id str: Field usage depends on service value: - Service aws_msk_wh: Fivetran generated External ID - Service panoply: Fivetran generated External ID - Service periscope_warehouse: Fivetran generated External ID - Service redshift: Fivetran generated External ID
external_location str: Field usage depends on service value: - Service databricks: External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path.
fivetran_glue_role_arn str
fivetran_msk_role_arn str
fivetran_role_arn str: Field usage depends on service value: - Service new_s3_datalake: ARN of the role which you created with different required policy mentioned in our setup guide
host str: Field usage depends on service value: - Service aurora_postgres_warehouse: Server name - Service aurora_warehouse: Server name - Service azure_postgres_warehouse: Server name - Service azure_sql_data_warehouse: Server name - Service azure_sql_database: Server name - Service azure_sql_managed_db_warehouse: Server name - Service maria_rds_warehouse: Server name - Service maria_warehouse: Server name - Service mysql_rds_warehouse: Server name - Service mysql_warehouse: Server name - Service panoply: Server name - Service periscope_warehouse: Server name - Service postgres_gcp_warehouse: Server name - Service postgres_rds_warehouse: Server name - Service postgres_warehouse: Server name - Service redshift: Server name - Service snowflake: Server name - Service sql_server_rds_warehouse: Server name - Service sql_server_warehouse: Server name
http_path str: Field usage depends on service value: - Service adls: HTTP path - Service databricks: HTTP path - Service new_s3_datalake: HTTP path - Service onelake: HTTP path
is_private_key_encrypted bool: Field usage depends on service value: - Service snowflake: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
is_private_link_required bool: Field usage depends on service value: - Service new_s3_datalake: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
is_redshift_serverless bool: Field usage depends on service value: - Service redshift: Is your destination Redshift Serverless
lakehouse_guid str: Field usage depends on service value: - Service onelake: (Immutable) OneLake lakehouse GUID
lakehouse_name str: Field usage depends on service value: - Service onelake: (Immutable) Name of your lakehouse
msk_sts_region str
num_of_partitions float: Field usage depends on service value: - Service confluent_cloud_wh: Number of partitions per topic.
oauth2_client_id str: Field usage depends on service value: - Service adls: OAuth 2.0 client ID - Service databricks: OAuth 2.0 client ID - Service new_s3_datalake: OAuth 2.0 client ID - Service onelake: OAuth 2.0 client ID
oauth2_secret str: Field usage depends on service value: - Service adls: OAuth 2.0 secret - Service databricks: OAuth 2.0 secret - Service new_s3_datalake: OAuth 2.0 secret - Service onelake: OAuth 2.0 secret
passphrase str: Field usage depends on service value: - Service snowflake: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password str: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user password - Service aurora_warehouse: Database user password - Service azure_postgres_warehouse: Database user password - Service azure_sql_data_warehouse: Database user password - Service azure_sql_database: Database user password - Service azure_sql_managed_db_warehouse: Database user password - Service maria_rds_warehouse: Database user password - Service maria_warehouse: Database user password - Service mysql_rds_warehouse: Database user password - Service mysql_warehouse: Database user password - Service panoply: Database user password - Service periscope_warehouse: Database user password - Service postgres_gcp_warehouse: Database user password - Service postgres_rds_warehouse: Database user password - Service postgres_warehouse: Database user password - Service redshift: Database user password. Required if authentication type is PASSWORD. - Service snowflake: Database user password. The field should be specified if authentication type is PASSWORD. - Service sql_server_rds_warehouse: Database user password - Service sql_server_warehouse: Database user password
personal_access_token str: Field usage depends on service value: - Service adls: Personal access token - Service databricks: Personal access token - Service new_s3_datalake: Personal access token - Service onelake: Personal access token
port float: Field usage depends on service value: - Service adls: Server port number - Service aurora_postgres_warehouse: Server port number - Service aurora_warehouse: Server port number - Service azure_postgres_warehouse: Server port number - Service azure_sql_data_warehouse: Server port number - Service azure_sql_database: Server port number - Service azure_sql_managed_db_warehouse: Server port number - Service databricks: Server port number - Service maria_rds_warehouse: Server port number - Service maria_warehouse: Server port number - Service mysql_rds_warehouse: Server port number - Service mysql_warehouse: Server port number - Service new_s3_datalake: Server port number - Service onelake: Server port number - Service panoply: Server port number - Service periscope_warehouse: Server port number - Service postgres_gcp_warehouse: Server port number - Service postgres_rds_warehouse: Server port number - Service postgres_warehouse: Server port number - Service redshift: Server port number - Service snowflake: Server port number - Service sql_server_rds_warehouse: Server port number - Service sql_server_warehouse: Server port number
prefix_path str: Field usage depends on service value: - Service adls: (Immutable) path/to/data within the container - Service new_s3_datalake: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy - Service onelake: (Immutable) path/to/data within your lakehouse inside the Files directory
private_key str: Field usage depends on service value: - Service snowflake: Private access key. The field should be specified if authentication type is KEY_PAIR.
project_id str: Field usage depends on service value: - Service big_query: BigQuery project ID
public_key str: Field usage depends on service value: - Service aurora_postgres_warehouse: Public Key - Service aurora_warehouse: Public Key - Service azure_postgres_warehouse: Public Key - Service azure_sql_data_warehouse: Public Key - Service azure_sql_database: Public Key - Service azure_sql_managed_db_warehouse: Public Key - Service maria_rds_warehouse: Public Key - Service maria_warehouse: Public Key - Service mysql_rds_warehouse: Public Key - Service mysql_warehouse: Public Key - Service panoply: Public Key - Service periscope_warehouse: Public Key - Service postgres_gcp_warehouse: Public Key - Service postgres_rds_warehouse: Public Key - Service postgres_warehouse: Public Key - Service redshift: Public Key - Service sql_server_rds_warehouse: Public Key - Service sql_server_warehouse: Public Key
region str: Field usage depends on service value: - Service new_s3_datalake: Region of your AWS S3 bucket
registry_name str
registry_sts_region str
replication_factor float: Field usage depends on service value: - Service confluent_cloud_wh: Replication factor.
resource_id str: Field usage depends on service value: - Service aurora_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service aurora_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_data_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_database: Field to test Self serve Private Link - Service azure_sql_managed_db_warehouse: Field to test Self serve Private Link - Service databricks: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service panoply: This field is currently being introduced to test the Self-serve Private Link functionality - Service periscope_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_gcp_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service redshift: This field is currently being introduced to test the Self-serve Private Link functionality - Service snowflake: This field is currently being introduced to test the Self-serve Private Link functionality - Service sql_server_rds_warehouse: Field to test Self serve Private Link - Service sql_server_warehouse: Field to test Self serve Private Link
role str: Field usage depends on service value: - Service snowflake: If not specified, Fivetran will use the user's default role
role_arn str: Field usage depends on service value: - Service redshift: Role ARN with Redshift permissions. Required if authentication type is IAM.
sasl_mechanism str: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
sasl_plain_key str: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL key.
sasl_plain_secret str: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL secret.
schema_compatibility str
schema_registry str: Field usage depends on service value: - Service confluent_cloud_wh: Schema Registry
schema_registry_api_key str: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API key.
schema_registry_api_secret str: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API secret.
schema_registry_url str: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry URL.
secret_key str: Field usage depends on service value: - Service big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service big_query_dts: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service managed_big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
secret_value str: Field usage depends on service value: - Service adls: Secret value for service principal - Service onelake: Secret value for service principal
security_protocol str: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
server_host_name str: Field usage depends on service value: - Service adls: Server Host name - Service databricks: Server name - Service new_s3_datalake: Server host name - Service onelake: Server Host name
should_maintain_tables_in_databricks bool: Field usage depends on service value: - Service adls: Should maintain tables in Databricks - Service new_s3_datalake: Should maintain tables in Databricks - Service onelake: Should maintain tables in Databricks
snapshot_retention_period str: Field usage depends on service value: - Service adls: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service new_s3_datalake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service onelake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
snowflake_cloud str
snowflake_region str
storage_account_name str: Field usage depends on service value: - Service adls: (Immutable) Storage account for Azure Data Lake Storage Gen2 name - Service onelake: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
table_format str: Field usage depends on service value: - Service new_s3_datalake: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
tenant_id str: Field usage depends on service value: - Service adls: Tenant id of service principal - Service onelake: Tenant ID of service principal
tunnel_host str: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel.
tunnel_port float: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel.
tunnel_user str: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel.
user str: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user name - Service aurora_warehouse: Database user name - Service azure_postgres_warehouse: Database user name - Service azure_sql_data_warehouse: Database user name - Service azure_sql_database: Database user name - Service azure_sql_managed_db_warehouse: Database user name - Service maria_rds_warehouse: Database user name - Service maria_warehouse: Database user name - Service mysql_rds_warehouse: Database user name - Service mysql_warehouse: Database user name - Service panoply: Database user name - Service periscope_warehouse: Database user name - Service postgres_gcp_warehouse: Database user name - Service postgres_rds_warehouse: Database user name - Service postgres_warehouse: Database user name - Service redshift: Database user name - Service snowflake: Database user name - Service sql_server_rds_warehouse: Database user name - Service sql_server_warehouse: Database user name
workspace_guid str: Field usage depends on service value: - Service onelake: (Immutable) OneLake workspace GUID
workspace_name str: Field usage depends on service value: - Service onelake: OneLake workspace name

alwaysEncrypted Boolean: Field usage depends on service value: - Service aurora_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service panoply: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service redshift: Require TLS through Tunnel - Service sql_server_rds_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel.
auth String: Field usage depends on service value: - Service snowflake: Password-based or key-based authentication type
authType String: Field usage depends on service value: - Service adls: Authentication type - Service databricks: Authentication type - Service new_s3_datalake: Authentication type - Service onelake: Authentication type - Service redshift: Authentication type. Default value: PASSWORD.
awsAccessKeyId String: Field usage depends on service value: - Service new_s3_datalake: AWS access key to access the S3 bucket and AWS Glue
awsSecretAccessKey String: Field usage depends on service value: - Service new_s3_datalake: AWS secret access key to access the S3 bucket and AWS Glue
bootstrapServers List<String>: Field usage depends on service value: - Service confluent_cloud_wh: Comma-separated list of Confluent Cloud servers in the server:port format.
bucket String: Field usage depends on service value: - Service big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service big_query_dts: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service managed_big_query: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. - Service new_s3_datalake: (Immutable) The name of the bucket to be used as destination
catalog String: Field usage depends on service value: - Service adls: Catalog name - Service databricks: Catalog name - Service new_s3_datalake: Catalog name - Service onelake: Catalog name
clientId String: Field usage depends on service value: - Service adls: Client id of service principal - Service onelake: Client ID of service principal
cloudProvider String: Field usage depends on service value: - Service databricks: Databricks deployment cloud
clusterId String: Field usage depends on service value: - Service panoply: Cluster ID. - Service periscope_warehouse: Cluster ID. - Service redshift: Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
clusterRegion String: Field usage depends on service value: - Service panoply: Cluster region. - Service periscope_warehouse: Cluster region. - Service redshift: Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM.
connectionMethod String
connectionType String: Field usage depends on service value: - Service adls: Connection method. Default value: Directly. - Service aurora_postgres_warehouse: Connection method. Default value: Directly. - Service aurora_warehouse: Connection method. Default value: Directly. - Service azure_postgres_warehouse: Connection method. Default value: Directly. - Service azure_sql_data_warehouse: Connection method. Default value: Directly. - Service azure_sql_database: Connection method. Default value: Directly. - Service azure_sql_managed_db_warehouse: Connection method. Default value: Directly. - Service databricks: Connection method. Default value: Directly. - Service maria_rds_warehouse: Connection method. Default value: Directly. - Service maria_warehouse: Connection method. Default value: Directly. - Service mysql_rds_warehouse: Connection method. Default value: Directly. - Service mysql_warehouse: Connection method. Default value: Directly. - Service panoply: Connection method. Default value: Directly. - Service periscope_warehouse: Connection method. Default value: Directly. - Service postgres_gcp_warehouse: Connection method. Default value: Directly. - Service postgres_rds_warehouse: Connection method. Default value: Directly. - Service postgres_warehouse: Connection method. Default value: Directly. - Service redshift: Connection method. Default value: Directly. - Service snowflake: Connection method. Default value: Directly. - Service sql_server_rds_warehouse: Connection method. Default value: Directly. - Service sql_server_warehouse: Connection method. Default value: Directly.
containerName String: Field usage depends on service value: - Service adls: (Immutable) Container to store delta table files - Service onelake: Workspace name to store delta table files
controllerId String
createExternalTables Boolean: Field usage depends on service value: - Service databricks: Whether to create external tables
dataFormat String: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud message format.
dataSetLocation String: Field usage depends on service value: - Service big_query: Data location. Datasets will reside in this location. - Service big_query_dts: Data location. Datasets will reside in this location. - Service managed_big_query: Data location. Datasets will reside in this location.
database String: Field usage depends on service value: - Service aurora_postgres_warehouse: Database name - Service aurora_warehouse: Database name - Service azure_postgres_warehouse: Database name - Service azure_sql_data_warehouse: Database name - Service azure_sql_database: Database name - Service azure_sql_managed_db_warehouse: Database name - Service maria_rds_warehouse: Database name - Service maria_warehouse: Database name - Service mysql_rds_warehouse: Database name - Service mysql_warehouse: Database name - Service panoply: Database name - Service periscope_warehouse: Database name - Service postgres_gcp_warehouse: Database name - Service postgres_rds_warehouse: Database name - Service postgres_warehouse: Database name - Service redshift: Database name - Service snowflake: Database name - Service sql_server_rds_warehouse: Database name - Service sql_server_warehouse: Database name
databricksConnectionType String: Field usage depends on service value: - Service adls: Databricks Connection method. Default value: Directly. - Service new_s3_datalake: Databricks Connection method. Default value: Directly. - Service onelake: Databricks Connection method. Default value: Directly.
enableRemoteExecution Boolean
externalId String: Field usage depends on service value: - Service aws_msk_wh: Fivetran generated External ID - Service panoply: Fivetran generated External ID - Service periscope_warehouse: Fivetran generated External ID - Service redshift: Fivetran generated External ID
externalLocation String: Field usage depends on service value: - Service databricks: External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path.
fivetranGlueRoleArn String
fivetranMskRoleArn String
fivetranRoleArn String: Field usage depends on service value: - Service new_s3_datalake: ARN of the role which you created with different required policy mentioned in our setup guide
host String: Field usage depends on service value: - Service aurora_postgres_warehouse: Server name - Service aurora_warehouse: Server name - Service azure_postgres_warehouse: Server name - Service azure_sql_data_warehouse: Server name - Service azure_sql_database: Server name - Service azure_sql_managed_db_warehouse: Server name - Service maria_rds_warehouse: Server name - Service maria_warehouse: Server name - Service mysql_rds_warehouse: Server name - Service mysql_warehouse: Server name - Service panoply: Server name - Service periscope_warehouse: Server name - Service postgres_gcp_warehouse: Server name - Service postgres_rds_warehouse: Server name - Service postgres_warehouse: Server name - Service redshift: Server name - Service snowflake: Server name - Service sql_server_rds_warehouse: Server name - Service sql_server_warehouse: Server name
httpPath String: Field usage depends on service value: - Service adls: HTTP path - Service databricks: HTTP path - Service new_s3_datalake: HTTP path - Service onelake: HTTP path
isPrivateKeyEncrypted Boolean: Field usage depends on service value: - Service snowflake: Indicates that a private key is encrypted. The default value: false. The field can be specified if authentication type is KEY_PAIR.
isPrivateLinkRequired Boolean: Field usage depends on service value: - Service new_s3_datalake: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our PrivateLink documentation.
isRedshiftServerless Boolean: Field usage depends on service value: - Service redshift: Is your destination Redshift Serverless
lakehouseGuid String: Field usage depends on service value: - Service onelake: (Immutable) OneLake lakehouse GUID
lakehouseName String: Field usage depends on service value: - Service onelake: (Immutable) Name of your lakehouse
mskStsRegion String
numOfPartitions Number: Field usage depends on service value: - Service confluent_cloud_wh: Number of partitions per topic.
oauth2ClientId String: Field usage depends on service value: - Service adls: OAuth 2.0 client ID - Service databricks: OAuth 2.0 client ID - Service new_s3_datalake: OAuth 2.0 client ID - Service onelake: OAuth 2.0 client ID
oauth2Secret String: Field usage depends on service value: - Service adls: OAuth 2.0 secret - Service databricks: OAuth 2.0 secret - Service new_s3_datalake: OAuth 2.0 secret - Service onelake: OAuth 2.0 secret
passphrase String: Field usage depends on service value: - Service snowflake: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR.
password String: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user password - Service aurora_warehouse: Database user password - Service azure_postgres_warehouse: Database user password - Service azure_sql_data_warehouse: Database user password - Service azure_sql_database: Database user password - Service azure_sql_managed_db_warehouse: Database user password - Service maria_rds_warehouse: Database user password - Service maria_warehouse: Database user password - Service mysql_rds_warehouse: Database user password - Service mysql_warehouse: Database user password - Service panoply: Database user password - Service periscope_warehouse: Database user password - Service postgres_gcp_warehouse: Database user password - Service postgres_rds_warehouse: Database user password - Service postgres_warehouse: Database user password - Service redshift: Database user password. Required if authentication type is PASSWORD. - Service snowflake: Database user password. The field should be specified if authentication type is PASSWORD. - Service sql_server_rds_warehouse: Database user password - Service sql_server_warehouse: Database user password
personalAccessToken String: Field usage depends on service value: - Service adls: Personal access token - Service databricks: Personal access token - Service new_s3_datalake: Personal access token - Service onelake: Personal access token
port Number: Field usage depends on service value: - Service adls: Server port number - Service aurora_postgres_warehouse: Server port number - Service aurora_warehouse: Server port number - Service azure_postgres_warehouse: Server port number - Service azure_sql_data_warehouse: Server port number - Service azure_sql_database: Server port number - Service azure_sql_managed_db_warehouse: Server port number - Service databricks: Server port number - Service maria_rds_warehouse: Server port number - Service maria_warehouse: Server port number - Service mysql_rds_warehouse: Server port number - Service mysql_warehouse: Server port number - Service new_s3_datalake: Server port number - Service onelake: Server port number - Service panoply: Server port number - Service periscope_warehouse: Server port number - Service postgres_gcp_warehouse: Server port number - Service postgres_rds_warehouse: Server port number - Service postgres_warehouse: Server port number - Service redshift: Server port number - Service snowflake: Server port number - Service sql_server_rds_warehouse: Server port number - Service sql_server_warehouse: Server port number
prefixPath String: Field usage depends on service value: - Service adls: (Immutable) path/to/data within the container - Service new_s3_datalake: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy - Service onelake: (Immutable) path/to/data within your lakehouse inside the Files directory
privateKey String: Field usage depends on service value: - Service snowflake: Private access key. The field should be specified if authentication type is KEY_PAIR.
projectId String: Field usage depends on service value: - Service big_query: BigQuery project ID
publicKey String: Field usage depends on service value: - Service aurora_postgres_warehouse: Public Key - Service aurora_warehouse: Public Key - Service azure_postgres_warehouse: Public Key - Service azure_sql_data_warehouse: Public Key - Service azure_sql_database: Public Key - Service azure_sql_managed_db_warehouse: Public Key - Service maria_rds_warehouse: Public Key - Service maria_warehouse: Public Key - Service mysql_rds_warehouse: Public Key - Service mysql_warehouse: Public Key - Service panoply: Public Key - Service periscope_warehouse: Public Key - Service postgres_gcp_warehouse: Public Key - Service postgres_rds_warehouse: Public Key - Service postgres_warehouse: Public Key - Service redshift: Public Key - Service sql_server_rds_warehouse: Public Key - Service sql_server_warehouse: Public Key
region String: Field usage depends on service value: - Service new_s3_datalake: Region of your AWS S3 bucket
registryName String
registryStsRegion String
replicationFactor Number: Field usage depends on service value: - Service confluent_cloud_wh: Replication factor.
resourceId String: Field usage depends on service value: - Service aurora_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service aurora_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_data_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service azure_sql_database: Field to test Self serve Private Link - Service azure_sql_managed_db_warehouse: Field to test Self serve Private Link - Service databricks: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service maria_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service mysql_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service panoply: This field is currently being introduced to test the Self-serve Private Link functionality - Service periscope_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_gcp_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_rds_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service postgres_warehouse: This field is currently being introduced to test the Self-serve Private Link functionality - Service redshift: This field is currently being introduced to test the Self-serve Private Link functionality - Service snowflake: This field is currently being introduced to test the Self-serve Private Link functionality - Service sql_server_rds_warehouse: Field to test Self serve Private Link - Service sql_server_warehouse: Field to test Self serve Private Link
role String: Field usage depends on service value: - Service snowflake: If not specified, Fivetran will use the user's default role
roleArn String: Field usage depends on service value: - Service redshift: Role ARN with Redshift permissions. Required if authentication type is IAM.
saslMechanism String: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
saslPlainKey String: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL key.
saslPlainSecret String: Field usage depends on service value: - Service confluent_cloud_wh: Confluent Cloud SASL secret.
schemaCompatibility String
schemaRegistry String: Field usage depends on service value: - Service confluent_cloud_wh: Schema Registry
schemaRegistryApiKey String: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API key.
schemaRegistryApiSecret String: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry API secret.
schemaRegistryUrl String: Field usage depends on service value: - Service confluent_cloud_wh: Schema registry URL.
secretKey String: Field usage depends on service value: - Service big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service big_query_dts: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. - Service managed_big_query: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
secretValue String: Field usage depends on service value: - Service adls: Secret value for service principal - Service onelake: Secret value for service principal
securityProtocol String: Field usage depends on service value: - Service confluent_cloud_wh: Security protocol for Confluent Cloud interaction.
serverHostName String: Field usage depends on service value: - Service adls: Server Host name - Service databricks: Server name - Service new_s3_datalake: Server host name - Service onelake: Server Host name
shouldMaintainTablesInDatabricks Boolean: Field usage depends on service value: - Service adls: Should maintain tables in Databricks - Service new_s3_datalake: Should maintain tables in Databricks - Service onelake: Should maintain tables in Databricks
snapshotRetentionPeriod String: Field usage depends on service value: - Service adls: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service new_s3_datalake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK. - Service onelake: Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
snowflakeCloud String
snowflakeRegion String
storageAccountName String: Field usage depends on service value: - Service adls: (Immutable) Storage account for Azure Data Lake Storage Gen2 name - Service onelake: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
tableFormat String: Field usage depends on service value: - Service new_s3_datalake: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
tenantId String: Field usage depends on service value: - Service adls: Tenant id of service principal - Service onelake: Tenant ID of service principal
tunnelHost String: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server name. Must be populated if connection_type is set to SshTunnel.
tunnelPort Number: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH server port name. Must be populated if connection_type is set to SshTunnel.
tunnelUser String: Field usage depends on service value: - Service aurora_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service aurora_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_data_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_database: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service azure_sql_managed_db_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service maria_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service mysql_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service panoply: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service periscope_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_gcp_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service postgres_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service redshift: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_rds_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel. - Service sql_server_warehouse: SSH user name. Must be populated if connection_type is set to SshTunnel.
user String: Field usage depends on service value: - Service aurora_postgres_warehouse: Database user name - Service aurora_warehouse: Database user name - Service azure_postgres_warehouse: Database user name - Service azure_sql_data_warehouse: Database user name - Service azure_sql_database: Database user name - Service azure_sql_managed_db_warehouse: Database user name - Service maria_rds_warehouse: Database user name - Service maria_warehouse: Database user name - Service mysql_rds_warehouse: Database user name - Service mysql_warehouse: Database user name - Service panoply: Database user name - Service periscope_warehouse: Database user name - Service postgres_gcp_warehouse: Database user name - Service postgres_rds_warehouse: Database user name - Service postgres_warehouse: Database user name - Service redshift: Database user name - Service snowflake: Database user name - Service sql_server_rds_warehouse: Database user name - Service sql_server_warehouse: Database user name
workspaceGuid String: Field usage depends on service value: - Service onelake: (Immutable) OneLake workspace GUID
workspaceName String: Field usage depends on service value: - Service onelake: OneLake workspace name

Package Details

Repository: fivetran fivetran/terraform-provider-fivetran
License
Notes: This Pulumi package is based on the fivetran Terraform Provider.

fivetran 1.6.1 published on Monday, Mar 31, 2025 by fivetran

fivetran/terraform-provider-fivetran

fivetran.getDestination

On this page

On this page

Example Usage

Using getDestination

getDestination Result

Supporting Types

GetDestinationConfig

Package Details

On this page

On this page