About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Cloudant Database (cloudantDatabase)
Configuration for a Cloudant Database.
Name | Type | Default | Description |
---|---|---|---|
cloudantRef | A reference to top level cloudant element (string). | Specifies the builder for the Cloudant Client that will be used when connecting to this database. | |
create | boolean | true | Indicates that the Cloudant Client should create the database if it does not already exist. |
databaseName | string | Name of the database. | |
id | string | A unique configuration ID. | |
jndiName | string | JNDI name. |
Specifies the builder for the Cloudant Client that will be used when connecting to this database.
Name | Type | Default | Description |
---|---|---|---|
account | string | Account name used to connect to a Cloudant database. | |
containerAuthDataRef | A reference to top level authData element (string). | Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. | |
jndiName | string | JNDI name. | |
libraryRef | A reference to top level library element (string). | Specifies a library that contains the Cloudant Client library and its dependencies. | |
password | Reversably encoded password (string) | Password corresponding to your Cloudant user ID. | |
url | string | URL for the Cloudant server, which includes the host and port. | |
username | string | The Cloudant user ID used to log in and access your databases. | |
Advanced Properties | |||
connectTimeout | A period of time with millisecond precision | 5m | The timeout to establish a connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
disableSSLAuthentication | boolean | false | Disables host name verification and certificate chain validation. |
maxConnections | int | 6 | The maximum number of concurrent connections that a Cloudant Client can make to the host. |
proxyPassword | Reversably encoded password (string) | Password corresponding to the user name for a proxy server to use when connecting to a Cloudant server. | |
proxyUrl | string | The URL of a proxy server to use when connecting to a Cloudant server. | |
proxyUser | string | User name for a proxy server to use when connecting to a Cloudant server. | |
readTimeout | A period of time with millisecond precision | 5m | Timeout value to wait for a response from an established client connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. |
sslRef | A reference to top level ssl element (string). | Specifies the SSL configuration that is needed to establish a secure connection. |
Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
Specifies a library that contains the Cloudant Client library and its dependencies.
Specifies the SSL configuration that is needed to establish a secure connection.