View a markdown version of this page

Options for JDBC driver version 2.x configuration - Amazon Redshift
AccessKeyIDAllowDBUserOverrideApp_IDApp_NameApplicationNameAuthProfileAutoCreateClient_IDClient_SecretClusterIDCompressionconnectTimeoutconnectionTimezonedatabaseMetadataCurrentDbOnlyDbUserDbGroupsDBNAMEdefaultRowFetchSizeDisableIsValidQueryenableFetchRingBufferenableMultiSqlSupportEnableTableTypesfetchRingBufferSizeForceLowercasegroupFederationHOSTIAMDisableCacheIAMDurationIdc_Client_Display_NameIdc_RegionIdP_HostIdP_PartitionIdP_PortIdP_TenantIdP_Response_TimeoutIniFileIniSectionisServerlessIssuer_UrlListen_PortLogin_URLloginTimeoutloginToRpLogLevelLogPathOverrideSchemaPatternTypePartner_SPIDPasswordPlugin_NamePORTpreferPQPreferred_RoleProfilePWDqueryGroupreadOnlyRegionreWriteBatchedInsertsreWriteBatchedInsertsSizeroleArnroleSessionNamescopeSecretAccessKeySessionTokenserverlessAcctIdserverlessWorkGroupsocketFactorysocketTimeoutSSLSSL_InsecureSSLCertSSLFactorySSLKeySSLModeSSLPasswordSSLRootCertStsEndpointUrltcpKeepAlivetokentoken_typeUIDUserwebIdentityToken

Amazon Redshift will no longer support the use of Python UDFs after June 30, 2026. We will start enforcing it in phases. For more information on the details of Python end of life and migration options, see the blog post that was published on June 30, 2025.

Options for JDBC driver version 2.x configuration

Following, you can find descriptions for the options that you can specify for version 2.x of the Amazon Redshift JDBC driver. Configuration options are not case sensitive.

You can set configuration properties using the connection URL. For more information, see Building the connection URL.

AccessKeyID

  • Default Value – None

  • Data Type – String

You can specify this parameter to enter the IAM access key for the user or role. You can usually locate the key by looking at and existing string or user profile. If you specify this parameter, you must also specify the SecretAccessKey parameter. If passed in the JDBC URL, AccessKeyID must be URL encoded.

This parameter is optional.

AllowDBUserOverride

  • Default Value – 0

  • Data Type – String

This option specifies whether the driver uses the DbUser value from the SAML assertion or the value that is specified in the DbUser connection property in the connection URL.

This parameter is optional.

1

The driver uses the DbUser value from the SAML assertion.

If the SAML assertion doesn't specify a value for DBUser, the driver uses the value specified in the DBUser connection property. If the connection property also doesn't specify a value, the driver uses the value specified in the connection profile.

0

The driver uses the DBUser value specified in the DBUser connection property.

If the DBUser connection property doesn't specify a value, the driver uses the value specified in the connection profile. If the connection profile also doesn't specify a value, the driver uses the value from the SAML assertion.

App_ID

  • Default Value – None

  • Data Type – String

The Okta-provided unique ID associated with your Amazon Redshift application.

This parameter is required if authenticating through the Okta service.

App_Name

  • Default Value – None

  • Data Type – String

The name of the Okta application that you use to authenticate the connection to Amazon Redshift.

This parameter is optional.

ApplicationName

  • Default Value – null

  • Data Type – String

The name of the application to pass to Amazon Redshift for audit purposes.

This parameter is optional.

AuthProfile

  • Default Value – None

  • Data Type – String

The name of the authentication profile to use for connecting to Amazon Redshift.