Skip to content

Latest commit

 

History

History
147 lines (102 loc) · 5.29 KB

source_sftp.md

File metadata and controls

147 lines (102 loc) · 5.29 KB
page_title subcategory description
airbyte_source_sftp Resource - terraform-provider-airbyte
SourceSftp Resource

airbyte_source_sftp (Resource)

SourceSftp Resource

Example Usage

resource "airbyte_source_sftp" "my_source_sftp" {
  configuration = {
    credentials = {
      password_authentication = {
        auth_user_password = "...my_auth_user_password..."
      }
    }
    file_pattern = "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which  `log-yearmmdd`"
    file_types   = "csv,json"
    folder_path  = "/logs/2022"
    host         = "www.host.com"
    port         = 22
    user         = "...my_user..."
  }
  definition_id = "ef03926e-13cb-4929-aa6b-e7c8e1b0c80e"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "de2e80b4-0898-4bea-821b-cb0c33f06888"
}

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:

  • host (String) The server host address
  • user (String) The server user

Optional:

  • credentials (Attributes) The server authentication method (see below for nested schema)
  • file_pattern (String) The regular expression to specify files for sync in a chosen Folder Path. Default: ""
  • file_types (String) Coma separated file types. Currently only 'csv' and 'json' types are supported. Default: "csv,json"
  • folder_path (String) The directory to search files for sync. Default: ""
  • port (Number) The server port. Default: 22

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.password_authentication

Required:

  • auth_user_password (String, Sensitive) OS-level password for logging into the jump server host

Nested Schema for configuration.credentials.ssh_key_authentication

Required:

  • auth_ssh_key (String, Sensitive) OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )

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_sftp.my_airbyte_source_sftp ""