SecretsMountCouchbase

data class SecretsMountCouchbase(val allowedRoles: List<String>? = null, val base64Pem: String? = null, val bucketName: String? = null, val data: Map<String, String>? = null, val disableAutomatedRotation: Boolean? = null, val hosts: List<String>, val insecureTls: Boolean? = null, val name: String, val password: String, val pluginName: String? = null, val rootRotationStatements: List<String>? = null, val rotationPeriod: Int? = null, val rotationSchedule: String? = null, val rotationWindow: Int? = null, val tls: Boolean? = null, val username: String, val usernameTemplate: String? = null, val verifyConnection: Boolean? = null)

Constructors

Link copied to clipboard
constructor(allowedRoles: List<String>? = null, base64Pem: String? = null, bucketName: String? = null, data: Map<String, String>? = null, disableAutomatedRotation: Boolean? = null, hosts: List<String>, insecureTls: Boolean? = null, name: String, password: String, pluginName: String? = null, rootRotationStatements: List<String>? = null, rotationPeriod: Int? = null, rotationSchedule: String? = null, rotationWindow: Int? = null, tls: Boolean? = null, username: String, usernameTemplate: String? = null, verifyConnection: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val allowedRoles: List<String>? = null

A list of roles that are allowed to use this connection.

Link copied to clipboard
val base64Pem: String? = null

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

Link copied to clipboard
val bucketName: String? = null

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

Link copied to clipboard
val data: Map<String, String>? = null

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

Link copied to clipboard

Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Supported list of database secrets engines that can be configured:

Link copied to clipboard

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

Link copied to clipboard
val insecureTls: Boolean? = null

Specifies whether to skip verification of the server certificate when using TLS.

Link copied to clipboard

Name of the database connection.

Link copied to clipboard

Specifies the password corresponding to the given username.

Link copied to clipboard
val pluginName: String? = null

Specifies the name of the plugin to use.

Link copied to clipboard

A list of database statements to be executed to rotate the root user's credentials.

Link copied to clipboard
val rotationPeriod: Int? = null

The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.

Link copied to clipboard

The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.

Link copied to clipboard
val rotationWindow: Int? = null

The maximum amount of time in seconds allowed to complete a rotation when a scheduled token rotation occurs. The default rotation window is unbound and the minimum allowable window is 3600. Requires Vault Enterprise 1.19+.

Link copied to clipboard
val tls: Boolean? = null

Specifies whether to use TLS when connecting to Couchbase.

Link copied to clipboard

Specifies the username for Vault to use.

Link copied to clipboard

Template describing how dynamic usernames are generated.

Link copied to clipboard

Whether the connection should be verified on initial configuration or not.