Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. Destination
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.Destination

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

    Import

    1. To import an existing fivetran_destination resource into your Terraform state, you need to get Destination Group ID on the destination page in your Fivetran dashboard.

    To retrieve existing groups, use the fivetran_groups data source.

    1. Define an empty resource in your .tf configuration:

    hcl

    resource “fivetran_destination” “my_imported_destination” {

    }

    1. Run the pulumi import command with the following parameters:
    $ pulumi import fivetran:index/destination:Destination my_imported_destination {your Destination Group ID}
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_destination.my_imported_destination’

    1. Copy the values and paste them to your .tf configuration.

    -> The config object in the state contains all properties defined in the schema. You need to remove properties from the config that are not related to destinations. See the Fivetran REST API documentation for reference to find the properties you need to keep in the config section.

    Create Destination Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Destination(name: string, args: DestinationArgs, opts?: CustomResourceOptions);
    @overload
def Destination(resource_name: str,
                args: DestinationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Destination(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                time_zone_offset: Optional[str] = None,
                group_id: Optional[str] = None,
                region: Optional[str] = None,
                service: Optional[str] = None,
                daylight_saving_time_enabled: Optional[bool] = None,
                hybrid_deployment_agent_id: Optional[str] = None,
                networking_method: Optional[str] = None,
                private_link_id: Optional[str] = None,
                run_setup_tests: Optional[bool] = None,
                config: Optional[DestinationConfigArgs] = None,
                timeouts: Optional[DestinationTimeoutsArgs] = None,
                trust_certificates: Optional[bool] = None,
                trust_fingerprints: Optional[bool] = None)
    func NewDestination(ctx *Context, name string, args DestinationArgs, opts ...ResourceOption) (*Destination, error)
    public Destination(string name, DestinationArgs args, CustomResourceOptions? opts = null)
    public Destination(String name, DestinationArgs args)
public Destination(String name, DestinationArgs args, CustomResourceOptions options)

    type: fivetran:Destination
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DestinationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DestinationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var destinationResource = new Fivetran.Destination("destinationResource", new()
{
    TimeZoneOffset = "string",
    GroupId = "string",
    Region = "string",
    Service = "string",
    DaylightSavingTimeEnabled = false,
    HybridDeploymentAgentId = "string",
    NetworkingMethod = "string",
    PrivateLinkId = "string",
    RunSetupTests = false,
    Config = new Fivetran.Inputs.DestinationConfigArgs
    {
        AlwaysEncrypted = false,
        Auth = "string",
        AuthType = "string",
        AwsAccessKeyId = "string",
        AwsSecretAccessKey = "string",
        BootstrapServers = new[]
        {
            "string",
        },
        Bucket = "string",
        Catalog = "string",
        ClientId = "string",
        CloudProvider = "string",
        ClusterId = "string",
        ClusterRegion = "string",
        ConnectionMethod = "string",
        ConnectionType = "string",
        ContainerName = "string",
        ControllerId = "string",
        CreateExternalTables = false,
        DataFormat = "string",
        DataSetLocation = "string",
        Database = "string",
        DatabricksConnectionType = "string",
        EnableRemoteExecution = false,
        ExternalId = "string",
        ExternalLocation = "string",
        FivetranGlueRoleArn = "string",
        FivetranMskRoleArn = "string",
        FivetranRoleArn = "string",
        Host = "string",
        HttpPath = "string",
        IsPrivateKeyEncrypted = false,
        IsPrivateLinkRequired = false,
        IsRedshiftServerless = false,
        LakehouseGuid = "string",
        LakehouseName = "string",
        MskStsRegion = "string",
        NumOfPartitions = 0,
        Oauth2ClientId = "string",
        Oauth2Secret = "string",
        Passphrase = "string",
        Password = "string",
        PersonalAccessToken = "string",
        Port = 0,
        PrefixPath = "string",
        PrivateKey = "string",
        ProjectId = "string",
        PublicKey = "string",
        Region = "string",
        RegistryName = "string",
        RegistryStsRegion = "string",
        ReplicationFactor = 0,
        ResourceId = "string",
        Role = "string",
        RoleArn = "string",
        SaslMechanism = "string",
        SaslPlainKey = "string",
        SaslPlainSecret = "string",
        SchemaCompatibility = "string",
        SchemaRegistry = "string",
        SchemaRegistryApiKey = "string",
        SchemaRegistryApiSecret = "string",
        SchemaRegistryUrl = "string",
        SecretKey = "string",
        SecretValue = "string",
        SecurityProtocol = "string",
        ServerHostName = "string",
        ShouldMaintainTablesInDatabricks = false,
        SnapshotRetentionPeriod = "string",
        SnowflakeCloud = "string",
        SnowflakeRegion = "string",
        StorageAccountName = "string",
        TableFormat = "string",
        TenantId = "string",
        TunnelHost = "string",
        TunnelPort = 0,
        TunnelUser = "string",
        User = "string",
        WorkspaceGuid = "string",
        WorkspaceName = "string",
    },
    Timeouts = new Fivetran.Inputs.DestinationTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
    TrustCertificates = false,
    TrustFingerprints = false,
});

    example, err := fivetran.NewDestination(ctx, "destinationResource", &fivetran.DestinationArgs{
TimeZoneOffset: pulumi.String("string"),
GroupId: pulumi.String("string"),
Region: pulumi.String("string"),
Service: pulumi.String("string"),
DaylightSavingTimeEnabled: pulumi.Bool(false),
HybridDeploymentAgentId: pulumi.String("string"),
NetworkingMethod: pulumi.String("string"),
PrivateLinkId: pulumi.String("string"),
RunSetupTests: pulumi.Bool(false),
Config: &.DestinationConfigArgs{
AlwaysEncrypted: pulumi.Bool(false),
Auth: pulumi.String("string"),
AuthType: pulumi.String("string"),
AwsAccessKeyId: pulumi.String("string"),
AwsSecretAccessKey: pulumi.String("string"),
BootstrapServers: pulumi.StringArray{
pulumi.String("string"),
},
Bucket: pulumi.String("string"),
Catalog: pulumi.String("string"),
ClientId: pulumi.String("string"),
CloudProvider: pulumi.String("string"),
ClusterId: pulumi.String("string"),
ClusterRegion: pulumi.String("string"),
ConnectionMethod: pulumi.String("string"),
ConnectionType: pulumi.String("string"),
ContainerName: pulumi.String("string"),
ControllerId: pulumi.String("string"),
CreateExternalTables: pulumi.Bool(false),
DataFormat: pulumi.String("string"),
DataSetLocation: pulumi.String("string"),
Database: pulumi.String("string"),
DatabricksConnectionType: pulumi.String("string"),
EnableRemoteExecution: pulumi.Bool(false),
ExternalId: pulumi.String("string"),
ExternalLocation: pulumi.String("string"),
FivetranGlueRoleArn: pulumi.String("string"),
FivetranMskRoleArn: pulumi.String("string"),
FivetranRoleArn: pulumi.String("string"),
Host: pulumi.String("string"),
HttpPath: pulumi.String("string"),
IsPrivateKeyEncrypted: pulumi.Bool(false),
IsPrivateLinkRequired: pulumi.Bool(false),
IsRedshiftServerless: pulumi.Bool(false),
LakehouseGuid: pulumi.String("string"),
LakehouseName: pulumi.String("string"),
MskStsRegion: pulumi.String("string"),
NumOfPartitions: pulumi.Float64(0),
Oauth2ClientId: pulumi.String("string"),
Oauth2Secret: pulumi.String("string"),
Passphrase: pulumi.String("string"),
Password: pulumi.String("string"),
PersonalAccessToken: pulumi.String("string"),
Port: pulumi.Float64(0),
PrefixPath: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
ProjectId: pulumi.String("string"),
PublicKey: pulumi.String("string"),
Region: pulumi.String("string"),
RegistryName: pulumi.String("string"),
RegistryStsRegion: pulumi.String("string"),
ReplicationFactor: pulumi.Float64(0),
ResourceId: pulumi.String("string"),
Role: pulumi.String("string"),
RoleArn: pulumi.String("string"),
SaslMechanism: pulumi.String("string"),
SaslPlainKey: pulumi.String("string"),
SaslPlainSecret: pulumi.String("string"),
SchemaCompatibility: pulumi.String("string"),
SchemaRegistry: pulumi.String("string"),
SchemaRegistryApiKey: pulumi.String("string"),
SchemaRegistryApiSecret: pulumi.String("string"),
SchemaRegistryUrl: pulumi.String("string"),
SecretKey: pulumi.String("string"),
SecretValue: pulumi.String("string"),
SecurityProtocol: pulumi.String("string"),
ServerHostName: pulumi.String("string"),
ShouldMaintainTablesInDatabricks: pulumi.Bool(false),
SnapshotRetentionPeriod: pulumi.String("string"),
SnowflakeCloud: pulumi.String("string"),
SnowflakeRegion: pulumi.String("string"),
StorageAccountName: pulumi.String("string"),
TableFormat: pulumi.String("string"),
TenantId: pulumi.String("string"),
TunnelHost: pulumi.String("string"),
TunnelPort: pulumi.Float64(0),
TunnelUser: pulumi.String("string"),
User: pulumi.String("string"),
WorkspaceGuid: pulumi.String("string"),
WorkspaceName: pulumi.String("string"),
},
Timeouts: &.DestinationTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
TrustCertificates: pulumi.Bool(false),
TrustFingerprints: pulumi.Bool(false),
})

    var destinationResource = new Destination("destinationResource", DestinationArgs.builder()
    .timeZoneOffset("string")
    .groupId("string")
    .region("string")
    .service("string")
    .daylightSavingTimeEnabled(false)
    .hybridDeploymentAgentId("string")
    .networkingMethod("string")
    .privateLinkId("string")
    .runSetupTests(false)
    .config(DestinationConfigArgs.builder()
        .alwaysEncrypted(false)
        .auth("string")
        .authType("string")
        .awsAccessKeyId("string")
        .awsSecretAccessKey("string")
        .bootstrapServers("string")
        .bucket("string")
        .catalog("string")
        .clientId("string")
        .cloudProvider("string")
        .clusterId("string")
        .clusterRegion("string")
        .connectionMethod("string")
        .connectionType("string")
        .containerName("string")
        .controllerId("string")
        .createExternalTables(false)
        .dataFormat("string")
        .dataSetLocation("string")
        .database("string")
        .databricksConnectionType("string")
        .enableRemoteExecution(false)
        .externalId("string")
        .externalLocation("string")
        .fivetranGlueRoleArn("string")
        .fivetranMskRoleArn("string")
        .fivetranRoleArn("string")
        .host("string")
        .httpPath("string")
        .isPrivateKeyEncrypted(false)
        .isPrivateLinkRequired(false)
        .isRedshiftServerless(false)
        .lakehouseGuid("string")
        .lakehouseName("string")
        .mskStsRegion("string")
        .numOfPartitions(0)
        .oauth2ClientId("string")
        .oauth2Secret("string")
        .passphrase("string")
        .password("string")
        .personalAccessToken("string")
        .port(0)
        .prefixPath("string")
        .privateKey("string")
        .projectId("string")
        .publicKey("string")
        .region("string")
        .registryName("string")
        .registryStsRegion("string")
        .replicationFactor(0)
        .resourceId("string")
        .role("string")
        .roleArn("string")
        .saslMechanism("string")
        .saslPlainKey("string")
        .saslPlainSecret("string")
        .schemaCompatibility("string")
        .schemaRegistry("string")
        .schemaRegistryApiKey("string")
        .schemaRegistryApiSecret("string")
        .schemaRegistryUrl("string")
        .secretKey("string")
        .secretValue("string")
        .securityProtocol("string")
        .serverHostName("string")
        .shouldMaintainTablesInDatabricks(false)
        .snapshotRetentionPeriod("string")
        .snowflakeCloud("string")
        .snowflakeRegion("string")
        .storageAccountName("string")
        .tableFormat("string")
        .tenantId("string")
        .tunnelHost("string")
        .tunnelPort(0)
        .tunnelUser("string")
        .user("string")
        .workspaceGuid("string")
        .workspaceName("string")
        .build())
    .timeouts(DestinationTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .trustCertificates(false)
    .trustFingerprints(false)
    .build());

    destination_resource = fivetran.Destination("destinationResource",
    time_zone_offset="string",
    group_id="string",
    region="string",
    service="string",
    daylight_saving_time_enabled=False,
    hybrid_deployment_agent_id="string",
    networking_method="string",
    private_link_id="string",
    run_setup_tests=False,
    config={
        "always_encrypted": False,
        "auth": "string",
        "auth_type": "string",
        "aws_access_key_id": "string",
        "aws_secret_access_key": "string",
        "bootstrap_servers": ["string"],
        "bucket": "string",
        "catalog": "string",
        "client_id": "string",
        "cloud_provider": "string",
        "cluster_id": "string",
        "cluster_region": "string",
        "connection_method": "string",
        "connection_type": "string",
        "container_name": "string",
        "controller_id": "string",
        "create_external_tables": False,
        "data_format": "string",
        "data_set_location": "string",
        "database": "string",
        "databricks_connection_type": "string",
        "enable_remote_execution": False,
        "external_id": "string",
        "external_location": "string",
        "fivetran_glue_role_arn": "string",
        "fivetran_msk_role_arn": "string",
        "fivetran_role_arn": "string",
        "host": "string",
        "http_path": "string",
        "is_private_key_encrypted": False,
        "is_private_link_required": False,
        "is_redshift_serverless": False,
        "lakehouse_guid": "string",
        "lakehouse_name": "string",
        "msk_sts_region": "string",
        "num_of_partitions": 0,
        "oauth2_client_id": "string",
        "oauth2_secret": "string",
        "passphrase": "string",
        "password": "string",
        "personal_access_token": "string",
        "port": 0,
        "prefix_path": "string",
        "private_key": "string",
        "project_id": "string",
        "public_key": "string",
        "region": "string",
        "registry_name": "string",
        "registry_sts_region": "string",
        "replication_factor": 0,
        "resource_id": "string",
        "role": "string",
        "role_arn": "string",
        "sasl_mechanism": "string",
        "sasl_plain_key": "string",
        "sasl_plain_secret": "string",
        "schema_compatibility": "string",
        "schema_registry": "string",
        "schema_registry_api_key": "string",
        "schema_registry_api_secret": "string",
        "schema_registry_url": "string",
        "secret_key": "string",
        "secret_value": "string",
        "security_protocol": "string",
        "server_host_name": "string",
        "should_maintain_tables_in_databricks": False,
        "snapshot_retention_period": "string",
        "snowflake_cloud": "string",
        "snowflake_region": "string",
        "storage_account_name": "string",
        "table_format": "string",
        "tenant_id": "string",
        "tunnel_host": "string",
        "tunnel_port": 0,
        "tunnel_user": "string",
        "user": "string",
        "workspace_guid": "string",
        "workspace_name": "string",
    },
    timeouts={
        "create": "string",
        "update": "string",
    },
    trust_certificates=False,
    trust_fingerprints=False)

    const destinationResource = new fivetran.Destination("destinationResource", {
    timeZoneOffset: "string",
    groupId: "string",
    region: "string",
    service: "string",
    daylightSavingTimeEnabled: false,
    hybridDeploymentAgentId: "string",
    networkingMethod: "string",
    privateLinkId: "string",
    runSetupTests: false,
    config: {
        alwaysEncrypted: false,
        auth: "string",
        authType: "string",
        awsAccessKeyId: "string",
        awsSecretAccessKey: "string",
        bootstrapServers: ["string"],
        bucket: "string",
        catalog: "string",
        clientId: "string",
        cloudProvider: "string",
        clusterId: "string",
        clusterRegion: "string",
        connectionMethod: "string",
        connectionType: "string",
        containerName: "string",
        controllerId: "string",
        createExternalTables: false,
        dataFormat: "string",
        dataSetLocation: "string",
        database: "string",
        databricksConnectionType: "string",
        enableRemoteExecution: false,
        externalId: "string",
        externalLocation: "string",
        fivetranGlueRoleArn: "string",
        fivetranMskRoleArn: "string",
        fivetranRoleArn: "string",
        host: "string",
        httpPath: "string",
        isPrivateKeyEncrypted: false,
        isPrivateLinkRequired: false,
        isRedshiftServerless: false,
        lakehouseGuid: "string",
        lakehouseName: "string",
        mskStsRegion: "string",
        numOfPartitions: 0,
        oauth2ClientId: "string",
        oauth2Secret: "string",
        passphrase: "string",
        password: "string",
        personalAccessToken: "string",
        port: 0,
        prefixPath: "string",
        privateKey: "string",
        projectId: "string",
        publicKey: "string",
        region: "string",
        registryName: "string",
        registryStsRegion: "string",
        replicationFactor: 0,
        resourceId: "string",
        role: "string",
        roleArn: "string",
        saslMechanism: "string",
        saslPlainKey: "string",
        saslPlainSecret: "string",
        schemaCompatibility: "string",
        schemaRegistry: "string",
        schemaRegistryApiKey: "string",
        schemaRegistryApiSecret: "string",
        schemaRegistryUrl: "string",
        secretKey: "string",
        secretValue: "string",
        securityProtocol: "string",
        serverHostName: "string",
        shouldMaintainTablesInDatabricks: false,
        snapshotRetentionPeriod: "string",
        snowflakeCloud: "string",
        snowflakeRegion: "string",
        storageAccountName: "string",
        tableFormat: "string",
        tenantId: "string",
        tunnelHost: "string",
        tunnelPort: 0,
        tunnelUser: "string",
        user: "string",
        workspaceGuid: "string",
        workspaceName: "string",
    },
    timeouts: {
        create: "string",
        update: "string",
    },
    trustCertificates: false,
    trustFingerprints: false,
});

    type: fivetran:Destination
properties:
    config:
        alwaysEncrypted: false
        auth: string
        authType: string
        awsAccessKeyId: string
        awsSecretAccessKey: string
        bootstrapServers:
            - string
        bucket: string
        catalog: string
        clientId: string
        cloudProvider: string
        clusterId: string
        clusterRegion: string
        connectionMethod: string
        connectionType: string
        containerName: string
        controllerId: string
        createExternalTables: false
        dataFormat: string
        dataSetLocation: string
        database: string
        databricksConnectionType: string
        enableRemoteExecution: false
        externalId: string
        externalLocation: string
        fivetranGlueRoleArn: string
        fivetranMskRoleArn: string
        fivetranRoleArn: string
        host: string
        httpPath: string
        isPrivateKeyEncrypted: false
        isPrivateLinkRequired: false
        isRedshiftServerless: false
        lakehouseGuid: string
        lakehouseName: string
        mskStsRegion: string
        numOfPartitions: 0
        oauth2ClientId: string
        oauth2Secret: string
        passphrase: string
        password: string
        personalAccessToken: string
        port: 0
        prefixPath: string
        privateKey: string
        projectId: string
        publicKey: string
        region: string
        registryName: string
        registryStsRegion: string
        replicationFactor: 0
        resourceId: string
        role: string
        roleArn: string
        saslMechanism: string
        saslPlainKey: string
        saslPlainSecret: string
        schemaCompatibility: string
        schemaRegistry: string
        schemaRegistryApiKey: string
        schemaRegistryApiSecret: string
        schemaRegistryUrl: string
        secretKey: string
        secretValue: string
        securityProtocol: string
        serverHostName: string
        shouldMaintainTablesInDatabricks: false
        snapshotRetentionPeriod: string
        snowflakeCloud: string
        snowflakeRegion: string
        storageAccountName: string
        tableFormat: string
        tenantId: string
        tunnelHost: string
        tunnelPort: 0
        tunnelUser: string
        user: string
        workspaceGuid: string
        workspaceName: string
    daylightSavingTimeEnabled: false
    groupId: string
    hybridDeploymentAgentId: string
    networkingMethod: string
    privateLinkId: string
    region: string
    runSetupTests: false
    service: string
    timeZoneOffset: string
    timeouts:
        create: string
        update: string
    trustCertificates: false
    trustFingerprints: false

    Destination Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Destination resource accepts the following input properties:

    GroupId string
    The unique identifier for the Group within the Fivetran system.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    The destination type id within the Fivetran system.
    TimeZoneOffset string
    Determines the time zone for the Fivetran sync schedule.
    Config DestinationConfig
    DaylightSavingTimeEnabled bool
    Shift my UTC offset with daylight savings time (US Only)
    HybridDeploymentAgentId string
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    NetworkingMethod string
    Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The private link ID.
    RunSetupTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    Timeouts DestinationTimeouts
    TrustCertificates bool
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    TrustFingerprints bool
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    The destination type id within the Fivetran system.
    TimeZoneOffset string
    Determines the time zone for the Fivetran sync schedule.
    Config DestinationConfigArgs
    DaylightSavingTimeEnabled bool
    Shift my UTC offset with daylight savings time (US Only)
    HybridDeploymentAgentId string
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    NetworkingMethod string
    Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The private link ID.
    RunSetupTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    Timeouts DestinationTimeoutsArgs
    TrustCertificates bool
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    TrustFingerprints bool
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    groupId String
    The unique identifier for the Group within the Fivetran system.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    The destination type id within the Fivetran system.
    timeZoneOffset String
    Determines the time zone for the Fivetran sync schedule.
    config DestinationConfig
    daylightSavingTimeEnabled Boolean
    Shift my UTC offset with daylight savings time (US Only)
    hybridDeploymentAgentId String
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networkingMethod String
    Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The private link ID.
    runSetupTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    timeouts DestinationTimeouts
    trustCertificates Boolean
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trustFingerprints Boolean
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    groupId string
    The unique identifier for the Group within the Fivetran system.
    region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    service string
    The destination type id within the Fivetran system.
    timeZoneOffset string
    Determines the time zone for the Fivetran sync schedule.
    config DestinationConfig
    daylightSavingTimeEnabled boolean
    Shift my UTC offset with daylight savings time (US Only)
    hybridDeploymentAgentId string
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networkingMethod string
    Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId string
    The private link ID.
    runSetupTests boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    timeouts DestinationTimeouts
    trustCertificates boolean
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trustFingerprints boolean
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    group_id str
    The unique identifier for the Group within the Fivetran system.
    region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    service str
    The destination type id within the Fivetran system.
    time_zone_offset str
    Determines the time zone for the Fivetran sync schedule.
    config DestinationConfigArgs
    daylight_saving_time_enabled bool
    Shift my UTC offset with daylight savings time (US Only)
    hybrid_deployment_agent_id str
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networking_method str
    Possible values: Directly, SshTunnel, ProxyAgent.
    private_link_id str
    The private link ID.
    run_setup_tests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    timeouts DestinationTimeoutsArgs
    trust_certificates bool
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trust_fingerprints bool
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    groupId String
    The unique identifier for the Group within the Fivetran system.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    The destination type id within the Fivetran system.
    timeZoneOffset String
    Determines the time zone for the Fivetran sync schedule.
    config Property Map
    daylightSavingTimeEnabled Boolean
    Shift my UTC offset with daylight savings time (US Only)
    hybridDeploymentAgentId String
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networkingMethod String
    Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The private link ID.
    runSetupTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    timeouts Property Map
    trustCertificates Boolean
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trustFingerprints Boolean
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Destination resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    SetupStatus string
    Destination setup status.
    Id string
    The provider-assigned unique ID for this managed resource.
    SetupStatus string
    Destination setup status.
    id String
    The provider-assigned unique ID for this managed resource.
    setupStatus String
    Destination setup status.
    id string
    The provider-assigned unique ID for this managed resource.
    setupStatus string
    Destination setup status.
    id str
    The provider-assigned unique ID for this managed resource.
    setup_status str
    Destination setup status.
    id String
    The provider-assigned unique ID for this managed resource.
    setupStatus String
    Destination setup status.

    Look up Existing Destination Resource

    Get an existing Destination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DestinationState, opts?: CustomResourceOptions): Destination
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[DestinationConfigArgs] = None,
        daylight_saving_time_enabled: Optional[bool] = None,
        group_id: Optional[str] = None,
        hybrid_deployment_agent_id: Optional[str] = None,
        networking_method: Optional[str] = None,
        private_link_id: Optional[str] = None,
        region: Optional[str] = None,
        run_setup_tests: Optional[bool] = None,
        service: Optional[str] = None,
        setup_status: Optional[str] = None,
        time_zone_offset: Optional[str] = None,
        timeouts: Optional[DestinationTimeoutsArgs] = None,
        trust_certificates: Optional[bool] = None,
        trust_fingerprints: Optional[bool] = None) -> Destination
    func GetDestination(ctx *Context, name string, id IDInput, state *DestinationState, opts ...ResourceOption) (*Destination, error)
    public static Destination Get(string name, Input<string> id, DestinationState? state, CustomResourceOptions? opts = null)
    public static Destination get(String name, Output<String> id, DestinationState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:Destination    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Config DestinationConfig
    DaylightSavingTimeEnabled bool
    Shift my UTC offset with daylight savings time (US Only)
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    HybridDeploymentAgentId string
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    NetworkingMethod string
    Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The private link ID.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    RunSetupTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    Service string
    The destination type id within the Fivetran system.
    SetupStatus string
    Destination setup status.
    TimeZoneOffset string
    Determines the time zone for the Fivetran sync schedule.
    Timeouts DestinationTimeouts
    TrustCertificates bool
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    TrustFingerprints bool
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    Config DestinationConfigArgs
    DaylightSavingTimeEnabled bool
    Shift my UTC offset with daylight savings time (US Only)
    GroupId string
    The unique identifier for the Group within the Fivetran system.
    HybridDeploymentAgentId string
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    NetworkingMethod string
    Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The private link ID.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    RunSetupTests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    Service string
    The destination type id within the Fivetran system.
    SetupStatus string
    Destination setup status.
    TimeZoneOffset string
    Determines the time zone for the Fivetran sync schedule.
    Timeouts DestinationTimeoutsArgs
    TrustCertificates bool
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    TrustFingerprints bool
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    config DestinationConfig
    daylightSavingTimeEnabled Boolean
    Shift my UTC offset with daylight savings time (US Only)
    groupId String
    The unique identifier for the Group within the Fivetran system.
    hybridDeploymentAgentId String
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networkingMethod String
    Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The private link ID.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    runSetupTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    service String
    The destination type id within the Fivetran system.
    setupStatus String
    Destination setup status.
    timeZoneOffset String
    Determines the time zone for the Fivetran sync schedule.
    timeouts DestinationTimeouts
    trustCertificates Boolean
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trustFingerprints Boolean
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    config DestinationConfig
    daylightSavingTimeEnabled boolean
    Shift my UTC offset with daylight savings time (US Only)
    groupId string
    The unique identifier for the Group within the Fivetran system.
    hybridDeploymentAgentId string
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networkingMethod string
    Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId string
    The private link ID.
    region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    runSetupTests boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    service string
    The destination type id within the Fivetran system.
    setupStatus string
    Destination setup status.
    timeZoneOffset string
    Determines the time zone for the Fivetran sync schedule.
    timeouts DestinationTimeouts
    trustCertificates boolean
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trustFingerprints boolean
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    config DestinationConfigArgs
    daylight_saving_time_enabled bool
    Shift my UTC offset with daylight savings time (US Only)
    group_id str
    The unique identifier for the Group within the Fivetran system.
    hybrid_deployment_agent_id str
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networking_method str
    Possible values: Directly, SshTunnel, ProxyAgent.
    private_link_id str
    The private link ID.
    region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    run_setup_tests bool
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    service str
    The destination type id within the Fivetran system.
    setup_status str
    Destination setup status.
    time_zone_offset str
    Determines the time zone for the Fivetran sync schedule.
    timeouts DestinationTimeoutsArgs
    trust_certificates bool
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trust_fingerprints bool
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
    config Property Map
    daylightSavingTimeEnabled Boolean
    Shift my UTC offset with daylight savings time (US Only)
    groupId String
    The unique identifier for the Group within the Fivetran system.
    hybridDeploymentAgentId String
    The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
    networkingMethod String
    Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The private link ID.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    runSetupTests Boolean
    Specifies whether the setup tests should be run automatically. The default value is TRUE.
    service String
    The destination type id within the Fivetran system.
    setupStatus String
    Destination setup status.
    timeZoneOffset String
    Determines the time zone for the Fivetran sync schedule.
    timeouts Property Map
    trustCertificates Boolean
    Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
    trustFingerprints Boolean
    Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.

    Supporting Types

    DestinationConfig, DestinationConfigArgs

    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

    DestinationTimeouts, DestinationTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
    fivetran/terraform-provider-fivetran