Skip to content

Latest commit

 

History

History
137 lines (98 loc) · 5.87 KB

source_salesforce.md

File metadata and controls

137 lines (98 loc) · 5.87 KB
page_title subcategory description
airbyte_source_salesforce Resource - terraform-provider-airbyte
SourceSalesforce Resource

airbyte_source_salesforce (Resource)

SourceSalesforce Resource

Example Usage

resource "airbyte_source_salesforce" "my_source_salesforce" {
  configuration = {
    client_id          = "...my_client_id..."
    client_secret      = "...my_client_secret..."
    force_use_bulk_api = true
    is_sandbox         = false
    refresh_token      = "...my_refresh_token..."
    start_date         = "2021-07-25"
    stream_slice_step  = "PT12H"
    streams_criteria = [
      {
        criteria = "not contains"
        value    = "...my_value..."
      }
    ]
  }
  definition_id = "ac775334-3ab2-43d2-b41a-9b554542b831"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "009ca65a-dea0-4cfe-b1a6-e5f50c2ef465"
}

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:

  • client_id (String) Enter your Salesforce developer application's Client ID
  • client_secret (String, Sensitive) Enter your Salesforce developer application's Client secret
  • refresh_token (String, Sensitive) Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce account.

Optional:

  • force_use_bulk_api (Boolean) Toggle to use Bulk API (this might cause empty fields for some streams). Default: false
  • is_sandbox (Boolean) Toggle if you're using a Salesforce Sandbox. Default: false
  • start_date (String) Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
  • stream_slice_step (String) The size of the time window (ISO8601 duration) to slice requests. Default: "P30D"
  • streams_criteria (Attributes List) Add filters to select only required stream based on SObject name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector. (see below for nested schema)

Nested Schema for configuration.streams_criteria

Required:

  • value (String)

Optional:

  • criteria (String) Default: "contains"; must be one of ["starts with", "ends with", "contains", "exacts", "starts not with", "ends not with", "not contains", "not exacts"]

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_salesforce.my_airbyte_source_salesforce ""