workspace.md

page_title	airbyte_workspace Resource - terraform-provider-airbyte
subcategory
description	Workspace Resource

airbyte_workspace (Resource)

Workspace Resource

Example Usage

resource "airbyte_workspace" "my_workspace" {
  name = "...my_name..."
  notifications = {
    connection_update = {
      email = {
        enabled = false
      }
      webhook = {
        enabled = false
        url     = "...my_url..."
      }
    }
    connection_update_action_required = {
      email = {
        enabled = true
      }
      webhook = {
        enabled = true
        url     = "...my_url..."
      }
    }
    failure = {
      email = {
        enabled = false
      }
      webhook = {
        enabled = false
        url     = "...my_url..."
      }
    }
    success = {
      email = {
        enabled = false
      }
      webhook = {
        enabled = true
        url     = "...my_url..."
      }
    }
    sync_disabled = {
      email = {
        enabled = true
      }
      webhook = {
        enabled = true
        url     = "...my_url..."
      }
    }
    sync_disabled_warning = {
      email = {
        enabled = false
      }
      webhook = {
        enabled = false
        url     = "...my_url..."
      }
    }
  }
  organization_id = "4d886138-b4b4-4da8-9dca-f4d28f8550f8"
  region_id       = "cbd99489-c363-45e8-9d04-2de8d03ae703"
}

Schema

Required

• name (String) Name of the workspace

Optional

• notifications (Attributes) Configures workspace notifications. (see below for nested schema)
• organization_id (String) ID of organization to add workspace to. Requires replacement if changed.
• region_id (String)

Read-Only

• data_residency (String)
• workspace_id (String)

Nested Schema for notifications

Optional:

• connection_update (Attributes) Configures a notification. (see below for nested schema)
• connection_update_action_required (Attributes) Configures a notification. (see below for nested schema)
• failure (Attributes) Configures a notification. (see below for nested schema)
• success (Attributes) Configures a notification. (see below for nested schema)
• sync_disabled (Attributes) Configures a notification. (see below for nested schema)
• sync_disabled_warning (Attributes) Configures a notification. (see below for nested schema)

Nested Schema for notifications.connection_update

Optional:

• email (Attributes) Configures an email notification. (see below for nested schema)
• webhook (Attributes) Configures a webhook notification. (see below for nested schema)

Nested Schema for notifications.connection_update.email

Optional:

• enabled (Boolean)

Nested Schema for notifications.connection_update.webhook

Optional:

• enabled (Boolean)
• url (String)

Nested Schema for notifications.connection_update_action_required

Optional:

• email (Attributes) Configures an email notification. (see below for nested schema)
• webhook (Attributes) Configures a webhook notification. (see below for nested schema)

Nested Schema for notifications.connection_update_action_required.email

Optional:

• enabled (Boolean)

Nested Schema for notifications.connection_update_action_required.webhook

Optional:

• enabled (Boolean)
• url (String)

Nested Schema for notifications.failure

Optional:

• email (Attributes) Configures an email notification. (see below for nested schema)
• webhook (Attributes) Configures a webhook notification. (see below for nested schema)

Nested Schema for notifications.failure.email

Optional:

• enabled (Boolean)

Nested Schema for notifications.failure.webhook

Optional:

• enabled (Boolean)
• url (String)

Nested Schema for notifications.success

Optional:

• email (Attributes) Configures an email notification. (see below for nested schema)
• webhook (Attributes) Configures a webhook notification. (see below for nested schema)

Nested Schema for notifications.success.email

Optional:

• enabled (Boolean)

Nested Schema for notifications.success.webhook

Optional:

• enabled (Boolean)
• url (String)

Nested Schema for notifications.sync_disabled

Optional:

• email (Attributes) Configures an email notification. (see below for nested schema)
• webhook (Attributes) Configures a webhook notification. (see below for nested schema)

Nested Schema for notifications.sync_disabled.email

Optional:

• enabled (Boolean)

Nested Schema for notifications.sync_disabled.webhook

Optional:

• enabled (Boolean)
• url (String)

Nested Schema for notifications.sync_disabled_warning

Optional:

• email (Attributes) Configures an email notification. (see below for nested schema)
• webhook (Attributes) Configures a webhook notification. (see below for nested schema)

Nested Schema for notifications.sync_disabled_warning.email

Optional:

• enabled (Boolean)

Nested Schema for notifications.sync_disabled_warning.webhook

Optional:

• enabled (Boolean)
• url (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_workspace.my_airbyte_workspace
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_workspace.my_airbyte_workspace "..."