Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 5.87 KB

source_dynamodb.md

File metadata and controls

145 lines (100 loc) · 5.87 KB
page_title subcategory description
airbyte_source_dynamodb Resource - terraform-provider-airbyte
SourceDynamodb Resource

airbyte_source_dynamodb (Resource)

SourceDynamodb Resource

Example Usage

resource "airbyte_source_dynamodb" "my_source_dynamodb" {
  configuration = {
    credentials = {
      role_based_authentication = {
        additional_properties = "{ \"see\": \"documentation\" }"
      }
    }
    endpoint                               = "https://{aws_dynamo_db_url}.com"
    ignore_missing_read_permissions_tables = true
    region                                 = "ap-southeast-1"
    reserved_attribute_names               = "name, field_name, field-name"
  }
  definition_id = "4102f2b2-2d6c-4289-a4cb-9348fe710c97"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "6e654cbb-f82e-40a5-9542-939f3129c0d9"
}

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

Optional:

  • credentials (Attributes) Credentials for the service (see below for nested schema)
  • endpoint (String) the URL of the Dynamodb database. Default: ""
  • ignore_missing_read_permissions_tables (Boolean) Ignore tables with missing scan/read permissions. Default: false
  • region (String) The region of the Dynamodb database. Default: ""; must be one of ["", "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"]
  • reserved_attribute_names (String, Sensitive) Comma separated reserved attribute names present in your tables

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.authenticate_via_access_keys

Required:

  • access_key_id (String, Sensitive) The access key id to access Dynamodb. Airbyte requires read permissions to the database
  • secret_access_key (String, Sensitive) The corresponding secret to the access key id.

Optional:

  • additional_properties (String) Parsed as JSON.

Nested Schema for configuration.credentials.role_based_authentication

Optional:

  • additional_properties (String) Parsed as JSON.

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_dynamodb.my_airbyte_source_dynamodb ""