Skip to content

Latest commit

 

History

History
160 lines (112 loc) · 6.22 KB

source_airtable.md

File metadata and controls

160 lines (112 loc) · 6.22 KB
page_title subcategory description
airbyte_source_airtable Resource - terraform-provider-airbyte
SourceAirtable Resource

airbyte_source_airtable (Resource)

SourceAirtable Resource

Example Usage

resource "airbyte_source_airtable" "my_source_airtable" {
  configuration = {
    add_base_id_to_stream_name = false
    additional_properties      = "{ \"see\": \"documentation\" }"
    credentials = {
      o_auth20 = {
        access_token      = "...my_access_token..."
        client_id         = "...my_client_id..."
        client_secret     = "...my_client_secret..."
        refresh_token     = "...my_refresh_token..."
        token_expiry_date = "2022-01-14T11:50:58.504Z"
      }
    }
    num_workers = 37
  }
  definition_id = "fdd0b7d7-bc62-4e45-9809-2513b5f90d61"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "110737e7-1846-4cca-8ebc-d0f82e4b8ffb"
}

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: "14c6e7ea-97ed-4f5e-a7b5-25e9a80b8212"; 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

Optional:

  • add_base_id_to_stream_name (Boolean) When enabled, includes the base ID in stream names to ensure uniqueness. Use this if you have cloned Airtable bases with duplicate table names. Note that enabling this will change stream names and require a full refresh. Default: false
  • additional_properties (String) Parsed as JSON.
  • credentials (Attributes) (see below for nested schema)
  • num_workers (Number) Number of concurrent threads for syncing. Higher values can speed up syncs but may hit rate limits. Airtable limits to 5 requests per second per base. Default: 5

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.o_auth20

Required:

  • client_id (String, Sensitive) The client ID of the Airtable developer application.
  • client_secret (String, Sensitive) The client secret of the Airtable developer application.
  • refresh_token (String, Sensitive) The key to refresh the expired access token.

Optional:

  • access_token (String, Sensitive) Access Token for making authenticated requests.
  • token_expiry_date (String) The date-time when the access token should be refreshed.

Nested Schema for configuration.credentials.personal_access_token

Required:

  • api_key (String, Sensitive) The Personal Access Token for the Airtable account. See the Support Guide for more information on how to obtain this token.

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_airtable.my_airbyte_source_airtable
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_airtable.my_airbyte_source_airtable "..."