Skip to content

Latest commit

 

History

History
169 lines (116 loc) · 6.5 KB

source_snowflake.md

File metadata and controls

169 lines (116 loc) · 6.5 KB
page_title subcategory description
airbyte_source_snowflake Resource - terraform-provider-airbyte
SourceSnowflake Resource

airbyte_source_snowflake (Resource)

SourceSnowflake Resource

Example Usage

resource "airbyte_source_snowflake" "my_source_snowflake" {
  configuration = {
    credentials = {
      username_and_password = {
        password = "...my_password..."
        username = "AIRBYTE_USER"
      }
    }
    database        = "AIRBYTE_DATABASE"
    host            = "accountname.us-east-2.aws.snowflakecomputing.com"
    jdbc_url_params = "...my_jdbc_url_params..."
    role            = "AIRBYTE_ROLE"
    schema          = "AIRBYTE_SCHEMA"
    warehouse       = "AIRBYTE_WAREHOUSE"
  }
  definition_id = "27125485-2542-4c33-816b-4945c1b73270"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "f456591a-a491-49d7-af41-2d440d1ae6ee"
}

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:

  • database (String) The database you created for Airbyte to access data.
  • host (String) The host domain of the snowflake instance (must include the account, region, cloud environment, and end with snowflakecomputing.com).
  • role (String) The role you created for Airbyte to access Snowflake.
  • warehouse (String) The warehouse you created for Airbyte to access data.

Optional:

  • credentials (Attributes) (see below for nested schema)
  • jdbc_url_params (String) Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
  • schema (String) The source Snowflake schema tables. Leave empty to access tables from multiple schemas.

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.key_pair_authentication

Required:

  • private_key (String, Sensitive) RSA Private key to use for Snowflake connection. See the docs for more information on how to obtain this key.
  • username (String) The username you created to allow Airbyte to access the database.

Optional:

  • private_key_password (String, Sensitive) Passphrase for private key

Nested Schema for configuration.credentials.o_auth20

Required:

  • client_id (String, Sensitive) The Client ID of your Snowflake developer application.
  • client_secret (String, Sensitive) The Client Secret of your Snowflake developer application.

Optional:

  • access_token (String, Sensitive) Access Token for making authenticated requests.
  • refresh_token (String, Sensitive) Refresh Token for making authenticated requests.

Nested Schema for configuration.credentials.username_and_password

Required:

  • password (String, Sensitive) The password associated with the username.
  • username (String) The username you created to allow Airbyte to access the database.

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_snowflake.my_airbyte_source_snowflake ""