Skip to content

Latest commit

 

History

History
232 lines (157 loc) · 9.54 KB

destination_yellowbrick.md

File metadata and controls

232 lines (157 loc) · 9.54 KB
page_title subcategory description
airbyte_destination_yellowbrick Resource - terraform-provider-airbyte
DestinationYellowbrick Resource

airbyte_destination_yellowbrick (Resource)

DestinationYellowbrick Resource

Example Usage

resource "airbyte_destination_yellowbrick" "my_destination_yellowbrick" {
  configuration = {
    database        = "...my_database..."
    host            = "...my_host..."
    jdbc_url_params = "...my_jdbc_url_params..."
    password        = "...my_password..."
    port            = 5432
    schema          = "public"
    ssl             = true
    ssl_mode = {
      # ...
    }
    tunnel_method = {
      no_tunnel = {
        # ...
      }
    }
    username = "...my_username..."
  }
  definition_id = "81a773ac-fba0-424f-a74b-6a91a45ce8fe"
  name          = "...my_name..."
  workspace_id  = "2d4bfbc0-aa6b-42b1-9222-6303d0c9671f"
}

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)
  • 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) Name of the database.
  • host (String) Hostname of the database.
  • username (String) Username to use 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) Password associated with the username.
  • port (Number) Port of the database. Default: 5432
  • 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)

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

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. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
  • 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:

terraform import airbyte_destination_yellowbrick.my_airbyte_destination_yellowbrick ""