TDV Adapter for Amazon Athena

Build 21.0.8160

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Basic Tab.

Authentication


PropertyDescription
AthenaVPCEndpointYour Athena VPC Endpoint. It will override the default athena.{region}.amazonaws.com endpoint.
S3StagingDirectorySpecifies the location Amazon Athena will use to store the results of a query.
EncryptionTypeSpecifies the encryption option for query results in Athena.
EncryptionKeySpecifies the encryption key when encrypting results stored in S3.
DatabaseThe name of the Athena database.
DataSourceThe name of the Athena Data Source.

Connection


PropertyDescription
CrossAccountIdThe Account Id to use when retrieving metadata from Glue. Default is current account id.
SimpleUploadLimitThis setting specifies the threshold, in bytes, above which the provider will choose to perform a multipart upload rather than uploading everything in one request.

AWS Authentication


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are: Auto, , AwsRootKeys , AwsIAMRoles , AwsEC2Roles , AwsMFA , ADFS, Okta, PingFederate , AwsCredentialsFile , AwsCognitoBasic , AwsCognitoSrp.
AWSAccessKeyYour AWS account access key. This value is accessible from your AWS security credentials page.
AWSSecretKeyYour AWS account secret key. This value is accessible from your AWS security credentials page.
AWSRoleARNThe Amazon Resource Name of the role to use when authenticating.
AWSPrincipalARNThe ARN of the SAML Identity provider in your AWS account.
AWSRegionThe hosting region for your Amazon Web Services.
AWSCredentialsFileThe path to the AWS Credentials File to be used for authentication.
AWSCredentialsFileProfileThe name of the profile to be used from the supplied AWSCredentialsFile.
AWSSessionTokenYour AWS session token.
AWSExternalIdA unique identifier that might be required when you assume a role in another account.
MFASerialNumberThe serial number of the MFA device if one is being used.
MFATokenThe temporary token available from your MFA device.
CredentialsLocationThe location of the settings file where MFA credentials are saved.
TemporaryTokenDurationThe amount of time (in seconds) a temporary token will last.
AWSCognitoRegionThe hosting region for AWS Cognito.
AWSUserPoolIdThe User Pool Id.
AWSUserPoolClientAppIdThe User Pool Client App Id.
AWSUserPoolClientAppSecretOptional. The User Pool Client App Secret.
AWSIdentityPoolIdThe Identity Pool Id.

SSO


PropertyDescription
UserThe IDP user used to authenticate the IDP via SSO.
PasswordThe password used to authenticate the IDP user via SSO.
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.
SSOExchangeUrlThe url used for consuming the SAML response and exchanging it with Amazon Athena specific credentials.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.

Miscellaneous


PropertyDescription
CleanQueryResultsAmazon Athena produces cache files with every query, in the folder specified in S3StagingDirectory . CleanQueryResults specifies whether these files should be deleted once the connection is closed.
EnableFIPSModeA boolean indicating if FIPS URLs should be enabled.
IncludeTableTypesIf set to true, the provider will query for the types of individual tables.
MaximumColumnSizeThe maximum column size.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MetadataDiscoveryMethodAPI to use to retrieve the metadata for Amazon Athena.
OtherThese hidden properties are used only in specific use cases.
PageSizeThe number of results to return per page of data retrieved from Amazon Athena.
PollingIntervalThis determines the polling interval in milliseconds to check whether the result is ready to be retrieved.
QueryCachingLevelModifies the usage of query results stored in S3StagingDirectory . Cached queries will not be scanned again by Amazon Athena until the amount of seconds specified in QueryTolerance has passed.
QueryTimeoutThe timeout in seconds for requests issued by the provider to download large result sets.
QueryToleranceSpecifies the amount of time in seconds queries cache for if QueryCachingLevel is not set to None.
ShowS3FilepathWhether or not to expose the _S3Path column for the Amazon Athena tables.
SkipHeaderLineCountSpecifies the number of header rows to skip for SELECT queries.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
WorkgroupWork group of the executed queries.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8160