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.


Auth Scheme The scheme used for authentication. Accepted entries are: Auto, , AwsRootKeys , AwsIAMRoles , AwsEC2Roles , AwsMFA , AwsCredentialsFile.
Auto Detect Index A boolean indicating if secondary indexes should be automatically detected based on the query used.
AWS Access Key Your AWS account access key. This value is accessible from your AWS security credentials page.
AWS Credentials File The path to the AWS Credentials File to be used for authentication.
AWS Credentials File Profile The name of the profile to be used from the supplied AWSCredentialsFile.
AWS External Id A unique identifier that might be required when you assume a role in another account.
AWS Region The hosting region for your Amazon Web Services.
AWS Role ARN The Amazon Resource Name of the role to use when authenticating.
AWS Secret Key Your AWS account secret key. This value is accessible from your AWS security credentials page.
AWS Session Token Your AWS session token.
Buffer Size Determines the internal buffer size to fill up to before returning results.
Credentials Location The location of the settings file where MFA credentials are saved.
Domain Your AWS domain name. You can optionally choose to associate your domain name with AWS.
Firewall Password A password used to authenticate to a proxy-based firewall.
Firewall Port The TCP port for a proxy-based firewall.
Firewall Server The name or IP address of a proxy-based firewall.
Firewall Type The protocol used by a proxy-based firewall.
Firewall User The user name to use to authenticate with a proxy-based firewall.
Flatten Arrays By 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.
Flatten Objects Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
Generate Schema Files Indicates the user preference as to when schemas should be generated and saved.
Insert Mode How to handle values when inserting if the same primary key combination already exists in DynamoDB.
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
Log Modules Core modules to be included in the log file.
Maximum Request Retries The maximum number of times to retry a request.
Max Rows Limits 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.
MFA Serial Number The serial number of the MFA device if one is being used.
MFA Token The temporary token available from your MFA device.
Number Column Mode Specifies how to handle detected number columns. DynamoDB returns number values with a total precision of 38.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Amazon DynamoDB.
Proxy Auth Scheme The authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto Detect This 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.
Proxy Exceptions A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy Password A password to be used to authenticate to the ProxyServer proxy.
Proxy Port The TCP port the ProxyServer proxy is running on.
Proxy Server The hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL Type The SSL type to use when connecting to the ProxyServer proxy.
Proxy User A user name to be used to authenticate to the ProxyServer proxy.
Readonly You can use this property to enforce read-only access to Amazon DynamoDB from the provider.
Retry Wait Time The minimum number of milliseconds the provider will wait to retry a request.
Row Scan Depth The maximum number of rows to scan to look for the columns available in a table.
Separator Character The character or characters used to denote hierarchy.
SSL Server Cert The certificate to be accepted from the server when connecting using TLS/SSL.
Temporary Token Duration The amount of time (in seconds) a temporary token will last.
Thread Count The number of threads to use when selecting data via a parallel scan. Setting ThreadCount to 1 will disable parallel scans.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
Type Detection Scheme Determines how to determine the data type of columns.
Use Consistent Reads Whether to alyways use Consistent Reads or not when querying DynamoDb.
Use Simple Names Boolean determining if simple names should be used for tables and columns.