Skip to content

Latest commit

 

History

History
171 lines (124 loc) · 6.6 KB

destination_mssql.md

File metadata and controls

171 lines (124 loc) · 6.6 KB
page_title subcategory description
airbyte_destination_mssql Resource - terraform-provider-airbyte
DestinationMssql Resource

airbyte_destination_mssql (Resource)

DestinationMssql Resource

Example Usage

resource "airbyte_destination_mssql" "my_destination_mssql" {
  configuration = {
    database        = "...my_database..."
    host            = "...my_host..."
    jdbc_url_params = "...my_jdbc_url_params..."
    password        = "...my_password..."
    port            = 1433
    raw_data_schema = "...my_raw_data_schema..."
    schema          = "public"
    ssl_method = {
      encrypted_trust_server_certificate = {
        # ...
      }
      encrypted_verify_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 = "a282fec3-7b94-4274-9620-860fbc85f5d6"
  name          = "...my_name..."
  workspace_id  = "2e9afd8a-c9ca-4f91-bf9f-71f1a7c362df"
}

Schema

Required

  • configuration (Attributes) (see below for nested schema)
  • name (String) Name of the destination e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • destination_id (String)
  • destination_type (String)

Nested Schema for configuration

Required:

  • database (String) The name of the MSSQL database.
  • host (String) The host name of the MSSQL 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).
  • password (String, Sensitive) The password associated with this username.
  • port (Number) The port of the MSSQL database. Default: 1433
  • raw_data_schema (String) The schema to write raw tables into (default: airbyte_internal)
  • schema (String) The default schema tables are written to if the source does not specify a namespace. The usual value for this field is "public". Default: "public"
  • ssl_method (Attributes) The encryption method which is used to communicate 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)

Nested Schema for configuration.ssl_method

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) The data transfer will not be encrypted. (see below for nested schema)

Nested Schema for configuration.ssl_method.encrypted_trust_server_certificate

Nested Schema for configuration.ssl_method.encrypted_verify_certificate

Optional:

  • host_name_in_certificate (String) Specifies the host name of the server. The value of this property must match the subject property of the certificate.

Nested Schema for configuration.ssl_method.unencrypted

Nested Schema for configuration.tunnel_method

Optional:

Nested Schema for configuration.tunnel_method.no_tunnel

Nested Schema for configuration.tunnel_method.password_authentication

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 host
  • tunnel_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

Nested Schema for configuration.tunnel_method.ssh_key_authentication

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

Import is supported using the following syntax:

terraform import airbyte_destination_mssql.my_airbyte_destination_mssql ""