Register an AWS Lake Formation Connection

Public preview: This connection is available to all accounts.

The connection API is a REST API that allows users to register an AWS Lake Formation to Immuta with a single set of credentials rather than configuring an integration and creating data sources separately. Then Immuta can manage and enforce access controls on your data through that connection. To manage your connection, see the Manage a connection reference guide.

Requirements

These are permissions that the user registering the connection must have in order to successfully complete setup.

• APPLICATION_ADMIN Immuta permission to register the connection

• DESCRIBE AWS permission. You must have the DESCRIBE permission on the required resources in AWS:

  • All databases that should be registered in the connection

  • All tables that should be registered in the connection

  • Any LF-Tags you are using on the resources that should be registered in the connection

• The AWS account credentials or you provide for the Immuta service principal must have permissions to perform the following actions to register data and apply policies:

  • Glue Data Catalog actions

    • glue:GetDatabase

    • glue:GetTables

    • glue:GetDatabases

    • glue:GetTable

  • Lake Formation actions

    • lakeformation:ListPermissions

    • lakeformation:BatchGrantPermissions

    • lakeformation:BatchRevokePermissions

    • lakeformation:CreateLFTag

    • lakeformation:UpdateLFTag

    • lakeformation:DeleteLFTag

    • lakeformation:AddLFTagsToResource

    • lakeformation:RemoveLFTagsFromResource

    • lakeformation:GetResourceLFTags

    • lakeformation:ListLFTags

    • lakeformation:GetLFTag

    • lakeformation:SearchTablesByLFTags

    • lakeformation:SearchDatabasesByLFTags

Prerequisites

• Data lake is set up in AWS Lake Formation. The account in which this is set up is referred to as the admin account. This is the account that you will use to initially configure IAM and AWS Lake Formation permissions to give the Immuta service principal access to perform operations. The user in this account must be able to manage IAM permissions and Lake Formation permissions for all data in the Glue Data Catalog.

• No AWS Lake Formation connections configured in the same Immuta instance for the same Glue Data Catalog.

• The databases and tables you want Immuta to govern must be configured in AWS to respect the AWS Lake Formation permissions. Immuta cannot govern resources that use IAM access control or hybrid access mode. To ensure Immuta can govern your resources, verify that the default Data Catalog settings in AWS are unchecked. See the screenshot below and AWS documentation for instructions on changing these settings:

  

  AWS Data Catalog settings must be unchecked for Immuta to govern access.
• : IDC is the best approach for user provisioning because it treats users as users, not users as roles. Consequently, access controls are enforced for the querying user, nothing more. This approach eliminates over-provisioning and permits granular access control. Furthermore, IDC uses trusted identity propagation, meaning AWS propagates a user's identity wherever that user may operate within the AWS ecosystem. As a result, a user's identity always remains known and consistent as they navigate across AWS services, which is a key requirement for organizations to properly govern that user. Enabling IDC does not impact any existing access controls; it is additive. See the map users section for instructions on mapping users from AWS IDC to user accounts in Immuta.

1. Set up the Immuta service principal

The Immuta service principal is the to perform operations in your AWS account. This role must have all the necessary permissions in AWS Glue and AWS Lake Formation to allow Immuta to register data sources and apply policies.

1. Create an AWS Account IAM role (select AWS account as the trusted entity type) that can be used by Immuta to set up the connection and orchestrate AWS Lake Formation policies. Immuta will assume this IAM role from Immuta's AWS account in order to perform any operations in your AWS account. Before proceeding, contact your Immuta representative for the AWS account to add to your trust policy. Then, complete the steps below.

2. Add the following IAM permissions to the service principal from the admin account. These permissions will allow the service principal to register data sources and apply policies on Immuta's behalf.

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": [
           "glue:GetDatabase",
           "glue:GetTables",
           "glue:GetDatabases",
           "glue:GetTable",
           "lakeformation:ListPermissions",
           "lakeformation:BatchGrantPermissions",
           "lakeformation:BatchRevokePermissions",
           "lakeformation:CreateLFTag",
           "lakeformation:UpdateLFTag",
           "lakeformation:DeleteLFTag",
           "lakeformation:AddLFTagsToResource",
           "lakeformation:RemoveLFTagsFromResource",
           "lakeformation:GetResourceLFTags",
           "lakeformation:ListLFTags",
           "lakeformation:GetLFTag",
           "lakeformation:SearchTablesByLFTags",
           "lakeformation:SearchDatabasesByLFTags"
         ],
         "Resource": "*"
       }
     ]
   }

3. Grant the service principal permissions on any tables that will be registered in Immuta. There are two ways to give the service principal these permissions: either make a new LF-Tag that gives the appropriate permissions and apply it to , or make the role a superuser in Lake Formation.

LF-Tag permissions (recommended)

This method follows the principle of least privilege and is the most flexible way of granting permissions to the service principal. LF-Tags cascade down from databases to tables, while allowing for exceptions. This means that when you apply this tag to a database, it will automatically apply to all tables within that database and allow you to remove it from any tables if those should be out of the scope of Immuta’s governance.

1. Create a new LF-Tag, giving yourself permissions to grant that tag to a user, which will ultimately be your service principal.

   1. In the Lake Formation console, navigate to LF-Tags and permissions and click Add LF-Tag.

   2. Create a tag key and value.

   3. On the LF-Tag key-value pair, grant the ASSOCIATE LF-Tag permission to your own IAM principal.

2. Grant this tag to the Immuta service principal.

   1. In the Lake Formation console, navigate to Data permissions and click Grant.

   2. Enter the service principal’s IAM role.

   3. Add the key-value pair of the tag you created in step 1.

   4. Under Table Permissions, select the following grantable permissions: SELECT, DESCRIBE, INSERT, DELETE .

   5. Click Grant.

3. Apply this LF-Tag to the resources you would like Immuta to govern. The Immuta service principal will now have the minimum required permissions on these resources. If new resources are created in AWS, you must repeat this process of applying this tag to those resources if you want Immuta to govern them.

Superuser

This option enables all Lake Formation operations on all data in the Glue Data Catalog. This is highly privileged and runs the risk of managing permissions on data you did not intend to.

This method will grant all necessary permissions to the service principal, but grants more than the service principal needs without being as flexible, since it does not allow for exceptions like the LF-Tag method. You can make the service principal a superuser on the entire catalog or specify individual resources.

1. In the Lake Formation console, navigate to Data permissions and click Grant.

2. Enter the service principal’s IAM role.

3. Select Named Data Catalog resources and input the Glue Data Catalog ID and any databases or tables you wish to specify.

4. Under Grantable permissions, select Super and click Grant.

Follow the AWS documentation to grant ALL permissions to the DataLakePrincipalIdentifier for the Immuta service principal ARN.

2. Create the connection in Immuta

POST /data/connection

Copy the request and update the <placeholder_values> with your connection details. Then submit the request.

Find descriptions of the editable attributes in the table below.

Test run

Opt to test and validate the create connection payload using a dry run:

POST /data/connection/test

Access key

curl -X 'POST' \
    'https://<your-immuta-url>/data/connection' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <your-bearer-token>' \
    -d '{
     "connectionKey": "<your-connection-key-name>",
     "connection": {
       "technology": "Glue",
       "authenticationType": "accessKey",
       "serviceARN": "<your-aws-glue-catalog-arn>",
       "accessKeyId": "<your-access-key-id>",
       "secretAccessKey": "<your-secret-access-key>"
     },
     "settings": {
        "isActive": false
     },
     "options": {
        "forceRecursiveCrawl": true
     }
    }'

AWS IAM role

curl -X 'POST' \
    'https://<your-immuta-url>/data/connection' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <your-bearer-token>' \
    -d '{
     "connectionKey": "<your-connection-key-name>",
     "connection": {
       "technology": "Glue",
       "authenticationType": "assumedRole",
       "serviceARN": "<your-aws-glue-catalog-arn>",
       "roleARN": "<your-iam-role-arn>",
       "externalId": "<external-id-provided-by-immuta>"
     },
     "settings": {
        "isActive": false
     },
     "options": {
        "forceRecursiveCrawl": true
     }
    }'

Payload parameters

Attribute	Description	Required
connectionKey string	A unique name for the connection.	Yes
connection object	Configuration attributes of the AWS Lake Formation connection.	Yes
connection.technology string	The technology backing the new connection.	Yes
connection.authenticationType string	The authentication type to register the connection.	Yes
connection.serviceARN string	The Amazon resource name of the Glue Data Catalog that contains the data you want to register.	Yes
connection.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.
connection.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.
connection.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.
connection.externalId string	The external ID provided in a condition on the trust relationship for the cross-account IAM specified above.	Optional
settings array	Specifications of the connection's settings, including active status.	No
settings.isActive boolean	When false, data objects will be inactive by default when created in Immuta. Set to false for the recommended configuration.	No
options array	Specification of the connection's default behavior for object crawls.	No
options.forceRecursiveCrawl boolean	If false, only active objects will be crawled. If true, both active and inactive data objects will be crawled; any child objects from inactive objects will be set as inactive. Set to true for the recommended configuration.	No

Response schema

Attribute	Description
objectPath string	The list of names that uniquely identify the path to a data object in the remote platform's hierarchy. The first element should be the associated connectionKey.
bulkId string	A bulk ID that can be used to search for the status of background jobs triggered by this request.

Example response

{
  "objectPath": ['<your-connection-key-name>'],
  "bulkId": "a-new-uuid"
}