Skip to content

Latest commit

 

History

History
171 lines (119 loc) · 6.75 KB

source_freshdesk.md

File metadata and controls

171 lines (119 loc) · 6.75 KB
page_title subcategory description
airbyte_source_freshdesk Resource - terraform-provider-airbyte
SourceFreshdesk Resource

airbyte_source_freshdesk (Resource)

SourceFreshdesk Resource

Example Usage

resource "airbyte_source_freshdesk" "my_source_freshdesk" {
  configuration = {
    additional_properties   = "{ \"see\": \"documentation\" }"
    api_key                 = "...my_api_key..."
    domain                  = "myaccount.freshdesk.com"
    lookback_window_in_days = 7
    rate_limit_plan = {
      pro_plan = {
        # ...
      }
    }
    requests_per_minute = 0
    start_date          = "2020-12-01T00:00:00Z"
  }
  definition_id = "58d83f7f-a804-4af2-96e8-fa39c3b39944"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "b2cdea40-9812-46df-a900-c64c52ad9f81"
}

Schema

Required

  • configuration (Attributes) The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. (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. Default: "ec4b9503-13cb-48ab-a4ab-6ade4be46567"; 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) Freshdesk API Key. See the docs for more information on how to obtain this key.
  • domain (String) Freshdesk domain

Optional:

  • additional_properties (String) Parsed as JSON.
  • lookback_window_in_days (Number) Number of days for lookback window for the stream Satisfaction Ratings. Default: 14
  • rate_limit_plan (Attributes) Rate Limit Plan for API Budget (see below for nested schema)
  • requests_per_minute (Number) The number of requests per minute that this source allowed to use. There is a rate limit of 50 requests per minute per app per account.
  • start_date (String) UTC date and time. Any data created after this date will be replicated. If this parameter is not set, all data will be replicated.

Nested Schema for configuration.rate_limit_plan

Optional:

Nested Schema for configuration.rate_limit_plan.custom_plan

Optional:

  • contacts_rate_limit (Number) Maximum Rate in Limit/minute for contacts list endpoint in Custom Plan
  • general_rate_limit (Number) General Maximum Rate in Limit/minute for other endpoints in Custom Plan
  • tickets_rate_limit (Number) Maximum Rate in Limit/minute for tickets list endpoint in Custom Plan

Nested Schema for configuration.rate_limit_plan.enterprise_plan

Nested Schema for configuration.rate_limit_plan.free_plan

Nested Schema for configuration.rate_limit_plan.growth_plan

Nested Schema for configuration.rate_limit_plan.pro_plan

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

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

import {
  to = airbyte_source_freshdesk.my_airbyte_source_freshdesk
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_freshdesk.my_airbyte_source_freshdesk "..."