Skip to content

Latest commit

 

History

History
228 lines (169 loc) · 9.45 KB

destination_postgres.md

File metadata and controls

228 lines (169 loc) · 9.45 KB
page_title subcategory description
airbyte_destination_postgres Resource - terraform-provider-airbyte
DestinationPostgres Resource

airbyte_destination_postgres (Resource)

DestinationPostgres Resource

Example Usage

resource "airbyte_destination_postgres" "my_destination_postgres" {
  configuration = {
    database            = "...my_database..."
    disable_type_dedupe = true
    drop_cascade        = false
    host                = "...my_host..."
    jdbc_url_params     = "...my_jdbc_url_params..."
    password            = "...my_password..."
    port                = 5432
    raw_data_schema     = "...my_raw_data_schema..."
    schema              = "public"
    ssl                 = true
    ssl_mode = {
      allow = {
        # ...
      }
      disable = {
        # ...
      }
      prefer = {
        # ...
      }
      require = {
        # ...
      }
      verify_ca = {
        ca_certificate      = "...my_ca_certificate..."
        client_key_password = "...my_client_key_password..."
      }
      verify_full = {
        ca_certificate      = "...my_ca_certificate..."
        client_certificate  = "...my_client_certificate..."
        client_key          = "...my_client_key..."
        client_key_password = "...my_client_key_password..."
      }
    }
    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..."
      }
    }
    unconstrained_number = false
    username             = "...my_username..."
  }
  definition_id = "6cc561e7-8b38-4621-919b-0687fe3682b7"
  name          = "...my_name..."
  workspace_id  = "2b2d880a-23fd-4463-8627-0a837b28bb7e"
}

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) Name of the database.
  • host (String) Hostname of the database.
  • username (String) Username to use to access the database.

Optional:

  • disable_type_dedupe (Boolean) Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions. Default: false
  • drop_cascade (Boolean) Drop tables with CASCADE. WARNING! This will delete all data in all dependent objects (views, etc.). Use with caution. This option is intended for usecases which can easily rebuild the dependent objects. Default: false
  • 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) Password associated with the username.
  • port (Number) Port of the database. Default: 5432
  • raw_data_schema (String) The schema to write raw tables into
  • 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 (Boolean) Encrypt data using SSL. When activating SSL, please select one of the connection modes. Default: false
  • ssl_mode (Attributes) SSL connection modes. disable - Chose this mode to disable encryption of communication between Airbyte and destination database allow - Chose this mode to enable encryption only when required by the source database prefer - Chose this mode to allow unencrypted connection only if the source database does not support encryption require - Chose this mode to always require encryption. If the source database server does not support encryption, connection will fail verify-ca - Chose this mode to always require encryption and to verify that the source database server has a valid SSL certificate verify-full - This is the most secure mode. Chose this mode to always require encryption and to verify the identity of the source database server See more information - in the docs. (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)
  • unconstrained_number (Boolean) Create numeric columns as unconstrained DECIMAL instead of NUMBER(38, 9). This will allow increased precision in numeric values. (this is disabled by default for backwards compatibility, but is recommended to enable). Default: false

Nested Schema for configuration.ssl_mode

Optional:

Nested Schema for configuration.ssl_mode.allow

Nested Schema for configuration.ssl_mode.disable

Nested Schema for configuration.ssl_mode.prefer

Nested Schema for configuration.ssl_mode.require

Nested Schema for configuration.ssl_mode.verify_ca

Required:

  • ca_certificate (String, Sensitive) CA certificate

Optional:

  • client_key_password (String, Sensitive) Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.

Nested Schema for configuration.ssl_mode.verify_full

Required:

  • ca_certificate (String, Sensitive) CA certificate
  • client_certificate (String, Sensitive) Client certificate
  • client_key (String, Sensitive) Client key

Optional:

  • client_key_password (String, Sensitive) Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.

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_postgres.my_airbyte_destination_postgres ""