Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 3.35 KB

source_jira.md

File metadata and controls

79 lines (60 loc) · 3.35 KB
page_title subcategory description
airbyte_source_jira Resource - terraform-provider-airbyte
SourceJira Resource

airbyte_source_jira (Resource)

SourceJira Resource

Example Usage

resource "airbyte_source_jira" "my_source_jira" {
  configuration = {
    api_token                   = "...my_api_token..."
    domain                      = "<your-domain>.atlassian.net"
    email                       = "...my_email..."
    enable_experimental_streams = false
    lookback_window_minutes     = 60
    num_workers                 = 1
    projects = [
      "..."
    ]
    start_date = "2021-03-01T00:00:00Z"
  }
  definition_id = "949473c3-da2c-444e-bfcd-8f8d84c88b15"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "126f780d-bef6-41d4-af4f-97391ac97b8d"
}

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)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • api_token (String, Sensitive) Jira API Token. See the docs for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
  • domain (String) The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
  • email (String) The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.

Optional:

  • enable_experimental_streams (Boolean) Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
  • lookback_window_minutes (Number) When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
  • num_workers (Number) The number of worker threads to use for the sync. Default: 3
  • projects (List of String) List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
  • start_date (String) The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the documentation.

Import

Import is supported using the following syntax:

terraform import airbyte_source_jira.my_airbyte_source_jira ""