Destination Configlink
The destination setup configuration (config
field) is different for each destination. We will continue to add more destinations to this list throughout BETA:
- Azure Data Lake Storage
- Azure Synapse
- BigQuery
- Confluent Cloud
- Databricks
- MySQL
- MySQL RDS
- MySQL Aurora RDS
- OneLake
- PostgreSQL
- PostgreSQL RDS
- PostgreSQL Amazon Aurora
- PostgreSQL Google Cloud
- Redshift
- S3 Data Lake
- Snowflake
- SQL Azure Database
- SQL Server
- SQL Server RDS
Azure Data Lake Storagelink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "adls",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"storage_account_name": "adls_storage_account_name",
"container_name": "adls_container_name",
"tenant_id": "service_principal_tenant_id",
"client_id": "service_principal_client_id",
"secret_value": "service_principal_secret_value",
"prefix_path": "adls_container_path_prefix",
"connection_type": "Directly"
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
storage_account_name (required) | Azure Data Lake Storage account name. | |
container_name (required) | Azure Data Lake Storage container name. | |
tenant_id (required) | Service Principal tenant ID | |
client_id (required) | Service Principal client ID | |
secret_value (required) | Service Principal secret value | |
prefix_path | Path to data within your container. If not provided, by default, we will create a Fivetran folder in the root directory. | |
connection_type | Connection method. Default value: Directly. | Directly, PrivateLink |
For more information, see our Azure Data Lake Storage setup guide.
Azure Synapselink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "azure_sql_data_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran"
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Azure Synapse setup guide.
BigQuerylink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "big_query",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"project_id": "my-bigquery-project",
"data_set_location": "US",
"bucket": "customer-bucket",
"secret_key": "private-key-of-the-customer-service-account"
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
project_id (required) | BigQuery project ID | |
data_set_location (required) | Data location. Datasets will reside in this location. | US , EU , us-west2 , northamerica-northeast1 , us-east4 , southamerica-east1 , europe-north1 , europe-west2 , europe-west6 , asia-east2 , asia-south1 , asia-northeast2 , asia-east1 , asia-northeast1 , asia-southeast1 , australia-southeast1 |
bucket | Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location. | |
secret_key | Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account. |
For more information, see our BigQuery setup guide.
Confluent Cloudlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "confluent_cloud_wh",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"bootstrap_servers": ["serveraddress1:8080, serveraddress2:8080"],
"security_protocol": "SASL",
"sasl_mechanism": "PLAIN",
"sasl_plain_key": "your_API_key",
"sasl_plain_secret": "your_API_secret",
"num_of_partitions": 4,
"replication_factor": 3,
"data_format": "AVRO",
"schema_registry_url": "http://localhost:8088",
"schema_registry_api_key": "your_schema_registry_API_key",
"schema_registry_api_secret": "your_schema_registry_API_secret"
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
bootstrap_servers | Comma-separated list of Confluent Cloud servers in the server:port format. | |
security_protocol | Security protocol for Confluent Cloud interaction. | SASL |
sasl_mechanism | Security protocol for Confluent Cloud interaction. | PLAIN |
sasl_plain_key | Confluent Cloud SASL key. | |
sasl_plain_secret | Confluent Cloud SASL secret. | |
num_of_partitions | Number of partitions per topic. | |
replication_factor | Replication factor. | 2 , 3 , 4 |
data_format | Confluent Cloud message format. | JSON , AVRO |
schema_registry_url | Schema registry URL. | |
schema_registry_api_key | Schema registry API key. | |
schema_registry_api_secret | Schema registry API secret. |
For more information, see our Confluent Cloud setup guide.
Databrickslink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "databricks",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"server_host_name": "87a8z-3da23-3da8d-cloud.databricks.com",
"port": 443,
"http_path": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565",
"personal_access_token": "7sjhds-6273y2-h2y3uy-23782h-123hhs5",
"create_external_tables" : true,
"external_location": "/some_external_location",
"cloud_provider": "GCP"
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
server_host_name (required) | Server name | |
port (required) | Server port number | |
http_path (required) | HTTP path | |
personal_access_token (required) | Personal access token | |
create_external_tables | Whether to create external tables | true , false |
external_location | External location to store Delta tables. Default value: "" (null). By default, the external tables will reside in the /{schema}/{table} path, and if you specify an external location in the {externalLocation}/{schema}/{table} path. | |
cloud_provider | Databricks Deployment Cloud | AWS , AZURE , GCP |
For more information, see our Databricks setup guide.
MySQLlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "mysql_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our MySQL RDS setup guide.
MySQL RDSlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "mysql_rds_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our MySQL RDS setup guide.
MySQL Aurora RDSlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "aurora_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Aurora RDS setup guide.
OneLakelink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "onelake",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"workspace_name": "onelake_workspace",
"lakehouse_name": "onelake_lakehouse",
"tenant_id": "service_principal_tenant_id",
"client_id": "service_principal_client_id",
"secret_value": "service_principal_secret_value"
}
}
Config parameterslink
Name | Description |
---|---|
workspace_name (required) | OneLake workspace name |
lakehouse_name (required) | OneLake lakehouse name |
tenant_id (required) | Service Principal tenant ID |
client_id (required) | Service Principal client ID |
secret_value (required) | Service Principal secret value |
For more information, see our OneLake setup guide.
PostgreSQLlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "postgres_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Generic PostgreSQL setup guide.
PostgreSQL RDSlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "postgres_rds_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our PostgreSQL RDS setup guide.
PostgreSQL Amazon Auroralink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "aurora_postgres_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Amazon Aurora PostgreSQL setup guide.
PostgreSQL Google Cloudlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "postgres_gcp_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Google Cloud PostgreSQL setup guide.
Redshiftlink
Request for password authenticationlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "redshift",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran"
}
}
Request for IAM authenticationlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "redshift",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"auth_type": "IAM",
"role_arn": "arn:aws:iam::12345:role/test-role",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"cluster_id": "clu5734-id",
"cluster_region": "us-east-1"
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
auth_type | Authentication type. Default value: PASSWORD . | PASSWORD , IAM |
password | Database user password. Required if authentication type is PASSWORD . | |
role_arn | Role ARN with Redshift permissions. Required if authentication type is IAM . | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
cluster_id | Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM . | |
cluster_region | Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM . | For example, us-east-1 , us-east-2 , eu-west-2 , ap-south-1 . |
For more information, see our Redshift setup guide.
S3 Data Lakelink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "new_s3_datalake",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"bucket": "s3_bucket_name",
"fivetran_role_arn": "iam_role_arn",
"prefix_path": "s3_bucket_path_prefix",
"region": "s3_bucket_region",
"is_private_link_required" : false
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
bucket (required) | S3 bucket name | |
fivetran_role_arn (required) | ARN of the IAM role created to access the S3 bucket and AWS Glue | |
prefix_path | Path prefix of the S3 bucket. Must be populated if the access policy is configured for a specific bucket path. Not required if the access policy is configured for the entire bucket. | |
region (required) | AWS Region of the S3 bucket | |
is_private_link_required | Specified whether we should use always AWS PrivateLink to connect to your S3 bucket. By default, we use PrivateLink if your S3 bucket is in the same region as Fivetran. Default value: false | true , false |
For more information, see our S3 Data Lake setup guide.
Snowflakelink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "snowflake",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "your-account.snowflakecomputing.com",
"port": 443,
"database": "fivetran",
"auth": "PASSWORD",
"user": "fivetran_user",
"password": "123456",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
auth (required) | Password-based or key-based authentication type | PASSWORD , KEY_PAIR |
user (required) | Database user name | |
password | Database user password. The field should be specified if authentication type is PASSWORD . | |
private_key | Private access key. The field should be specified if authentication type is KEY_PAIR . | |
is_private_key_encrypted | Indicates that a private key is encrypted. The default value: false . The field can be specified if authentication type is KEY_PAIR . | true or false |
passphrase | In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is KEY_PAIR . | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Snowflake setup guide.
Azure SQL Databaselink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "azure_sql_data_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Azure SQL Database setup guide.
Generic SQL Serverlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "sql_server_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our Generic SQL Server setup guide.
SQL Server RDSlink
Requestlink
POST https://api.fivetran.com/v1/destinations
{
"group_id": "target_group_id",
"service": "sql_server_rds_warehouse",
"region": "US",
"time_zone_offset": "-5",
"config" :
{
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"port": 443,
"database": "production",
"user": "admin",
"password": "fresh_air_267@83",
"connection_type": "SshTunnel",
"tunnel_host": "ssh.server.com",
"tunnel_port": "564",
"tunnel_user": "Fivetran",
"always_encrypted": true
}
}
Config parameterslink
Name | Description | Possible Values |
---|---|---|
host (required) | Server name | |
port (required) | Server port number | |
database (required) | Database name | |
user (required) | Database user name | |
password (required) | Database user password | |
connection_type | Connection method. Default value: Directly . | Directly , SshTunnel |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . | |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . | |
always_encrypted | Specifies whether TLS is required. Must be populated if connection_type is set to SshTunnel . |
For more information, see our SQL Server RDS setup guide.