Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 3.94 KB

source_smartsheets.md

File metadata and controls

109 lines (80 loc) · 3.94 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 = {
      api_access_token = {
        access_token = "...my_access_token..."
      }
      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)
  • 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.

Import

Import is supported using the following syntax:

terraform import airbyte_source_smartsheets.my_airbyte_source_smartsheets ""