---
schema_version: "1"
id: 0528f6ea4ca3b09637f7019f3dea339e7e26116bfbc9ea4e4bf20a50c3c3b289
title: Using Anypoint Studio to Configure Amazon Redshift Connector 1.1
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/amazon-redshift-connector/1.1/amazon-redshift-connector-studio.md
canonical_url: https://docs.mulesoft.com/amazon-redshift-connector/1.1/amazon-redshift-connector-studio
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 58a6c282b43435b3c9e7c3d7140dc0ae3471e9a0f4f6e03873fb486ef45a02c7
description: MuleSoft Documentation Site
release: "1.1"
latest: false
---
---
product: Amazon Redshift Connector
version: 1.1
---

# Using Anypoint Studio to Configure Amazon Redshift Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a Source](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [View the app log](#view-app-log).

When you run the connector, you can view the app log to check for problems, as described in
[View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Anypoint Connector for Amazon Redshift (Amazon Redshift Connector) to your Mule project to
automatically populate the XML code with the connector’s namespace and schema location and add the
required dependencies to the project’s `pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In **Add Modules to Project**, type `redshift` in the search field.

3.  Click **Amazon Redshift Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Amazon Redshift Connector:

- **On Table Row**

  Select rows from a database table at a regular interval and generates one message per row that is
  obtained.

- **HTTP > Listener**

  Initiates a flow each time it receives a request on the configured host and port

- **Scheduler**

  Initiates a flow when a time-based condition is met

To configure the **On Table Row** source, follow these steps:

1.  In the **Mule Palette** view, select **Redshift**.

2.  Drag **On Table Row** to the Studio canvas.

3.  On the **On Table Row** properties window, optionally change the value of the **Display Name**
    field.

4.  Select the created connector configuration or click the plus sign (**+**) next to the
    \*Connector configuration field to configure a new global element.

    Follow the steps in [Configure a global element for the connector](#configure-global-element).

5.  On the **General** tab, complete the following fields:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Name used to reference this connector instance</p></div></div></td></tr><tr><td><p><strong>Table</strong></p></td><td><div><div><p>Name of the table to select from</p></div></div></td></tr></tbody></table>

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for <connector name>, follow these steps:

1.  In the **Mule Palette** view, select **Amazon Redshift** and then select the desired operation.

2.  Drag the operation onto the Studio canvas to the right of the source.

## Configure a Global Element for the Connector

When you configure a connector, it’s best to configure a global element that all instances of that
connector in the app can use. Configuring a global element requires you to provide the
authentication credentials that the connector requires to access the target Amazon Redshift cluster.

Amazon Redshift Connector supports:

- Basic authentication, which uses **user** and **password** field values to connect to the database

- IAM authentication, which uses **access key** and **secret key** field values to retrieve the
  temporary password for the specified user in order to connect to the database

- Optionally, you can specify the **ARN** field value in the **Role** field if the connector should
  first assume an IAM role for a set of temporary security IAM credentials and use those to retrieve
  the password.

When you configure a global element, you can reference a configuration file that contains ANT-style
property placeholders (recommended), or you can enter your authorization credentials in the global
configuration properties. For information about the benefits of using property placeholders and how
to configure them, see
[Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

To configure a global element, follow these steps:

1.  Select the name of the connector in the Studio canvas.

2.  In the configuration screen for the operation, click the plus sign (**+**) next to the
    **Connector configuration** field to access the global element configuration fields.

3.  On the **General** tab, configure the fields depending on the connection type.

    - Basic Connection

      <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Name used to reference the connector instance</p></div></div></td></tr><tr><td><p><strong>Cluster id</strong></p></td><td><div><div><p>Cluster identifier</p></div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>Region Endpoint (optional)</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Database port (optional)</p></div></div></td></tr><tr><td><p><strong>Database</strong></p></td><td><div><div><p>Database name</p></div></div></td></tr><tr><td><p><strong>User</strong></p></td><td><div><div><p>Database username</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>Password to use for authentication against the database</p></div></div></td></tr></tbody></table>

    - IAM Connection

      <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Name used to reference the connector instance</p></div></div></td></tr><tr><td><p><strong>Cluster id</strong></p></td><td><div><div><p>Cluster identifier</p></div></div></td></tr><tr><td><p><strong>Region Endpoint</strong></p></td><td><div><div><p>Region Endpoint (optional)</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Database port (optional)</p></div></div></td></tr><tr><td><p><strong>Database</strong></p></td><td><div><div><p>Database name</p></div></div></td></tr><tr><td><p><strong>User</strong></p></td><td><div><div><p>Database username</p></div></div></td></tr><tr><td><p><strong>Access key</strong></p></td><td><div><div><p>Access key provided by Amazon for retrieving temporary database credentials</p></div></div></td></tr><tr><td><p><strong>Secret key</strong></p></td><td><div><div><p>Secret key provided by Amazon for retrieving temporary database credentials</p></div></div></td></tr><tr><td><p><strong>Role</strong></p></td><td><div><div><p>Role configuration (optional)</p></div></div></td></tr><tr><td><p><strong>Custom STS Endpoint</strong></p></td><td><div><div><p>Sets a custom STS endpoint. Useful when a non-standard service endpoint is required, such as a VPC or FIPS endpoint (optional and on Advanced tab).</p></div></div></td></tr></tbody></table>

4.  Scroll down and configure the JDBC driver in the **Required libraries** section. You can choose
    to select **Use local file**, **Add recommended library**, or **Add Maven dependency**.

    If you try to select **Add recommended library** or **Add Maven dependency** and this doesn’t
    work, add the Amazon Maven repository to your `pom.xml` file and try again.

    ```xml
    <repositories>
    ...
        <repository>
            <id>redshift</id>
            <url>https://s3.amazonaws.com/redshift-maven-repository/release</url>
        </repository>
    </repositories>
    ```

5.  On the **Advanced** tab, optionally add JDBC connection properties and reconnection information,
    including a reconnection strategy.

6.  Click **Test Connection** to confirm that Mule can connect with the specified server.

7.  Click **OK**.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  OS console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## Next Step

After you configure a global element and connection information, configure the other fields for the
connector.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Amazon Redshift Connector Reference](https://docs.mulesoft.com/amazon-redshift-connector/1.1/amazon-redshift-connector-reference)

- [Salesforce Help](https://help.salesforce.com)