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:
- Group
Id 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - Data
Delay stringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - Data
Delay doubleThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - Destination
Schema ConnectionDestination Schema - Configuration for the destination schema. See destination_schema below.
- Hybrid
Deployment stringAgent Id - The ID of the hybrid deployment agent.
- Networking
Method string - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - Private
Link stringId - The ID of the private link configuration.
- Proxy
Agent stringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - Run
Setup boolTests - 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.
- Group
Id 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - Data
Delay stringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - Data
Delay float64Threshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - Destination
Schema ConnectionDestination Schema Args - Configuration for the destination schema. See destination_schema below.
- Hybrid
Deployment stringAgent Id - The ID of the hybrid deployment agent.
- Networking
Method string - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - Private
Link stringId - The ID of the private link configuration.
- Proxy
Agent stringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - Run
Setup boolTests - 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.
- group
Id 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - data
Delay StringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data
Delay DoubleThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination
Schema ConnectionDestination Schema - Configuration for the destination schema. See destination_schema below.
- hybrid
Deployment StringAgent Id - The ID of the hybrid deployment agent.
- networking
Method String - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private
Link StringId - The ID of the private link configuration.
- proxy
Agent StringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run
Setup BooleanTests - 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 Boolean - Whether to automatically trust SSL certificates. Default:
false. Note: This is a plan-only attribute. - trust
Fingerprints Boolean - Whether to automatically trust SSH fingerprints. Default:
false. Note: This is a plan-only attribute.
- group
Id 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - data
Delay stringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data
Delay numberThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination
Schema ConnectionDestination Schema - Configuration for the destination schema. See destination_schema below.
- hybrid
Deployment stringAgent Id - The ID of the hybrid deployment agent.
- networking
Method string - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private
Link stringId - The ID of the private link configuration.
- proxy
Agent stringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run
Setup booleanTests - 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 boolean - Whether to automatically trust SSL certificates. Default:
false. Note: This is a plan-only attribute. - trust
Fingerprints 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - data_
delay_ strsensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data_
delay_ floatthreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination_
schema ConnectionDestination Schema Args - Configuration for the destination schema. See destination_schema below.
- hybrid_
deployment_ stragent_ id - The ID of the hybrid deployment agent.
- networking_
method str - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private_
link_ strid - The ID of the private link configuration.
- proxy_
agent_ strid - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run_
setup_ booltests - 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.
- group
Id 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - data
Delay StringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data
Delay NumberThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination
Schema Property Map - Configuration for the destination schema. See destination_schema below.
- hybrid
Deployment StringAgent Id - The ID of the hybrid deployment agent.
- networking
Method String - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private
Link StringId - The ID of the private link configuration.
- proxy
Agent StringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run
Setup BooleanTests - 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 Boolean - Whether to automatically trust SSL certificates. Default:
false. Note: This is a plan-only attribute. - trust
Fingerprints 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:
- Connected
By string - The ID of the user who created the connection.
- Created
At 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 string - The ID of the user who created the connection.
- Created
At 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 String - The ID of the user who created the connection.
- created
At 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 string - The ID of the user who created the connection.
- created
At 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).
- connected
By String - The ID of the user who created the connection.
- created
At 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) -> Connectionfunc 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.
- 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - Connected
By string - The ID of the user who created the connection.
- Created
At string - The timestamp when the connection was created.
- Data
Delay stringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - Data
Delay doubleThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - Destination
Schema ConnectionDestination Schema - Configuration for the destination schema. See destination_schema below.
- Group
Id string - The unique identifier for the destination group.
- Hybrid
Deployment stringAgent Id - The ID of the hybrid deployment agent.
- Name string
- The connection name (typically derived from destination schema).
- Networking
Method string - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - Private
Link stringId - The ID of the private link configuration.
- Proxy
Agent stringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - Run
Setup boolTests - 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. - 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - Connected
By string - The ID of the user who created the connection.
- Created
At string - The timestamp when the connection was created.
- Data
Delay stringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - Data
Delay float64Threshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - Destination
Schema ConnectionDestination Schema Args - Configuration for the destination schema. See destination_schema below.
- Group
Id string - The unique identifier for the destination group.
- Hybrid
Deployment stringAgent Id - The ID of the hybrid deployment agent.
- Name string
- The connection name (typically derived from destination schema).
- Networking
Method string - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - Private
Link stringId - The ID of the private link configuration.
- Proxy
Agent stringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - Run
Setup boolTests - 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. - 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - connected
By String - The ID of the user who created the connection.
- created
At String - The timestamp when the connection was created.
- data
Delay StringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data
Delay DoubleThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination
Schema ConnectionDestination Schema - Configuration for the destination schema. See destination_schema below.
- group
Id String - The unique identifier for the destination group.
- hybrid
Deployment StringAgent Id - The ID of the hybrid deployment agent.
- name String
- The connection name (typically derived from destination schema).
- networking
Method String - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private
Link StringId - The ID of the private link configuration.
- proxy
Agent StringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run
Setup BooleanTests - 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. - trust
Certificates Boolean - Whether to automatically trust SSL certificates. Default:
false. Note: This is a plan-only attribute. - trust
Fingerprints 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - connected
By string - The ID of the user who created the connection.
- created
At string - The timestamp when the connection was created.
- data
Delay stringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data
Delay numberThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination
Schema ConnectionDestination Schema - Configuration for the destination schema. See destination_schema below.
- group
Id string - The unique identifier for the destination group.
- hybrid
Deployment stringAgent Id - The ID of the hybrid deployment agent.
- name string
- The connection name (typically derived from destination schema).
- networking
Method string - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private
Link stringId - The ID of the private link configuration.
- proxy
Agent stringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run
Setup booleanTests - 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. - trust
Certificates boolean - Whether to automatically trust SSL certificates. Default:
false. Note: This is a plan-only attribute. - trust
Fingerprints 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor 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_ strsensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data_
delay_ floatthreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination_
schema ConnectionDestination Schema Args - Configuration for the destination schema. See destination_schema below.
- group_
id str - The unique identifier for the destination group.
- hybrid_
deployment_ stragent_ id - 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_ strid - The ID of the private link configuration.
- proxy_
agent_ strid - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run_
setup_ booltests - 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.ConnectionConfigresource. Use this to provide service-specific required fields (e.g.,update_methodfor Postgres/MySQL) or full connection configuration. - connected
By String - The ID of the user who created the connection.
- created
At String - The timestamp when the connection was created.
- data
Delay StringSensitivity - The sensitivity level for data delay notifications. Possible values:
LOW,NORMAL,HIGH,CUSTOM. Default:NORMAL. - data
Delay NumberThreshold - Custom delay threshold in minutes. Only used when
data_delay_sensitivityisCUSTOM. - destination
Schema Property Map - Configuration for the destination schema. See destination_schema below.
- group
Id String - The unique identifier for the destination group.
- hybrid
Deployment StringAgent Id - The ID of the hybrid deployment agent.
- name String
- The connection name (typically derived from destination schema).
- networking
Method String - The networking method for the connection. Possible values:
Directly,SshTunnel,ProxyAgent. - private
Link StringId - The ID of the private link configuration.
- proxy
Agent StringId - The ID of the proxy agent to use. Required when
networking_methodisProxyAgent. - run
Setup BooleanTests - 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. - trust
Certificates Boolean - Whether to automatically trust SSL certificates. Default:
false. Note: This is a plan-only attribute. - trust
Fingerprints 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.
- Table
Group stringName - 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.
- Table
Group stringName - 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.
- table
Group StringName - 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.
- table
Group stringName - 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_ strname - 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.
- table
Group StringName - 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
fivetranTerraform Provider.
