1. Packages
  2. Fivetran Provider
  3. API Docs
  4. Connection
fivetran 1.9.22 published on Thursday, Jan 29, 2026 by fivetran
fivetran logo
fivetran 1.9.22 published on Thursday, Jan 29, 2026 by fivetran

    Import

    Connections can be imported using the connection ID:

    $ pulumi import fivetran:index/connection:Connection example connection_id_here
    

    Create Connection Resource

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

    Constructor syntax

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def Connection(resource_name: str,
                   args: ConnectionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   group_id: Optional[str] = None,
                   service: Optional[str] = None,
                   networking_method: Optional[str] = None,
                   destination_schema: Optional[ConnectionDestinationSchemaArgs] = None,
                   data_delay_threshold: Optional[float] = None,
                   hybrid_deployment_agent_id: Optional[str] = None,
                   config: Optional[str] = None,
                   private_link_id: Optional[str] = None,
                   proxy_agent_id: Optional[str] = None,
                   run_setup_tests: Optional[bool] = None,
                   data_delay_sensitivity: Optional[str] = None,
                   trust_certificates: Optional[bool] = None,
                   trust_fingerprints: Optional[bool] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
    public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
    
    type: fivetran:Connection
    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 ConnectionArgs
    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 ConnectionArgs
    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 ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    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 connectionResource = new Fivetran.Connection("connectionResource", new()
    {
        GroupId = "string",
        Service = "string",
        NetworkingMethod = "string",
        DestinationSchema = new Fivetran.Inputs.ConnectionDestinationSchemaArgs
        {
            Name = "string",
            Prefix = "string",
            Table = "string",
            TableGroupName = "string",
        },
        DataDelayThreshold = 0,
        HybridDeploymentAgentId = "string",
        Config = "string",
        PrivateLinkId = "string",
        ProxyAgentId = "string",
        RunSetupTests = false,
        DataDelaySensitivity = "string",
        TrustCertificates = false,
        TrustFingerprints = false,
    });
    
    example, err := fivetran.NewConnection(ctx, "connectionResource", &fivetran.ConnectionArgs{
    	GroupId:          pulumi.String("string"),
    	Service:          pulumi.String("string"),
    	NetworkingMethod: pulumi.String("string"),
    	DestinationSchema: &fivetran.ConnectionDestinationSchemaArgs{
    		Name:           pulumi.String("string"),
    		Prefix:         pulumi.String("string"),
    		Table:          pulumi.String("string"),
    		TableGroupName: pulumi.String("string"),
    	},
    	DataDelayThreshold:      pulumi.Float64(0),
    	HybridDeploymentAgentId: pulumi.String("string"),
    	Config:                  pulumi.String("string"),
    	PrivateLinkId:           pulumi.String("string"),
    	ProxyAgentId:            pulumi.String("string"),
    	RunSetupTests:           pulumi.Bool(false),
    	DataDelaySensitivity:    pulumi.String("string"),
    	TrustCertificates:       pulumi.Bool(false),
    	TrustFingerprints:       pulumi.Bool(false),
    })
    
    var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
        .groupId("string")
        .service("string")
        .networkingMethod("string")
        .destinationSchema(ConnectionDestinationSchemaArgs.builder()
            .name("string")
            .prefix("string")
            .table("string")
            .tableGroupName("string")
            .build())
        .dataDelayThreshold(0.0)
        .hybridDeploymentAgentId("string")
        .config("string")
        .privateLinkId("string")
        .proxyAgentId("string")
        .runSetupTests(false)
        .dataDelaySensitivity("string")
        .trustCertificates(false)
        .trustFingerprints(false)
        .build());
    
    connection_resource = fivetran.Connection("connectionResource",
        group_id="string",
        service="string",
        networking_method="string",
        destination_schema={
            "name": "string",
            "prefix": "string",
            "table": "string",
            "table_group_name": "string",
        },
        data_delay_threshold=0,
        hybrid_deployment_agent_id="string",
        config="string",
        private_link_id="string",
        proxy_agent_id="string",
        run_setup_tests=False,
        data_delay_sensitivity="string",
        trust_certificates=False,
        trust_fingerprints=False)
    
    const connectionResource = new fivetran.Connection("connectionResource", {
        groupId: "string",
        service: "string",
        networkingMethod: "string",
        destinationSchema: {
            name: "string",
            prefix: "string",
            table: "string",
            tableGroupName: "string",
        },
        dataDelayThreshold: 0,
        hybridDeploymentAgentId: "string",
        config: "string",
        privateLinkId: "string",
        proxyAgentId: "string",
        runSetupTests: false,
        dataDelaySensitivity: "string",
        trustCertificates: false,
        trustFingerprints: false,
    });
    
    type: fivetran:Connection
    properties:
        config: string
        dataDelaySensitivity: string
        dataDelayThreshold: 0
        destinationSchema:
            name: string
            prefix: string
            table: string
            tableGroupName: string
        groupId: string
        hybridDeploymentAgentId: string
        networkingMethod: string
        privateLinkId: string
        proxyAgentId: string
        runSetupTests: false
        service: string
        trustCertificates: false
        trustFingerprints: false
    

    Connection 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 Connection resource accepts the following input properties:

    GroupId string
    The unique identifier for the destination group.
    Service string
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    Config string
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    DataDelaySensitivity string
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    DataDelayThreshold double
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    DestinationSchema ConnectionDestinationSchema
    Configuration for the destination schema. See destination_schema below.
    HybridDeploymentAgentId string
    The ID of the hybrid deployment agent.
    NetworkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The ID of the private link configuration.
    ProxyAgentId string
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    RunSetupTests bool
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    TrustCertificates bool
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    TrustFingerprints bool
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    GroupId string
    The unique identifier for the destination group.
    Service string
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    Config string
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    DataDelaySensitivity string
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    DataDelayThreshold float64
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    DestinationSchema ConnectionDestinationSchemaArgs
    Configuration for the destination schema. See destination_schema below.
    HybridDeploymentAgentId string
    The ID of the hybrid deployment agent.
    NetworkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The ID of the private link configuration.
    ProxyAgentId string
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    RunSetupTests bool
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    TrustCertificates bool
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    TrustFingerprints bool
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    groupId String
    The unique identifier for the destination group.
    service String
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    config String
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    dataDelaySensitivity String
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    dataDelayThreshold Double
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destinationSchema ConnectionDestinationSchema
    Configuration for the destination schema. See destination_schema below.
    hybridDeploymentAgentId String
    The ID of the hybrid deployment agent.
    networkingMethod String
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The ID of the private link configuration.
    proxyAgentId String
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    runSetupTests Boolean
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    trustCertificates Boolean
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trustFingerprints Boolean
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    groupId string
    The unique identifier for the destination group.
    service string
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    config string
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    dataDelaySensitivity string
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    dataDelayThreshold number
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destinationSchema ConnectionDestinationSchema
    Configuration for the destination schema. See destination_schema below.
    hybridDeploymentAgentId string
    The ID of the hybrid deployment agent.
    networkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId string
    The ID of the private link configuration.
    proxyAgentId string
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    runSetupTests boolean
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    trustCertificates boolean
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trustFingerprints boolean
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    group_id str
    The unique identifier for the destination group.
    service str
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    config str
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    data_delay_sensitivity str
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    data_delay_threshold float
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destination_schema ConnectionDestinationSchemaArgs
    Configuration for the destination schema. See destination_schema below.
    hybrid_deployment_agent_id str
    The ID of the hybrid deployment agent.
    networking_method str
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    private_link_id str
    The ID of the private link configuration.
    proxy_agent_id str
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    run_setup_tests bool
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    trust_certificates bool
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trust_fingerprints bool
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    groupId String
    The unique identifier for the destination group.
    service String
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    config String
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    dataDelaySensitivity String
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    dataDelayThreshold Number
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destinationSchema Property Map
    Configuration for the destination schema. See destination_schema below.
    hybridDeploymentAgentId String
    The ID of the hybrid deployment agent.
    networkingMethod String
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The ID of the private link configuration.
    proxyAgentId String
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    runSetupTests Boolean
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    trustCertificates Boolean
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trustFingerprints Boolean
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.

    Outputs

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

    ConnectedBy string
    The ID of the user who created the connection.
    CreatedAt string
    The timestamp when the connection was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The connection name (typically derived from destination schema).
    ConnectedBy string
    The ID of the user who created the connection.
    CreatedAt string
    The timestamp when the connection was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The connection name (typically derived from destination schema).
    connectedBy String
    The ID of the user who created the connection.
    createdAt String
    The timestamp when the connection was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The connection name (typically derived from destination schema).
    connectedBy string
    The ID of the user who created the connection.
    createdAt string
    The timestamp when the connection was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The connection name (typically derived from destination schema).
    connected_by str
    The ID of the user who created the connection.
    created_at str
    The timestamp when the connection was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The connection name (typically derived from destination schema).
    connectedBy String
    The ID of the user who created the connection.
    createdAt String
    The timestamp when the connection was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The connection name (typically derived from destination schema).

    Look up Existing Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config: Optional[str] = None,
            connected_by: Optional[str] = None,
            created_at: Optional[str] = None,
            data_delay_sensitivity: Optional[str] = None,
            data_delay_threshold: Optional[float] = None,
            destination_schema: Optional[ConnectionDestinationSchemaArgs] = None,
            group_id: Optional[str] = None,
            hybrid_deployment_agent_id: Optional[str] = None,
            name: Optional[str] = None,
            networking_method: Optional[str] = None,
            private_link_id: Optional[str] = None,
            proxy_agent_id: Optional[str] = None,
            run_setup_tests: Optional[bool] = None,
            service: Optional[str] = None,
            trust_certificates: Optional[bool] = None,
            trust_fingerprints: Optional[bool] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:Connection    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 string
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    ConnectedBy string
    The ID of the user who created the connection.
    CreatedAt string
    The timestamp when the connection was created.
    DataDelaySensitivity string
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    DataDelayThreshold double
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    DestinationSchema ConnectionDestinationSchema
    Configuration for the destination schema. See destination_schema below.
    GroupId string
    The unique identifier for the destination group.
    HybridDeploymentAgentId string
    The ID of the hybrid deployment agent.
    Name string
    The connection name (typically derived from destination schema).
    NetworkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The ID of the private link configuration.
    ProxyAgentId string
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    RunSetupTests bool
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    Service string
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    TrustCertificates bool
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    TrustFingerprints bool
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    Config string
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    ConnectedBy string
    The ID of the user who created the connection.
    CreatedAt string
    The timestamp when the connection was created.
    DataDelaySensitivity string
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    DataDelayThreshold float64
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    DestinationSchema ConnectionDestinationSchemaArgs
    Configuration for the destination schema. See destination_schema below.
    GroupId string
    The unique identifier for the destination group.
    HybridDeploymentAgentId string
    The ID of the hybrid deployment agent.
    Name string
    The connection name (typically derived from destination schema).
    NetworkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    PrivateLinkId string
    The ID of the private link configuration.
    ProxyAgentId string
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    RunSetupTests bool
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    Service string
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    TrustCertificates bool
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    TrustFingerprints bool
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    config String
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    connectedBy String
    The ID of the user who created the connection.
    createdAt String
    The timestamp when the connection was created.
    dataDelaySensitivity String
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    dataDelayThreshold Double
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destinationSchema ConnectionDestinationSchema
    Configuration for the destination schema. See destination_schema below.
    groupId String
    The unique identifier for the destination group.
    hybridDeploymentAgentId String
    The ID of the hybrid deployment agent.
    name String
    The connection name (typically derived from destination schema).
    networkingMethod String
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The ID of the private link configuration.
    proxyAgentId String
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    runSetupTests Boolean
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    service String
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    trustCertificates Boolean
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trustFingerprints Boolean
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    config string
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    connectedBy string
    The ID of the user who created the connection.
    createdAt string
    The timestamp when the connection was created.
    dataDelaySensitivity string
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    dataDelayThreshold number
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destinationSchema ConnectionDestinationSchema
    Configuration for the destination schema. See destination_schema below.
    groupId string
    The unique identifier for the destination group.
    hybridDeploymentAgentId string
    The ID of the hybrid deployment agent.
    name string
    The connection name (typically derived from destination schema).
    networkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId string
    The ID of the private link configuration.
    proxyAgentId string
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    runSetupTests boolean
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    service string
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    trustCertificates boolean
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trustFingerprints boolean
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    config str
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    connected_by str
    The ID of the user who created the connection.
    created_at str
    The timestamp when the connection was created.
    data_delay_sensitivity str
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    data_delay_threshold float
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destination_schema ConnectionDestinationSchemaArgs
    Configuration for the destination schema. See destination_schema below.
    group_id str
    The unique identifier for the destination group.
    hybrid_deployment_agent_id str
    The ID of the hybrid deployment agent.
    name str
    The connection name (typically derived from destination schema).
    networking_method str
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    private_link_id str
    The ID of the private link configuration.
    proxy_agent_id str
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    run_setup_tests bool
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    service str
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    trust_certificates bool
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trust_fingerprints bool
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.
    config String
    Optional connection configuration as a JSON-encoded string. This config is merged with destination_schema fields and sent to the API during creation. The connection resource does not read this field back, allowing it to be managed separately by the fivetran.ConnectionConfig resource. Use this to provide service-specific required fields (e.g., update_method for Postgres/MySQL) or full connection configuration.
    connectedBy String
    The ID of the user who created the connection.
    createdAt String
    The timestamp when the connection was created.
    dataDelaySensitivity String
    The sensitivity level for data delay notifications. Possible values: LOW, NORMAL, HIGH, CUSTOM. Default: NORMAL.
    dataDelayThreshold Number
    Custom delay threshold in minutes. Only used when data_delay_sensitivity is CUSTOM.
    destinationSchema Property Map
    Configuration for the destination schema. See destination_schema below.
    groupId String
    The unique identifier for the destination group.
    hybridDeploymentAgentId String
    The ID of the hybrid deployment agent.
    name String
    The connection name (typically derived from destination schema).
    networkingMethod String
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent.
    privateLinkId String
    The ID of the private link configuration.
    proxyAgentId String
    The ID of the proxy agent to use. Required when networking_method is ProxyAgent.
    runSetupTests Boolean
    Whether to run setup tests when creating the connection. Default: false. Note: This is a plan-only attribute and will not be stored in state.
    service String
    The connection service type (e.g., postgres, mysql, s3, snowflake). See Fivetran connection types documentation for available services.
    trustCertificates Boolean
    Whether to automatically trust SSL certificates. Default: false. Note: This is a plan-only attribute.
    trustFingerprints Boolean
    Whether to automatically trust SSH fingerprints. Default: false. Note: This is a plan-only attribute.

    Supporting Types

    ConnectionDestinationSchema, ConnectionDestinationSchemaArgs

    Name string
    The explicit schema name in the destination. Use this for connections like S3 that allow explicit schema names.
    Prefix string
    The schema prefix in the destination. The connection name will be derived from this. Use this for most database connections.
    Table string
    The table name for single-table connections.
    TableGroupName string
    The table group name for multi-table connections.
    Name string
    The explicit schema name in the destination. Use this for connections like S3 that allow explicit schema names.
    Prefix string
    The schema prefix in the destination. The connection name will be derived from this. Use this for most database connections.
    Table string
    The table name for single-table connections.
    TableGroupName string
    The table group name for multi-table connections.
    name String
    The explicit schema name in the destination. Use this for connections like S3 that allow explicit schema names.
    prefix String
    The schema prefix in the destination. The connection name will be derived from this. Use this for most database connections.
    table String
    The table name for single-table connections.
    tableGroupName String
    The table group name for multi-table connections.
    name string
    The explicit schema name in the destination. Use this for connections like S3 that allow explicit schema names.
    prefix string
    The schema prefix in the destination. The connection name will be derived from this. Use this for most database connections.
    table string
    The table name for single-table connections.
    tableGroupName string
    The table group name for multi-table connections.
    name str
    The explicit schema name in the destination. Use this for connections like S3 that allow explicit schema names.
    prefix str
    The schema prefix in the destination. The connection name will be derived from this. Use this for most database connections.
    table str
    The table name for single-table connections.
    table_group_name str
    The table group name for multi-table connections.
    name String
    The explicit schema name in the destination. Use this for connections like S3 that allow explicit schema names.
    prefix String
    The schema prefix in the destination. The connection name will be derived from this. Use this for most database connections.
    table String
    The table name for single-table connections.
    tableGroupName String
    The table group name for multi-table connections.

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.9.22 published on Thursday, Jan 29, 2026 by fivetran
      Meet Neo: Your AI Platform Teammate