Skip to content

Latest commit

 

History

History
167 lines (115 loc) · 6.42 KB

source_fauna.md

File metadata and controls

167 lines (115 loc) · 6.42 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 = {
    additional_properties = "{ \"see\": \"documentation\" }"
    collection = {
      deletions = {
        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) The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. (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. Default: "3825db3e-c94b-42ac-bd53-b5a9507ace2b"; 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)
  • 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)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

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

Optional:

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

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_source_fauna.my_airbyte_source_fauna
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_fauna.my_airbyte_source_fauna "..."