destination_mongodb.md

page_title	subcategory	description
airbyte_destination_mongodb Resource - terraform-provider-airbyte		DestinationMongodb Resource

airbyte_destination_mongodb (Resource)

DestinationMongodb Resource

Example Usage

resource "airbyte_destination_mongodb" "my_destination_mongodb" {
  configuration = {
    auth_type = {
      login_password = {
        password = "...my_password..."
        username = "...my_username..."
      }
      none = {
        # ...
      }
    }
    database = "...my_database..."
    instance_type = {
      mongo_db_atlas = {
        cluster_url = "...my_cluster_url..."
        instance    = "atlas"
      }
      replica_set = {
        instance         = "replica"
        replica_set      = "...my_replica_set..."
        server_addresses = "host1:27017,host2:27017,host3:27017"
      }
      standalone_mongo_db_instance = {
        host     = "...my_host..."
        instance = "standalone"
        port     = 27017
        tls      = false
      }
    }
    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..."
      }
    }
  }
  definition_id = "ecb670c3-9030-4c95-a447-d69ea2c1371e"
  name          = "...my_name..."
  workspace_id  = "63ac2b57-1c99-4294-8b40-d92cdc44ffaf"
}

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:

• auth_type (Attributes) Authorization type. (see below for nested schema)
• database (String) Name of the database.

Optional:

• instance_type (Attributes) MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default. (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.auth_type

Optional:

• login_password (Attributes) Login/Password. (see below for nested schema)
• none (Attributes) None. (see below for nested schema)

Nested Schema for configuration.auth_type.login_password

Required:

• password (String, Sensitive) Password associated with the username.
• username (String) Username to use to access the database.

Nested Schema for configuration.auth_type.none

Nested Schema for configuration.instance_type

Optional:

• mongo_db_atlas (Attributes) (see below for nested schema)
• replica_set (Attributes) (see below for nested schema)
• standalone_mongo_db_instance (Attributes) (see below for nested schema)

Nested Schema for configuration.instance_type.mongo_db_atlas

Required:

• cluster_url (String) URL of a cluster to connect to.

Optional:

• instance (String) Default: "atlas"; must be "atlas"

Nested Schema for configuration.instance_type.replica_set

Required:

• server_addresses (String) The members of a replica set. Please specify host:port of each member seperated by comma.

Optional:

• instance (String) Default: "replica"; must be "replica"
• replica_set (String) A replica set name.

Nested Schema for configuration.instance_type.standalone_mongo_db_instance

Required:

• host (String) The Host of a Mongo database to be replicated.

Optional:

• instance (String) Default: "standalone"; must be "standalone"
• port (Number) The Port of a Mongo database to be replicated. Default: 27017
• tls (Boolean) Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see documentation. Default: false

Nested Schema for configuration.tunnel_method

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)

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_mongodb.my_airbyte_destination_mongodb ""