| Field | Type | Required | Description | Example |
|---|---|---|---|---|
configurations |
Optional<StreamConfigurationsInput> | ➖ | A list of configured stream options for a connection. | |
dataResidency |
Optional<String> | ➖ | : warning: ** DEPRECATED **: We no longer support modifying dataResidency on Community and Enterprise connections. This will be supported on Cloud until May 31, at which time all connections will use the dataResidency of their associated workspace.. | |
destinationId |
String | ✔️ | N/A | |
name |
Optional<String> | ➖ | Optional name of the connection | |
namespaceDefinition |
Optional<NamespaceDefinitionEnum> | ➖ | Define the location where the data will be stored in the destination | |
namespaceFormat |
Optional<String> | ➖ | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} |
nonBreakingSchemaUpdatesBehavior |
Optional<NonBreakingSchemaUpdatesBehaviorEnum> | ➖ | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | |
prefix |
Optional<String> | ➖ | 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<AirbyteApiConnectionSchedule> | ➖ | schedule for when the the connection should run, per the schedule type | |
sourceId |
String | ✔️ | N/A | |
status |
Optional<ConnectionStatusEnum> | ➖ | N/A | |
tags |
List<Tag> | ➖ | N/A |