Skip to content

Latest commit

 

History

History
151 lines (106 loc) · 5.88 KB

source_smartsheets.md

File metadata and controls

151 lines (106 loc) · 5.88 KB
page_title subcategory description
airbyte_source_smartsheets Resource - terraform-provider-airbyte
SourceSmartsheets Resource

airbyte_source_smartsheets (Resource)

SourceSmartsheets Resource

Example Usage

resource "airbyte_source_smartsheets" "my_source_smartsheets" {
  configuration = {
    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 = "2021-05-13T13:15:18.521Z"
      }
    }
    is_report = false
    metadata_fields = [
      "row_expanded"
    ]
    spreadsheet_id = "...my_spreadsheet_id..."
  }
  definition_id = "002b9562-dfe0-4357-bd10-30c9f3cda4c7"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "65f657d8-fd3b-49a9-af69-90fbc23c85f7"
}

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)
  • 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:

  • credentials (Attributes) (see below for nested schema)
  • spreadsheet_id (String) The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties

Optional:

  • is_report (Boolean) If true, the source will treat the provided sheet_id as a report. If false, the source will treat the provided sheet_id as a sheet. Default: false
  • metadata_fields (List of String) A List of available columns which metadata can be pulled from.

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.api_access_token

Required:

  • access_token (String, Sensitive) The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the setup guide for information on how to obtain this token.

Nested Schema for configuration.credentials.o_auth20

Required:

  • access_token (String, Sensitive) Access Token for making authenticated requests.
  • client_id (String, Sensitive) The API ID of the SmartSheets developer application.
  • client_secret (String, Sensitive) The API Secret the SmartSheets developer application.
  • refresh_token (String, Sensitive) The key to refresh the expired access_token.
  • token_expiry_date (String) The date-time when the access token should be refreshed.

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_source_smartsheets.my_airbyte_source_smartsheets ""