## Crawl Amazon Redshift

URL: https://docs.atlan.com/apps/connectors/data-warehouses/amazon-redshift/how-tos/crawl-amazon-redshift

> Once you have configured the [Amazon Redshift access permissions](/apps/connectors/data-warehouses/amazon-redshift/how-tos/set-up-amazon-redshift), you can establish a connection between Atlan and Amazon Redshift.

Once you have configured the [Amazon Redshift access permissions](https://docs.atlan.com/llms/connectors/amazon-redshift/set-up-amazon-redshift/llms.txt), you can establish a connection between Atlan and Amazon Redshift.

To crawl metadata from Amazon Redshift, review the

 [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) and then complete the following steps.

## Select source

To select Amazon Redshift as your source:

1. In your Atlan workspace, click **Connectors** in the left sidebar.
 * If you are using the **Old UI (Classic)**, click **New Workflow** in the top navigation.

2. Click **Marketplace**.

3. Search for **Redshift Assets** and select it.

4. Click **Install**.

5. Once installation completes, click **Setup Workflow** on the same tile.

## Provide credentials

Choose your extraction method:

:::warning Offline extraction sunset
The offline extraction method has been sunset and is no longer available. For on-premises or network-restricted environments, use the **Agent** extraction method with [Self-Deployed Runtime](https://docs.atlan.com/llms/platform/self-deployed-runtime/llms.txt).
:::

- In **Direct** extraction, Atlan connects to your database and crawls metadata directly.

### Direct extraction method

To enter your Amazon Redshift credentials:

1. For _Host Name_, enter the host name of your Amazon Redshift instance. From your Redshift cluster you can find the host name in the _Configuration_ section as a variable called _Endpoint_.

2. For _Port_, enter the port number for your Amazon Redshift instance. You can find this next to the host name in the _Configuration_ section of your Redshift cluster.

3. For _Deployment Type_, click **Provisioned** if your Amazon Redshift instance is deployed on [provisioned clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/overview.html) or click **Serverless** if deployed on a [serverless workgroup](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-considerations.html).

4. For _Authentication_, choose the method you configured when [setting up the Amazon Redshift access permissions](https://docs.atlan.com/llms/connectors/amazon-redshift/set-up-amazon-redshift/llms.txt):
 - For **Basic** authentication, enter the _Username_ and _Password_ you configured.
 - For **IAM User** authentication, enter the _AWS Access Key_, _AWS Secret Key_, and _Username_ you configured for the database.
 - (Optional) This is only required if you are accessing a private cluster on provisioned deployment, using a Network Load Balancer (NLB), and connecting via IAM, for _Cluster ID_, enter the [name of the Amazon Redshift cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/jdbc20-configuration-options.html#jdbc20-clusterid-option) that you want to connect to.
 - (Optional) This is only required if you are accessing a private cluster on serverless deployment, for _Workgroup_, enter the [name of your workgroup](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-console-workgroups.html).
 - For **IAM Role** authentication, enter the _Username_ you configured for the database only if your deployment type is _Provisioned_. For _Serverless_ deployment type, you don't need to enter a username.
 - Set the _AWS Role ARN_ to the ARN of the [role you created in your AWS account](https://docs.atlan.com/llms/connectors/amazon-redshift/set-up-amazon-redshift/llms.txt).
 - (Optional) If your deployment type is _Serverless_ and you are accessing a private cluster, for _Workgroup_, enter the name of your [Redshift Serverless workgroup](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-console-workgroups.html). Use the same identifier you referenced in the IAM policy during [setup](https://docs.atlan.com/llms/connectors/amazon-redshift/set-up-amazon-redshift/llms.txt).
 - (Optional) For _Region_, enter the AWS region of your Amazon Redshift instance.

## Configure connection

To complete the Amazon Redshift connection configuration:

1. Provide a _Connection Name_ that represents your source environment. For example, you might want to use values like `production`, `development`, `gold`, or `analytics`.

2. (Optional) To change the users able to manage this connection, change the users or groups listed under _Connection Admins_.

 :::warning

 If you don't specify any user or group, nobody can manage the connection - not even admins.

 :::

3. (Optional) To prevent users from querying any Amazon Redshift data, change _Allow SQL Query_ to **No**.

4. (Optional) To prevent users from previewing any Amazon Redshift data, change _Allow Data Preview_ to **No**.

5. At the bottom of the screen, click the **Next** button to proceed.

## Configure crawler

Before running the Amazon Redshift crawler, you can further configure it.

You can override the defaults for any of these options:

- To select the assets you want to include in crawling, click **Include Metadata**. (This defaults to all assets, if none are specified.)
- To select the assets you want to exclude from crawling, click **Exclude Metadata**. (This defaults to no assets if none are specified.)
- To have the crawler ignore tables and views based on a naming convention, specify a regular expression in the _Exclude regex for tables & views_ field.
- (Optional) For _Advanced Config_, keep _Default_ for the default configuration or click **Advanced** to configure the crawler:
 - For _Cross Connection_, click **Yes** to extract lineage across all available Amazon Redshift connections or click **No** to limit lineage extraction to the current connection.
 - For _Control Config_, if Atlan support has provided you with a custom control configuration, select **Custom** and enter the configuration into the _Custom Config_ box. You can also:
 - Enter `{"ignore-all-case": true}` to enable crawling assets with case-sensitive identifiers.
 - If you've configured a cloned schema to provide access to Atlan, add the following key-value pair to the _Custom Config_ field:

 ```
 {"clonedPgCatalogSchema": "cloned_schema_name"}
 ```

 - Replace `cloned_schema_name` with the name of your cloned schema.
 - For _Use JDBC Internal Methods_, click **True** to enable JDBC internal methods for data extraction or click **False** to disable it.
 - For _Enable Source Level Filtering_, click **True** to enable schema-level filtering at source or click **False** to disable it.

:::info **Did you know?** 
 If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

:::

## Run crawler

To run the Amazon Redshift crawler, after completing the previous steps:

1. To check for any [permissions or other configuration issues](https://docs.atlan.com/llms/connectors/amazon-redshift/preflight-checks-for-amazon-redshift/llms.txt) before running the crawler, click **Preflight checks**.

2. You can either:
 - To run the crawler once immediately, at the bottom of the screen, click the **Run** button.
 - To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the **Schedule Run** button.

Once the crawler has completed running, the assets appear in Atlan's asset page! 🎉

---