1. Packages
  2. Fivetran Provider
  3. API Docs
  4. Connection
Viewing docs for fivetran 1.9.26
published on Friday, Mar 20, 2026 by fivetran
Schema (JSON)
fivetran/terraform-provider-fivetran

fivetran.Connection

fivetran logo
Viewing docs for fivetran 1.9.26
published on Friday, Mar 20, 2026 by fivetran
Schema (JSON)
fivetran/terraform-provider-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 Group (Destination) within the Fivetran system.
    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 level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    DataDelayThreshold double
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    DestinationSchema ConnectionDestinationSchema
    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
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    PrivateLinkId string
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. Note: This is a plan-only attribute.
    GroupId string
    The unique identifier for the Group (Destination) within the Fivetran system.
    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 level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    DataDelayThreshold float64
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    DestinationSchema ConnectionDestinationSchemaArgs
    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
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    PrivateLinkId string
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. Note: This is a plan-only attribute.
    groupId String
    The unique identifier for the Group (Destination) within the Fivetran system.
    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 level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    dataDelayThreshold Double
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destinationSchema ConnectionDestinationSchema
    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
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    privateLinkId String
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. Note: This is a plan-only attribute.
    groupId string
    The unique identifier for the Group (Destination) within the Fivetran system.
    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 level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    dataDelayThreshold number
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destinationSchema ConnectionDestinationSchema
    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
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    privateLinkId string
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. Note: This is a plan-only attribute.
    group_id str
    The unique identifier for the Group (Destination) within the Fivetran system.
    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 level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    data_delay_threshold float
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destination_schema ConnectionDestinationSchemaArgs
    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
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    private_link_id str
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. Note: This is a plan-only attribute.
    groupId String
    The unique identifier for the Group (Destination) within the Fivetran system.
    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 level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    dataDelayThreshold Number
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destinationSchema Property Map
    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
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    privateLinkId String
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. 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 unique identifier of the user who has created the connection in your account.
    CreatedAt string
    The timestamp of the time the connection was created in your account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    ConnectedBy string
    The unique identifier of the user who has created the connection in your account.
    CreatedAt string
    The timestamp of the time the connection was created in your account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    connectedBy String
    The unique identifier of the user who has created the connection in your account.
    createdAt String
    The timestamp of the time the connection was created in your account.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    connectedBy string
    The unique identifier of the user who has created the connection in your account.
    createdAt string
    The timestamp of the time the connection was created in your account.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    connected_by str
    The unique identifier of the user who has created the connection in your account.
    created_at str
    The timestamp of the time the connection was created in your account.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    connectedBy String
    The unique identifier of the user who has created the connection in your account.
    createdAt String
    The timestamp of the time the connection was created in your account.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.

    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 unique identifier of the user who has created the connection in your account.
    CreatedAt string
    The timestamp of the time the connection was created in your account.
    DataDelaySensitivity string
    The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    DataDelayThreshold double
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    DestinationSchema ConnectionDestinationSchema
    GroupId string
    The unique identifier for the Group (Destination) 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.
    Name string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    NetworkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    PrivateLinkId string
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. 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 unique identifier of the user who has created the connection in your account.
    CreatedAt string
    The timestamp of the time the connection was created in your account.
    DataDelaySensitivity string
    The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    DataDelayThreshold float64
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    DestinationSchema ConnectionDestinationSchemaArgs
    GroupId string
    The unique identifier for the Group (Destination) 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.
    Name string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    NetworkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    PrivateLinkId string
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. 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 unique identifier of the user who has created the connection in your account.
    createdAt String
    The timestamp of the time the connection was created in your account.
    dataDelaySensitivity String
    The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    dataDelayThreshold Double
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destinationSchema ConnectionDestinationSchema
    groupId String
    The unique identifier for the Group (Destination) 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.
    name String
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    networkingMethod String
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    privateLinkId String
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. 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 unique identifier of the user who has created the connection in your account.
    createdAt string
    The timestamp of the time the connection was created in your account.
    dataDelaySensitivity string
    The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    dataDelayThreshold number
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destinationSchema ConnectionDestinationSchema
    groupId string
    The unique identifier for the Group (Destination) 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.
    name string
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    networkingMethod string
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    privateLinkId string
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. 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 unique identifier of the user who has created the connection in your account.
    created_at str
    The timestamp of the time the connection was created in your account.
    data_delay_sensitivity str
    The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    data_delay_threshold float
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destination_schema ConnectionDestinationSchemaArgs
    group_id str
    The unique identifier for the Group (Destination) 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.
    name str
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    networking_method str
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    private_link_id str
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. 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 unique identifier of the user who has created the connection in your account.
    createdAt String
    The timestamp of the time the connection was created in your account.
    dataDelaySensitivity String
    The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
    dataDelayThreshold Number
    Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when datadelaysensitivity set to CUSTOM.
    destinationSchema Property Map
    groupId String
    The unique identifier for the Group (Destination) 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.
    name String
    The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
    networkingMethod String
    The networking method for the connection. Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
    privateLinkId String
    The private link ID. Required when networking_method is PrivateLink.
    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
    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. Note: This is a plan-only attribute.
    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. Note: This is a plan-only attribute.

    Supporting Types

    ConnectionDestinationSchema, ConnectionDestinationSchemaArgs

    Name string
    The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
    Prefix string
    The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
    Table string
    The table name unique within the schema to which connection will sync the data. Required for connection creation.
    TableGroupName string
    Table group name.
    Name string
    The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
    Prefix string
    The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
    Table string
    The table name unique within the schema to which connection will sync the data. Required for connection creation.
    TableGroupName string
    Table group name.
    name String
    The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
    prefix String
    The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
    table String
    The table name unique within the schema to which connection will sync the data. Required for connection creation.
    tableGroupName String
    Table group name.
    name string
    The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
    prefix string
    The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
    table string
    The table name unique within the schema to which connection will sync the data. Required for connection creation.
    tableGroupName string
    Table group name.
    name str
    The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
    prefix str
    The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
    table str
    The table name unique within the schema to which connection will sync the data. Required for connection creation.
    table_group_name str
    Table group name.
    name String
    The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
    prefix String
    The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
    table String
    The table name unique within the schema to which connection will sync the data. Required for connection creation.
    tableGroupName String
    Table group name.

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    Viewing docs for fivetran 1.9.26
    published on Friday, Mar 20, 2026 by fivetran
    Schema (JSON)
    fivetran/terraform-provider-fivetran
      Try Pulumi Cloud free. Your team will thank you.