Configure a Solicit-Response Send Port for the CData BizTalk Adapter for Amazon Athena

This section provides step-by-step instructions for creating, configuring, and testing a static solicit-response send port using the CData BizTalk Adapter for Amazon Athena. You can use a static solicit-response send port to execute commands and access the results in BizTalk. You can use send ports to execute updategram commands, SQL commands, and stored procedure operations.

Create and Configure the Send Port

Create a static solicit-response send port and configure it to use the adapter as its transport type.

1. If you have not already done so, open your BizTalk application in the BizTalk Administration Console.
2. In the node for your BizTalk application, right-click Send Ports and select New -> Static Solicit-Response Send Port. The Send Port Properties dialog is displayed.
3. In the Send Port properties, enter a name for the receive port.
4. In the Transport Type menu, select CData.AmazonAthena;.
5. In the Send pipeline menu, select the default option, PassThruTransmit.
6. In the Receive pipeline menu, select the default option, PassThruReceive.

Configure the Adapter

Define the command the adapter will execute in the Transport Properties dialog.

1. In the send port properties, click the Configure button. The Adapter Transport Properties dialog is displayed.
2. In the CommandType property, select the command type you want.
3. If you want to execute an SQL command, enter the command in the SQL Command box.

Refer to the "Adapter Configuration" chapter in the help documentation for a description of the various properties and their functions.

Configure the Connection to Amazon Athena

Configure credentials and other properties required to connect to Amazon Athena in the Connection String Options dialog.

1. In the send port properties, click Configure. The adapter properties dialog is displayed.
2. Click the button in the Connection String property. The Connection String Options dialog is displayed.
3. Enter the connection properties. Below is a typical connection string: AccessKey='a123';SecretKey='s123';Region='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';

   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. Click Test Connection to verify the values and test connectivity.

Refer to the "Connection String Options" chapter in the help documentation for a description of the various properties and their functions. The updategram tutorial for the adapter for Amazon Athena walks through the steps to create a simple application that uses a solicit-response send port to execute an insert updategram to Amazon Athena.