Field | Type | Required | Description | Example |
---|---|---|---|---|
destination_id |
str | ✔️ | N/A | |
source_id |
str | ✔️ | N/A | |
configurations |
Optional[models.StreamConfigurations] | ➖ | A list of configured stream options for a connection. | |
data_residency |
Optional[models.GeographyEnum] | ➖ | N/A | |
name |
Optional[str] | ➖ | Optional name of the connection | |
namespace_definition |
Optional[models.NamespaceDefinitionEnum] | ➖ | Define the location where the data will be stored in the destination | |
namespace_format |
Optional[str] | ➖ | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} |
non_breaking_schema_updates_behavior |
Optional[models.NonBreakingSchemaUpdatesBehaviorEnum] | ➖ | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | |
prefix |
Optional[str] | ➖ | Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). | |
schedule |
Optional[models.AirbyteAPIConnectionSchedule] | ➖ | schedule for when the the connection should run, per the schedule type | |
status |
Optional[models.ConnectionStatusEnum] | ➖ | N/A |