Skip to content

Latest commit

 

History

History
117 lines (85 loc) · 3.9 KB

source_fauna.md

File metadata and controls

117 lines (85 loc) · 3.9 KB
page_title subcategory description
airbyte_source_fauna Resource - terraform-provider-airbyte
SourceFauna Resource

airbyte_source_fauna (Resource)

SourceFauna Resource

Example Usage

resource "airbyte_source_fauna" "my_source_fauna" {
  configuration = {
    collection = {
      deletions = {
        disabled = {
          # ...
        }
        enabled = {
          column = "...my_column..."
        }
      }
      page_size = 2
    }
    domain = "...my_domain..."
    port   = 3
    scheme = "...my_scheme..."
    secret = "...my_secret..."
  }
  definition_id = "7da8a804-135a-42a9-9fae-e38938f1ebbf"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "82a1bb0b-2686-4b4c-86cd-84520efe37b7"
}

Schema

Required

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

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • secret (String, Sensitive) Fauna secret, used when authenticating with the database.

Optional:

  • collection (Attributes) Settings for the Fauna Collection. (see below for nested schema)
  • domain (String) Domain of Fauna to query. Defaults db.fauna.com. See the docs. Default: "db.fauna.com"
  • port (Number) Endpoint port. Default: 443
  • scheme (String) URL scheme. Default: "https"

Nested Schema for configuration.collection

Required:

  • deletions (Attributes) This only applies to incremental syncs.
    Enabling deletion mode informs your destination of deleted documents.
    Disabled - Leave this feature disabled, and ignore deleted documents.
    Enabled - Enables this feature. When a document is deleted, the connector exports a record with a "deleted at" column containing the time that the document was deleted. (see below for nested schema)

Optional:

  • page_size (Number) The page size used when reading documents from the database. The larger the page size, the faster the connector processes documents. However, if a page is too large, the connector may fail.
    Choose your page size based on how large the documents are.
    See the docs. Default: 64

Nested Schema for configuration.collection.deletions

Optional:

Nested Schema for configuration.collection.deletions.disabled

Nested Schema for configuration.collection.deletions.enabled

Optional:

  • column (String) Name of the "deleted at" column. Default: "deleted_at"

Import

Import is supported using the following syntax:

terraform import airbyte_source_fauna.my_airbyte_source_fauna ""