Skip to content

Latest commit

 

History

History
112 lines (79 loc) · 4.73 KB

source_klaviyo.md

File metadata and controls

112 lines (79 loc) · 4.73 KB
page_title subcategory description
airbyte_source_klaviyo Resource - terraform-provider-airbyte
SourceKlaviyo Resource

airbyte_source_klaviyo (Resource)

SourceKlaviyo Resource

Example Usage

resource "airbyte_source_klaviyo" "my_source_klaviyo" {
  configuration = {
    api_key                               = "...my_api_key..."
    disable_fetching_predictive_analytics = true
    num_workers                           = 1
    start_date                            = "2017-01-25T00:00:00Z"
  }
  definition_id = "2b3afbaf-d4bc-4d4d-8b70-a755581e44c3"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "2b8b9017-7907-4706-8721-11272beb5dbf"
}

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:

  • api_key (String, Sensitive) Klaviyo API Key. See our docs if you need help finding this key.

Optional:

  • disable_fetching_predictive_analytics (Boolean) Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
  • num_workers (Number) The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API docs. Default: 10
  • start_date (String) UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

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_klaviyo.my_airbyte_source_klaviyo ""