Skip to content

destination_mssql.md

Latest commit

 

History

History
280 lines (194 loc) · 12.5 KB

destination_mssql.md

File metadata and controls

280 lines (194 loc) · 12.5 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 = {
    additional_properties = "{ \"see\": \"documentation\" }"
    database              = "...my_database..."
    host                  = "...my_host..."
    jdbc_url_params       = "...my_jdbc_url_params..."
    load_type = {
      insert_load = {
        additional_properties = "{ \"see\": \"documentation\" }"
        load_type             = "INSERT"
      }
    }
    password = "...my_password..."
    port     = 1433
    schema   = "public"
    ssl_method = {
      encrypted_verify_certificate = {
        additional_properties    = "{ \"see\": \"documentation\" }"
        host_name_in_certificate = "...my_host_name_in_certificate..."
        name                     = "encrypted_verify_certificate"
        trust_store_name         = "...my_trust_store_name..."
        trust_store_password     = "...my_trust_store_password..."
      }
    }
    tunnel_method = {
      no_tunnel = {
        additional_properties = "{ \"see\": \"documentation\" }"
        tunnel_method         = "NO_TUNNEL"
      }
    }
    user = "...my_user..."
  }
  definition_id = "d4353156-9217-4cad-8dd7-c108fd4f74cf"
  name          = "...my_name..."
  workspace_id  = "2e9afd8a-c9ca-4f91-bf9f-71f1a7c362df"
}

Schema

Required

  • configuration (Attributes) The values required to configure the destination. The schema for this must match the schema return by destination_definition_specifications/get for the destinationDefinition. (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. Default: "d4353156-9217-4cad-8dd7-c108fd4f74cf"; Requires replacement if changed.

Read-Only

  • created_at (Number)
  • destination_id (String)
  • destination_type (String)
  • resource_allocation (Attributes) actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level. (see below for nested schema)

Nested Schema for configuration

Required:

  • database (String) The name of the MSSQL database.
  • host (String) The host name of the MSSQL database.
  • load_type (Attributes) Specifies the type of load mechanism (e.g., BULK, INSERT) and its associated configuration. (see below for nested schema)
  • port (Number) The port of the MSSQL database.
  • ssl_method (Attributes) The encryption method which is used to communicate with the database. (see below for nested schema)
  • user (String) The username which is used to access the database.

Optional:

  • additional_properties (String) Parsed as JSON.
  • 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.
  • 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"
  • 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.load_type

Optional:

  • bulk_load (Attributes) Configuration details for using the BULK loading mechanism. (see below for nested schema)
  • insert_load (Attributes) Configuration details for using the INSERT loading mechanism. (see below for nested schema)

Nested Schema for configuration.load_type.bulk_load

Required:

Optional:

  • additional_properties (String) Parsed as JSON.
  • azure_blob_storage_account_key (String, Sensitive) The Azure blob storage account key. Mutually exclusive with a Shared Access Signature
  • bulk_load_validate_values_pre_load (Boolean) When enabled, Airbyte will validate all values before loading them into the destination table. This provides stronger data integrity guarantees but may significantly impact performance. Default: false
  • load_type (String) Default: "BULK"; must be "BULK"
  • shared_access_signature (String, Sensitive) A shared access signature (SAS) provides secure delegated access to resources in your storage account. See: https://learn.microsoft.com/azure/storage/common/storage-sas-overview.Mutually exclusive with an account key

Nested Schema for configuration.load_type.insert_load

Optional:

  • additional_properties (String) Parsed as JSON.
  • load_type (String) Default: "INSERT"; must be "INSERT"

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

Optional:

  • additional_properties (String) Parsed as JSON.
  • name (String) Default: "encrypted_trust_server_certificate"; must be "encrypted_trust_server_certificate"

Nested Schema for configuration.ssl_method.encrypted_verify_certificate

Optional:

  • additional_properties (String) Parsed as JSON.
  • 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.
  • name (String) Default: "encrypted_verify_certificate"; must be "encrypted_verify_certificate"
  • trust_store_name (String) Specifies the name of the trust store.
  • trust_store_password (String, Sensitive) Specifies the password of the trust store.

Nested Schema for configuration.ssl_method.unencrypted

Optional:

  • additional_properties (String) Parsed as JSON.
  • name (String) Default: "unencrypted"; must be "unencrypted"

Nested Schema for configuration.tunnel_method

Optional:

  • no_tunnel (Attributes) No ssh tunnel needed to connect to database (see below for nested schema)
  • password_authentication (Attributes) Connect through a jump server tunnel host using username and password authentication (see below for nested schema)
  • ssh_key_authentication (Attributes) Connect through a jump server tunnel host using username and ssh key (see below for nested schema)

Nested Schema for configuration.tunnel_method.no_tunnel

Optional:

  • additional_properties (String) Parsed as JSON.
  • tunnel_method (String) Default: "NO_TUNNEL"; must be "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:

  • additional_properties (String) Parsed as JSON.
  • tunnel_method (String) Default: "SSH_PASSWORD_AUTH"; must be "SSH_PASSWORD_AUTH"
  • 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:

  • additional_properties (String) Parsed as JSON.
  • tunnel_method (String) Default: "SSH_KEY_AUTH"; must be "SSH_KEY_AUTH"
  • tunnel_port (Number) Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

Nested Schema for resource_allocation

Read-Only:

Nested Schema for resource_allocation.default

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Nested Schema for resource_allocation.job_specific

Read-Only:

  • job_type (String) enum that describes the different types of jobs that the platform runs.
  • resource_requirements (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see below for nested schema)

Nested Schema for resource_allocation.job_specific.resource_requirements

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Import

Import is supported using the following syntax:

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

import {
  to = airbyte_destination_mssql.my_airbyte_destination_mssql
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_destination_mssql.my_airbyte_destination_mssql "..."