# ConnectionCreateRequest


## Fields

| Field                                                                                                                                                                                        | Type                                                                                                                                                                                         | Required                                                                                                                                                                                     | Description                                                                                                                                                                                  | Example                                                                                                                                                                                      |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `destination_id`                                                                                                                                                                             | *str*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                           | N/A                                                                                                                                                                                          |                                                                                                                                                                                              |
| `source_id`                                                                                                                                                                                  | *str*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                           | N/A                                                                                                                                                                                          |                                                                                                                                                                                              |
| `configurations`                                                                                                                                                                             | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md)                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                           | A list of configured stream options for a connection.                                                                                                                                        |                                                                                                                                                                                              |
| `data_residency`                                                                                                                                                                             | [Optional[models.GeographyEnum]](../models/geographyenum.md)                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                           | N/A                                                                                                                                                                                          |                                                                                                                                                                                              |
| `name`                                                                                                                                                                                       | *Optional[str]*                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                           | Optional name of the connection                                                                                                                                                              |                                                                                                                                                                                              |
| `namespace_definition`                                                                                                                                                                       | [Optional[models.NamespaceDefinitionEnum]](../models/namespacedefinitionenum.md)                                                                                                             | :heavy_minus_sign:                                                                                                                                                                           | Define the location where the data will be stored in the destination                                                                                                                         |                                                                                                                                                                                              |
| `namespace_format`                                                                                                                                                                           | *Optional[str]*                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                           | 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]](../models/nonbreakingschemaupdatesbehaviorenum.md)                                                                                   | :heavy_minus_sign:                                                                                                                                                                           | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source                                                                                                     |                                                                                                                                                                                              |
| `prefix`                                                                                                                                                                                     | *Optional[str]*                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                           | 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]](../models/airbyteapiconnectionschedule.md)                                                                                                   | :heavy_minus_sign:                                                                                                                                                                           | schedule for when the the connection should run, per the schedule type                                                                                                                       |                                                                                                                                                                                              |
| `status`                                                                                                                                                                                     | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md)                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                           | N/A                                                                                                                                                                                          |                                                                                                                                                                                              |