Skip to content

Latest commit

 

History

History
154 lines (105 loc) · 6.68 KB

source_zendesk_support.md

File metadata and controls

154 lines (105 loc) · 6.68 KB
page_title subcategory description
airbyte_source_zendesk_support Resource - terraform-provider-airbyte
SourceZendeskSupport Resource

airbyte_source_zendesk_support (Resource)

SourceZendeskSupport Resource

Example Usage

resource "airbyte_source_zendesk_support" "my_source_zendesksupport" {
  configuration = {
    credentials = {
      api_token = {
        additional_properties = "{ \"see\": \"documentation\" }"
        api_token             = "...my_api_token..."
        email                 = "...my_email..."
      }
    }
    num_workers = 1
    start_date  = "2020-10-15T00:00:00Z"
    subdomain   = "...my_subdomain..."
  }
  definition_id = "2f4827bb-f12c-45a8-a7c8-fc92af717ff3"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "88e43c5a-c5bf-4914-bf88-1d261e2148a9"
}

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:

  • subdomain (String) This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MY_SUBDOMAIN.zendesk.com/, MY_SUBDOMAIN is the value of your subdomain.

Optional:

  • credentials (Attributes) Zendesk allows two authentication methods. We recommend using OAuth2.0 for Airbyte Cloud users and API token for Airbyte Open Source users. (see below for nested schema)
  • num_workers (Number) The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API docs. Default: 3
  • start_date (String) The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.api_token

Required:

  • api_token (String, Sensitive) The value of the API token generated. See our full documentation for more information on generating this token.
  • email (String) The user email for your Zendesk account.

Optional:

  • additional_properties (String) Parsed as JSON.

Nested Schema for configuration.credentials.o_auth20

Required:

  • access_token (String, Sensitive) The OAuth access token. See the Zendesk docs for more information on generating this token.

Optional:

  • additional_properties (String) Parsed as JSON.
  • client_id (String, Sensitive) The OAuth client's ID. See this guide for more information.
  • client_secret (String, Sensitive) The OAuth client secret. See this guide for more information.

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_zendesk_support.my_airbyte_source_zendesk_support ""