Skip to content

Latest commit

 

History

History
143 lines (98 loc) · 5.13 KB

source_workday.md

File metadata and controls

143 lines (98 loc) · 5.13 KB
page_title subcategory description
airbyte_source_workday Resource - terraform-provider-airbyte
SourceWorkday Resource

airbyte_source_workday (Resource)

SourceWorkday Resource

Example Usage

resource "airbyte_source_workday" "my_source_workday" {
  configuration = {
    credentials = {
      restapi_streams = {
        access_token = "...my_access_token..."
        start_date   = "2024-10-26T07:00:00.000Z"
      }
    }
    host      = "...my_host..."
    tenant_id = "...my_tenant_id..."
  }
  definition_id = "caf3b67e-129c-4e9e-a530-2b6adcf4997d"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "40a9f4d4-7bdd-4a7c-90bb-08fd63077df2"
}

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:

  • credentials (Attributes) Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them. (see below for nested schema)
  • host (String)
  • tenant_id (String)

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.report_based_streams

Required:

  • password (String, Sensitive)
  • report_ids (List of String) Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
  • username (String)

Nested Schema for configuration.credentials.restapi_streams

Required:

  • access_token (String, Sensitive) Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.

Optional:

  • start_date (String) Rows after this date will be synced, default 2 years ago.

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_workday.my_airbyte_source_workday ""