Skip to content

Latest commit

 

History

History
168 lines (120 loc) · 7.13 KB

source_slack.md

File metadata and controls

168 lines (120 loc) · 7.13 KB
page_title subcategory description
airbyte_source_slack Resource - terraform-provider-airbyte
SourceSlack Resource

airbyte_source_slack (Resource)

SourceSlack Resource

Example Usage

resource "airbyte_source_slack" "my_source_slack" {
  configuration = {
    additional_properties = "{ \"see\": \"documentation\" }"
    channel_filter = [
      "..."
    ]
    channel_messages_window_size = 30
    credentials = {
      sign_in_via_slack_o_auth = {
        access_token  = "...my_access_token..."
        client_id     = "...my_client_id..."
        client_secret = "...my_client_secret..."
      }
    }
    include_private_channels = false
    join_channels            = false
    lookback_window          = 7
    num_workers              = 2
    start_date               = "2017-01-25T00:00:00Z"
  }
  definition_id = "0e40c94d-0533-49a9-8fb8-ec1935c15487"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "c0473aa4-957d-44db-ac2f-386282ba46e7"
}

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: "c2281cee-86f9-4a86-bb48-d23286b4c7bd"; 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:

  • start_date (String) UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.

Optional:

  • additional_properties (String) Parsed as JSON.
  • channel_filter (List of String) A channel name list (without leading '#' char) which limit the channels from which you'd like to sync. Empty list means no filter. Default: []
  • channel_messages_window_size (Number) The size (in days) of the date window that will be used while syncing data from the channel messages stream. A smaller window will allow for greater parallelization when syncing records, but can lead to rate limiting errors. Default: 100
  • credentials (Attributes) Choose how to authenticate into Slack (see below for nested schema)
  • include_private_channels (Boolean) Whether to read information from private channels that the bot is already in. If false, only public channels will be read. If true, the bot must be manually added to private channels. Default: false
  • join_channels (Boolean) Whether to join all channels or to sync data only from channels the bot is already in. If false, you''ll need to manually add the bot to all the channels from which you''d like to sync messages. Default: true
  • lookback_window (Number) How far into the past to look for messages in threads, default is 0 days. Default: 0
  • num_workers (Number) The number of worker threads to use for the sync. Default: 2

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.api_token

Required:

  • api_token (String, Sensitive) A Slack bot token. See the docs for instructions on how to generate it.

Nested Schema for configuration.credentials.sign_in_via_slack_o_auth

Required:

  • access_token (String, Sensitive) Slack access_token. See our docs if you need help generating the token.
  • client_id (String) Slack client_id. See our docs if you need help finding this id.
  • client_secret (String, Sensitive) Slack client_secret. See our docs if you need help finding this secret.

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_slack.my_airbyte_source_slack
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_slack.my_airbyte_source_slack "..."