> For the complete documentation index, see [llms.txt](https://documentation.immuta.com/saas/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.immuta.com/saas/developer-guides/api-intro/connections-api/connection-registration-payloads-reference-guide.md).

# Connection Registration Payloads Reference Guide

The parameters for configuring a connection in Immuta are outlined in the table below.

| Attribute                  | Description                                                                                                                                             | Required or optional | Accepted values |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | --------------- |
| **connectionKey** `string` | A unique name for the connection. Avoid the use of periods (`.`) or [restricted words](#user-content-fn-1)[^1] in your connection key.                  | Required             | -               |
| **connection** `object`    | <p>See the following object description:</p><ul><li><a href="#aws-lake-formation-connection-object">AWS Lake Formation connection object</a>.</li></ul> | Required             | -               |
| **settings** `object`      | See [Settings object](#settings-object).                                                                                                                | Optional             | -               |
| **options** `object`       | See [Options object](#options-object).                                                                                                                  | Optional             | -               |

## Connection object

The connection object configures the connection between the technology and Immuta. The section below outlines the child parameters specific to each technology.

### AWS Lake Formation connection object

The **connection** object configures the AWS Lake Formation connection information. The table below outlines its child parameters.

<table><thead><tr><th width="192">Attribute</th><th width="245">Description</th><th>Required</th><th>Accepted values</th></tr></thead><tbody><tr><td><strong>technology</strong> <code>string</code></td><td>The technology backing the new connection.</td><td><strong>Yes</strong></td><td><ul><li><code>Glue</code></li></ul></td></tr><tr><td><strong>authenticationType</strong> <code>string</code></td><td>The authentication type to register the connection.</td><td><strong>Yes</strong></td><td><ul><li><code>accessKey</code></li><li><code>assumedRole</code></li></ul></td></tr><tr><td><strong>region</strong> <code>string</code></td><td>The region of the AWS account associated with the Glue Data Catalog.</td><td><strong>Yes</strong></td><td>Any valid AWS region (us-east-1, for example)</td></tr><tr><td><strong>accountId</strong> <code>string</code></td><td>The Amazon account ID of the Glue Data Catalog that contains the data you want to register.</td><td><strong>Yes</strong></td><td>-</td></tr><tr><td><strong>accessKeyId</strong> <code>string</code></td><td>The access key ID of an AWS account with the <a href="#id-1.-set-up-the-immuta-service-principal">AWS permissions listed in the set up the Immuta service principal section</a>.</td><td>Required if <strong>authenticationType</strong> is <code>accessKey</code>.</td><td>-</td></tr><tr><td><strong>secretAccessKey</strong> <code>string</code></td><td>The secret access key of an AWS account with the <a href="#id-1.-set-up-the-immuta-service-principal">AWS permissions listed in the set up the Immuta service principal section</a>.</td><td>Required if <strong>authenticationType</strong> is <code>accessKey</code>.</td><td>-</td></tr><tr><td><strong>roleARN</strong> <code>string</code></td><td>The Amazon resource name of the role Immuta will assume from Immuta's AWS account in order to perform any operations in your AWS account.</td><td>Required if <strong>authenticationType</strong> is <code>assumedRole</code>.</td><td>-</td></tr></tbody></table>

## Settings object

The **settings** object configures connection settings. The table below outlines its child parameters.

| Attribute                         | Description                                                                                                                                                             | Required or optional | Accepted values                                                |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------- |
| **isActive** `boolean`            | If `true`, data objects will be active (enabled) by default when created in Immuta.                                                                                     | Optional             | <ul><li><code>true</code></li><li><code>false</code></li></ul> |
| **activateNewChildren** `boolean` | If `true`, all new children found during object sync will be registered as active (enabled).                                                                            | Optional             | <ul><li><code>true</code></li><li><code>false</code></li></ul> |
| **dataOwners** `array`            | A list of users and groups that are data owners on the connection. These users will be data owners for all the data sources under the data object they are assigned to. | Optional             | -                                                              |

## Options object

The **options** object configures an option for your connection. The table below outlines its child parameter.

| Attribute                         | Description                                                                                      | Required or optional | Accepted values                                                |
| --------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------- | -------------------------------------------------------------- |
| **forceRecursiveCrawl** `boolean` | When `true`, both active (enabled) and inactive (disabled) objects will be found by object sync. | Optional             | <ul><li><code>true</code></li><li><code>false</code></li></ul> |

[^1]: Your display name cannot be any of the following words: `data`, `connection`, `object`, `crawl`, `search`, `settings`, `metadata`, `permission`, `sync`, `bulk`, and `upgrade`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.immuta.com/saas/developer-guides/api-intro/connections-api/connection-registration-payloads-reference-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.