SecretsMountElasticsearch

data class SecretsMountElasticsearch(val allowedRoles: List<String>? = null, val caCert: String? = null, val caPath: String? = null, val clientCert: String? = null, val clientKey: String? = null, val data: Map<String, String>? = null, val disableAutomatedRotation: Boolean? = null, val insecure: 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 tlsServerName: String? = null, val url: String, val username: String, val usernameTemplate: String? = null, val verifyConnection: Boolean? = null)

Constructors

Link copied to clipboard
constructor(allowedRoles: List<String>? = null, caCert: String? = null, caPath: String? = null, clientCert: String? = null, clientKey: String? = null, data: Map<String, String>? = null, disableAutomatedRotation: Boolean? = null, insecure: Boolean? = null, name: String, password: String, pluginName: String? = null, rootRotationStatements: List<String>? = null, rotationPeriod: Int? = null, rotationSchedule: String? = null, rotationWindow: Int? = null, tlsServerName: String? = null, url: String, 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 caCert: String? = null

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity

Link copied to clipboard
val caPath: String? = null

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity

Link copied to clipboard
val clientCert: String? = null

The path to the certificate for the Elasticsearch client to present for communication

Link copied to clipboard
val clientKey: String? = null

The path to the key for the Elasticsearch client to use for communication

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
val insecure: Boolean? = null

Whether to disable certificate verification

Link copied to clipboard

Name of the database connection.

Link copied to clipboard

The password to be used in the connection URL

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 tlsServerName: String? = null

This, if set, is used to set the SNI host when connecting via TLS

Link copied to clipboard
val url: String

The URL for Elasticsearch's API

Link copied to clipboard

The username to be used in the connection URL

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.