Skip to content

Latest commit

 

History

History
150 lines (105 loc) · 5.78 KB

source_tiktok_marketing.md

File metadata and controls

150 lines (105 loc) · 5.78 KB
page_title subcategory description
airbyte_source_tiktok_marketing Resource - terraform-provider-airbyte
SourceTiktokMarketing Resource

airbyte_source_tiktok_marketing (Resource)

SourceTiktokMarketing Resource

Example Usage

resource "airbyte_source_tiktok_marketing" "my_source_tiktokmarketing" {
  configuration = {
    attribution_window = 233
    credentials = {
      o_auth20 = {
        access_token  = "...my_access_token..."
        advertiser_id = "...my_advertiser_id..."
        app_id        = "...my_app_id..."
        secret        = "...my_secret..."
      }
    }
    end_date        = "2022-11-01"
    include_deleted = true
    start_date      = "2022-04-25"
  }
  definition_id = "1ec33e26-a63c-4daf-be97-7f4062cb980d"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "972417c8-071a-43d1-8082-a2d88ae006dc"
}

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

Optional:

  • attribution_window (Number) The attribution window in days. Default: 3
  • credentials (Attributes) Authentication method (see below for nested schema)
  • end_date (String) The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DD. All data generated between start_date and this date will be replicated. Not setting this option will result in always syncing the data till the current date.
  • include_deleted (Boolean) Set to active if you want to include deleted data in report based streams and Ads, Ad Groups and Campaign streams. Default: false
  • start_date (String) The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated. If this parameter is not set, all data will be replicated. Default: "2016-09-01"

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.o_auth20

Required:

  • access_token (String, Sensitive) Long-term Authorized Access Token.
  • app_id (String, Sensitive) The Developer Application App ID.
  • secret (String, Sensitive) The Developer Application Secret.

Optional:

  • advertiser_id (String) The Advertiser ID to filter reports and streams. Let this empty to retrieve all.

Nested Schema for configuration.credentials.sandbox_access_token

Required:

  • access_token (String, Sensitive) The long-term authorized access token.
  • advertiser_id (String) The Advertiser ID which generated for the developer's Sandbox application.

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_tiktok_marketing.my_airbyte_source_tiktok_marketing ""