| page_title | subcategory | description |
|---|---|---|
airbyte_source_mssql Resource - terraform-provider-airbyte |
SourceMssql Resource |
SourceMssql Resource
resource "airbyte_source_mssql" "my_source_mssql" {
configuration = {
database = "master"
host = "...my_host..."
jdbc_url_params = "...my_jdbc_url_params..."
password = "...my_password..."
port = 1433
replication_method = {
read_changes_using_change_data_capture_cdc = {
initial_load_timeout_hours = 4
initial_waiting_seconds = 0
invalid_cdc_cursor_position_behavior = "Re-sync data"
queue_size = 9
}
scan_changes_with_user_defined_cursor = {
# ...
}
}
schemas = [
]
ssl_method = {
encrypted_trust_server_certificate = {
# ...
}
encrypted_verify_certificate = {
certificate = "...my_certificate..."
host_name_in_certificate = "...my_host_name_in_certificate..."
}
unencrypted = {
# ...
}
}
tunnel_method = {
no_tunnel = {
# ...
}
password_authentication = {
tunnel_host = "...my_tunnel_host..."
tunnel_port = 22
tunnel_user = "...my_tunnel_user..."
tunnel_user_password = "...my_tunnel_user_password..."
}
ssh_key_authentication = {
ssh_key = "...my_ssh_key..."
tunnel_host = "...my_tunnel_host..."
tunnel_port = 22
tunnel_user = "...my_tunnel_user..."
}
}
username = "...my_username..."
}
definition_id = "3156776f-a553-4f83-b7be-07e1d515092f"
name = "...my_name..."
secret_id = "...my_secret_id..."
workspace_id = "89a5f137-cba1-4f2e-85cc-db4cd4426082"
}configuration(Attributes) (see below for nested schema)name(String) Name of the source e.g. dev-mysql-instance.workspace_id(String)
definition_id(String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.secret_id(String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
created_at(Number)source_id(String)source_type(String)
Required:
database(String) The name of the database.host(String) The hostname of the database.password(String, Sensitive) The password associated with the username.port(Number) The port of the database.username(String) The username which is used to access the database.
Optional:
jdbc_url_params(String) Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).replication_method(Attributes) Configures how data is extracted from the database. (see below for nested schema)schemas(List of String) The list of schemas to sync from. Defaults to user. Case sensitive.ssl_method(Attributes) The encryption method which is used when communicating with the database. (see below for nested schema)tunnel_method(Attributes) Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. (see below for nested schema)
Optional:
read_changes_using_change_data_capture_cdc(Attributes) Recommended - Incrementally reads new inserts, updates, and deletes using the SQL Server's change data capture feature. This must be enabled on your database. (see below for nested schema)scan_changes_with_user_defined_cursor(Attributes) Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). (see below for nested schema)
Optional:
initial_load_timeout_hours(Number) The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8initial_waiting_seconds(Number) The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 3600 seconds. Read about initial waiting time. Default: 300invalid_cdc_cursor_position_behavior(String) Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]queue_size(Number) The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
Optional:
encrypted_trust_server_certificate(Attributes) Use the certificate provided by the server without verification. (For testing purposes only!) (see below for nested schema)encrypted_verify_certificate(Attributes) Verify and use the certificate provided by the server. (see below for nested schema)unencrypted(Attributes) Data transfer will not be encrypted. (see below for nested schema)
Optional:
certificate(String, Sensitive) certificate of the server, or of the CA that signed the server certificatehost_name_in_certificate(String) Specifies the host name of the server. The value of this property must match the subject property of the certificate.
Optional:
no_tunnel(Attributes) (see below for nested schema)password_authentication(Attributes) (see below for nested schema)ssh_key_authentication(Attributes) (see below for nested schema)
Required:
tunnel_host(String) Hostname of the jump server host that allows inbound ssh tunnel.tunnel_user(String) OS-level username for logging into the jump server hosttunnel_user_password(String, Sensitive) OS-level password for logging into the jump server host
Optional:
tunnel_port(Number) Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
Required:
ssh_key(String, Sensitive) OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )tunnel_host(String) Hostname of the jump server host that allows inbound ssh tunnel.tunnel_user(String) OS-level username for logging into the jump server host.
Optional:
tunnel_port(Number) Port on the proxy/jump server that accepts inbound ssh connections. Default: 22
Import is supported using the following syntax:
terraform import airbyte_source_mssql.my_airbyte_source_mssql ""