TDV Adapter for Amazon DynamoDB

Build 21.0.8137

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.

AWS Authentication


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are: Auto, , AwsRootKeys , AwsIAMRoles , AwsEC2Roles , AwsMFA , ADFS, Okta, PingFederate , AwsCredentialsFile , AwsCognitoBasic , AwsCognitoSrp.
DomainYour AWS domain name. You can optionally choose to associate your domain name with AWS.
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.
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 DynamoDB 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
AutoDetectIndexA boolean indicating if secondary indexes should be automatically detected based on the query used.
FlattenArraysBy default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
FlexibleSchemaSet FlexibleSchema to true to scan for additional metadata on the query result set. Otherwise, the metadata will remain the same.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
IgnoreTypesRemoves support for the specified types. For example, Time. These types will then be reported as strings instead.
MaximumRequestRetriesThe maximum number of times to retry a request.
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.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Amazon DynamoDB.
ReadonlyYou can use this property to enforce read-only access to Amazon DynamoDB from the provider.
RetryWaitTimeThe minimum number of milliseconds the provider will wait to retry a request.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
SeparatorCharacterThe character or characters used to denote hierarchy.
ThreadCountThe number of threads to use when selecting data via a parallel scan. Setting ThreadCount to 1 will disable parallel scans.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeDetermines how to determine the data type of columns.
UseBatchWriteItemOperationWhen enabled the provider will use BatchWriteItem operation for handling updates and inserts. By default, the provider uses ExecuteStatement/BatchExecuteStatement operation. You need to enable BatchWriteItem only when inserting/updating binary/binary-set data. ExecuteStatement/BatchExecuteStatement doesn't support manipulating binary fields.
UseConsistentReadsWhether to alyways use Consistent Reads or not when querying DynamoDb.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.

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