Amazon Athena (Connection Definition File Format)

Amazon Athena connection properties are set and retrieved in the connection definition file format and stored as a .json file. A connection definition file must not exceed 25MB.

Users with the DW Integrator role can create Amazon Athena connections and set any connections properties (see Amazon Athena Connections) using connection type specific syntax. To obtain detailed information about the connection syntax, you can read an appropriate connection from your space and write the output to a file using the --get option (see Read Connection Details).

Example syntax:
Parameters are set as follows:

Parameter

Connection Property

Description

name

Technical Name

[required] Enter the technical name of the connection. The technical name can only contain alphanumeric characters and underscores (_). It cannot start or end with underscore (_). The name must be unique within the space.

region

Region

[required] Enter the AWS region in your Amazon Athena regional endpoint that you use to make your requests. For example, us-west-2.

workgroup

Workgroup

[required] Enter the name of the workgroup. Amazon Athena uses workgroups to control query access and costs. The default workgroup is primary.

authType

n/a

[required] Enter APIKey.

accessKey

Access Key

[required] Enter the access key ID of the user that the application must use to authenticate.

secretKey

Secret Key

[required] Enter the secret access key of the user that the application must use to authenticate.

businessName

Business Name

[optional] Enter a descriptive name to help users identify the object. This name can be changed at any time.

description

Description

[optional] Provide more information to help users understand the object.

package

Package

[optional] Enter an existing package to facilitate transport between tenants (see Transporting Content Between Tenants).

Default value: none