Deploy CData Mule Connectors (On-Premise or to the Cloud)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Amazon Athena MuleSoft Connector



Embed the CData MuleSoft Connector for Amazon Athena in a Mule Application and deploy it to the MuleSoft CloudHub or an on-premise server.

The CData Mule Connector for Amazon Athena connects Amazon Athena data to Mule applications enabling read, write, update, and delete functionality with familiar SQL queries. The Connector allows users to easily create Mule applications with access to live Amazon Athena data that can be deployed to an on-premise server for internal access or to the MuleSoft CloudHub for direct cloud access.

Add Amazon Athena Connectivity to Mule Apps

This article walks through embedding the CData Mule Connector for Amazon Athena in an application and deploying the application to MuleSoft CloudHub and to on-premise servers. You will need Mule and Anypoint Studio installed, in addition to the CData Amazon Athena Connector.

Embed Amazon Athena Connectivity

The steps below outline adding the Amazon Athena Connector to your project and configuring the connection and connector.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add a CData Amazon Athena Connector to the application.
  3. Create a new Connection (or edit an existing one) and configure the properties to connect to Amazon Athena (see below). Once the connection is configured, click Test Connection to ensure the connectivity to Amazon Athena.

    Authenticating to Amazon Athena

    To authorize Amazon Athena requests, provide the credentials for an administrator account or for an IAM user with custom permissions: Set AccessKey to the access key Id. Set SecretKey to the secret access key.

    Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.

    Obtaining the Access Key

    To obtain the credentials for an IAM user, follow the steps below:

    1. Sign into the IAM console.
    2. In the navigation pane, select Users.
    3. To create or manage the access keys for a user, select the user and then select the Security Credentials tab.

    To obtain the credentials for your AWS root account, follow the steps below:

    1. Sign into the AWS Management console with the credentials for your root account.
    2. Select your account name or number and select My Security Credentials in the menu that is displayed.
    3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

    Authenticating from an EC2 Instance

    If you are using the CData Data Provider for Amazon Athena 2018 from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM Role to authenticate. To do so, set UseEC2Roles to true and leave AccessKey and SecretKey empty. The CData Data Provider for Amazon Athena 2018 will automatically obtain your IAM Role credentials and authenticate with them.

    Authenticating as an AWS Role

    In many situations it may be preferable to use an IAM role for authentication instead of the direct security credentials of an AWS root user. An AWS role may be used instead by specifying the RoleARN. This will cause the CData Data Provider for Amazon Athena 2018 to attempt to retrieve credentials for the specified role. If you are connecting to AWS (instead of already being connected such as on an EC2 instance), you must additionally specify the AccessKey and SecretKey of an IAM user to assume the role for. Roles may not be used when specifying the AccessKey and SecretKey of an AWS root user.

    Authenticating with MFA

    For users and roles that require Multi-factor Authentication, specify the MFASerialNumber and MFAToken connection properties. This will cause the CData Data Provider for Amazon Athena 2018 to submit the MFA credentials in a request to retrieve temporary authentication credentials. Note that the duration of the temporary credentials may be controlled via the TemporaryTokenDuration (default 3600 seconds).

    Connecting to Amazon Athena

    In addition to the AccessKey and SecretKey properties, specify Database, S3StagingDirectory and Region. Set Region to the region where your Amazon Athena data is hosted. Set S3StagingDirectory to a folder in S3 where you would like to store the results of queries.

    If Database is not set in the connection, the data provider connects to the default database set in Amazon Athena.

  4. Configure the CData Amazon Athena Connector with the Operation, Query type, and SQL query.
  5. Finish and save your application.

Once you have completed your application, you can use Anypoint Studio in conjunction with Anypoint Platform to deploy the application to your MuleSoft CloudHub instance or an on-premise server.

Deploy to MuleSoft CloudHub

  1. Right-click your Project and select Anypoint Platform -> Deploy to Cloud
  2. Configure the deployment and click "Deploy Application"
  3. When the deployment completes, navigate to the Anypoint Platform Runtime Manager to manage the deployed application

Once the application is deployed, you will be able to access it from anywhere on the web by navigating to the App URL, adding any parameters needed.

Deploy to an On-Premise Server

In order to deploy a Mule application to an on-premise server through the Anypoint Platform, you will need to have a Mule server instance installed on the machine. The steps below walk through adding the on-premise server to Anypoint Platform and deploying the Mule application.

Add the On-Premise Mule Server to Anypoint Platform

  1. Stop your on-premise Mule server (if it is currently running)
  2. Navigate to the Anypoint Platform and click Add Server to see the command for adding a server, including the security token.
  3. Setup the MuleSoft Runtime Manager Agent (on Windows, run amc_setup.bat ... ).

    %MULE_HOME%\bin> amc_setup -H 12ab3cd4-567e-8fa9-0123-4b56c7de8901---234567 MYSERVER
  4. Start the on-premise Mule Server (on Windows, run mule.bat ).

    %MULE_HOME%\bin> mule

Deploy the Mule Application

  1. In Anypoint Studio, right-click the project -> Export
    • In the Mule folder, choose "Anypoint Studio Project to Mule Deployable Archive" and click "Next" to create the deployable file
  2. In the Anypoint Platform Runtime Manager, navigate to Applications and click Deploy Application
    • Name the application
    • Select the on-premise server as the Deployment Target
    • Under "Application File," click "Choose file" -> "Upload file" and select the project you exported
    • Click "Deploy Application"

Once the application is deployed to the on-premise server, you will be able to access it from any browser with access to the server. Simply navigate to the server address and port, adding any URL parameters needed for the application.

At this point, you have deployed a Mule Application for working with Amazon Athena data. Download a free, 30 day trial of the Mule Connector for Amazon Athena and see the CData difference in your Mule applications today.