AWS Lake Formation Connection Registration Payloads Reference Guide

Understand the parameters and payloads for registering a connection via the API

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 in your connection key.	Required	-
connection object	See the following object description: AWS Lake Formation connection object.	Required	-
settings object	See Settings object.	Optional	-
options object	See 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.

Attribute	Description	Required	Accepted values
technology string	The technology backing the new connection.	Yes	Glue
authenticationType string	The authentication type to register the connection.	Yes	accessKey assumedRole
region string	The region of the AWS account associated with the Glue Data Catalog.	Yes	Any valid AWS region (us-east-1, for example)
accountId string	The Amazon account ID of the Glue Data Catalog that contains the data you want to register.	Yes	-
accessKeyId string	The access key ID of an AWS account with the AWS permissions listed in the set up the Immuta service principal section.	Required if authenticationType is accessKey.	-
secretAccessKey string	The secret access key of an AWS account with the AWS permissions listed in the set up the Immuta service principal section.	Required if authenticationType is accessKey.	-
roleARN string	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.	Required if authenticationType is assumedRole.	-

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	true false
activateNewChildren boolean	If true, all new children found during object sync will be registered as active (enabled).	Optional	true false
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	true false