Connection Properties - Amazon Timestream

Connection Properties

The Timestream JDBC driver supports the following options:

Note

If none of the properties are provided, the Timestream JDBC driver will use the default credentials chain to load the credentials.

Note

All property keys are case-sensitive.

Basic Authentication options

The following table describes the available Basic Authentication options.

Option Description Default

AccessKeyId

The AWS user access key id.

NONE

SecretAccessKey

The AWS user secret access key.

NONE

SessionToken

The temporary session token required to access a database with multi-factor authentication (MFA) enabled.

NONE

Standard Client Info Option

The following table describes the Standard Client Info Option.

Option Description Default

ApplicationName

The name of the application currently utilizing the connection. ApplicationName is used for debugging purposes and will not be communicated to the Timestream service.

The application name detected by the driver.

Driver Configuration Option

The following table describes the Driver Configuration Option.

Option Description Default

EnableMetaDataPreparedStatement

Enables Timestream JDBC driver to return metadata for PreparedStatements, but this will incur an additional cost with Timestream when retrieving the metadata.

FALSE

Region

The database's region.

us-east-1

SDK Option

The following table describes the SDK Option.

Option Description Default

RequestTimeout

The time in milliseconds the AWS SDK will wait for a query request before timing out. Non-positive value disables request timeout.

0

SocketTimeout

The time in milliseconds the AWS SDK will wait for data to be transferred over an open connection before timing out. Value must be non-negative. A value of 0 disables socket timeout.

50000

MaxRetryCountClient

The maximum number of retry attempts for retryable errors with 5XX error codes in the SDK. The value must be non-negative.

NONE

MaxConnections

The maximum number of allowed concurrently opened HTTP connections to the Timestream service. The value must be positive.

50

Endpoint Configuration Option

The following table describes the Endpoint Configuration Option.

Option Description Default

Endpoint

The endpoint for the Timestream service.

NONE

Credential Provider options

The following table describes the available Credential Provider options.

Option Description Default

AwsCredentialsProviderClass

One of PropertiesFileCredentialsProvider or InstanceProfileCredentialsProvider to use for authentication.

NONE

CustomCredentialsFilePath

The path to a properties file containing AWS security credentials accessKey and secretKey. This is only required if AwsCredentialsProviderClass is specified as PropertiesFileCredentialsProvider .

NONE

SAML-based authentication options for Okta

The following table describes the available SAML-based authentication options for Okta.

Option Description Default

IdpName

The Identity Provider (Idp) name to use for SAML-based authentication. One of Okta or AzureAD .

NONE

IdpHost

The host name of the specified Idp.

NONE

IdpUserName

The user name for the specified Idp account.

NONE

IdpPassword

The password for the specified Idp account.

NONE

OktaApplicationID

The unique Okta-provided ID associated with the Timestream application. AppId can be found in the entityID field provided in the application metadata. Consider the following example: entityID = http://www.okta.com//IdpAppID

NONE

RoleARN

The Amazon Resource Name (ARN) of the role that the caller is assuming.

NONE

IdpARN

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the Idp.

NONE

SAML-based authentication options for Azure AD

The following table describes the available SAML-based authentication options for Azure AD.

Option Description Default

IdpName

The Identity Provider (Idp) name to use for SAML-based authentication. One of Okta or AzureAD .

NONE

IdpHost

The host name of the specified Idp.

NONE

IdpUserName

The user name for the specified Idp account.

NONE

IdpPassword

The password for the specified Idp account.

NONE

AADApplicationID

The unique id of the registered application on Azure AD.

NONE

AADClientSecret

The client secret associated with the registered application on Azure AD used to authorize fetching tokens.

NONE

AADTenant

The Azure AD Tenant ID.

NONE

IdpARN

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the Idp.

NONE