Configure an Amazon Redshift Spectrum Integration

This page illustrates how to configure the Amazon Redshift Spectrum integration on the Immuta app settings page. To configure this integration via the Immuta API, see the Integrations API getting started guide.

Requirements

• A Redshift cluster with an AWS row-level security patch applied. Contact Immuta for guidance.

• An AWS IAM role for Redshift that is associated with your Redshift cluster.

• The enable_case_sensitive_identifier parameter must be set to false (default setting) for your Redshift cluster.

• A Redshift database that contains an external schema and external tables. You have two options for configuring this database:

  • Configure the integration with an existing database that contains the external tables: Instead of creating an immuta database that manages all schemas and views created when Redshift data is registered in Immuta, the integration adds the Immuta-managed schemas and views to an existing database in Redshift.

  • Configure the integration by creating a new immuta database: Create a new database for Immuta that manages all schemas and views created when Redshift data is registered in Immuta, and re-create all of your external tables in that database.

Permissions

The user configuring the integration must have the permissions below.

• APPLICATION_ADMIN Immuta permission

• The Redshift role used to run the Immuta bootstrap script must have the following privileges when configuring the integration:

  • If using an existing database

    • ALL PRIVILEGES ON DATABASE for the database you configure the integration with, as you must manage grants on that database.

    • CREATE USER

    • GRANT TEMP ON DATABASE

  • If creating a new database

    • CREATE DATABASE

    • CREATE USER

    • GRANT TEMP ON DATABASE

    • REVOKE ALL PRIVILEGES ON DATABASE

  • If enabling user impersonation:

    • OWNERSHIP ON GROUP IMMUTA_IMPERSONATOR_ROLE

    • CREATE GROUP

Add a Redshift integration

Allow Immuta to create secure views of your external tables through one of these methods:

• Configure the integration with an existing database that contains the external tables: Instead of creating an immuta database that manages all schemas and views created when Redshift data is registered in Immuta, the integration adds the Immuta-managed schemas and views to an existing database in Redshift.

• Configure the integration by creating a new immuta database: Create a new database for Immuta that manages all schemas and views created when Redshift data is registered in Immuta, and re-create all of your external tables in that database.

Select a tab below for instructions for either method.

Existing database

Configure the integration with an existing database

1. Click the App Settings icon in the navigation menu.

2. Click the Integrations tab.

3. Click the +Add Integration button and select Redshift from the dropdown menu.

4. Complete the Host and Port fields.

5. Enter the name of the database you created the external schema in as the Immuta Database. This database will store all secure schemas and Immuta-created views.

6. Opt to check the Enable Impersonation box and customize the Impersonation Role name as needed. This will allow users to natively impersonate another user.

7. Select Manual and download the second bootstrap script (bootstrap script (Immuta database)) from the Setup section. The specified role used to run the bootstrap needs to have the permissions listed above for an existing database.

8. Run the bootstrap script (Immuta database) in the Redshift database that contains the external schema.

9. Choose username and password as your authentication method, and enter the credentials from the bootstrap script for the Immuta_System_Account.

10. Click Save.

New database

Edit a Redshift Spectrum integration

1. Click the App Settings icon in the navigation menu.

2. Navigate to the Integrations tab and click the down arrow next to the Redshift Spectrum integration.

3. Edit the field you want to change. Note any field shadowed is not editable, and the integration must be disabled and re-installed to change it.

4. Download the Edit Script and run it in the Immuta Database in Amazon Redshift.

5. In Immuta, enter the credentials used to initially configure the integration.

6. Click Save.

Remove a Redshift Spectrum integration

Disabling Amazon Redshift Spectrum

Disabling the Amazon Redshift Spectrum integration is not supported when you set the fields nativeWorkspaceName, nativeViewName, and nativeSchemaName to create Redshift Spectrum data sources. Disabling the integration when these fields are used in metadata ingestion causes undefined behavior.

1. Click the App Settings icon in the navigation menu.

2. Navigate to the Integrations tab and click the down arrow next to the Amazon Redshift Spectrum integration.

3. Click the checkbox to disable the integration.

4. Enter the credentials that were used to initially configure the integration.

5. Click cleanup script to download the script.

6. Click Save.

7. Run the cleanup script in Amazon Redshift.