SecretsMountPostgresql

data class SecretsMountPostgresql(val allowedRoles: List<String>? = null, val authType: String? = null, val connectionUrl: String? = null, val data: Map<String, String>? = null, val disableAutomatedRotation: Boolean? = null, val disableEscaping: Boolean? = null, val maxConnectionLifetime: Int? = null, val maxIdleConnections: Int? = null, val maxOpenConnections: Int? = null, val name: String, val password: String? = null, val passwordAuthentication: String? = null, val pluginName: String? = null, val privateKey: String? = null, val rootRotationStatements: List<String>? = null, val rotationPeriod: Int? = null, val rotationSchedule: String? = null, val rotationWindow: Int? = null, val selfManaged: Boolean? = null, val serviceAccountJson: String? = null, val tlsCa: String? = null, val tlsCertificate: String? = null, val username: String? = null, val usernameTemplate: String? = null, val verifyConnection: Boolean? = null)

Constructors

Link copied to clipboard
constructor(allowedRoles: List<String>? = null, authType: String? = null, connectionUrl: String? = null, data: Map<String, String>? = null, disableAutomatedRotation: Boolean? = null, disableEscaping: Boolean? = null, maxConnectionLifetime: Int? = null, maxIdleConnections: Int? = null, maxOpenConnections: Int? = null, name: String, password: String? = null, passwordAuthentication: String? = null, pluginName: String? = null, privateKey: String? = null, rootRotationStatements: List<String>? = null, rotationPeriod: Int? = null, rotationSchedule: String? = null, rotationWindow: Int? = null, selfManaged: Boolean? = null, serviceAccountJson: String? = null, tlsCa: String? = null, tlsCertificate: String? = null, username: String? = null, 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 authType: String? = null

Specify alternative authorization type. (Only 'gcp_iam' is valid currently)

Link copied to clipboard
val connectionUrl: String? = null

Connection string to use to connect to the database.

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

Disable special character escaping in username and password

Link copied to clipboard

Maximum number of seconds a connection may be reused.

Link copied to clipboard
val maxIdleConnections: Int? = null

Maximum number of idle connections to the database.

Link copied to clipboard
val maxOpenConnections: Int? = null

Maximum number of open connections to the database.

Link copied to clipboard

Name of the database connection.

Link copied to clipboard
val password: String? = null

The root credential password used in the connection URL

Link copied to clipboard

When set to scram-sha-256, passwords will be hashed by Vault before being sent to PostgreSQL.

Link copied to clipboard
val pluginName: String? = null

Specifies the name of the plugin to use.

Link copied to clipboard
val privateKey: String? = null

The secret key used for the x509 client certificate. Must be PEM encoded.

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

If set, allows onboarding static roles with a rootless connection configuration.

Link copied to clipboard

A JSON encoded credential for use with IAM authorization

Link copied to clipboard
val tlsCa: String? = null

The x509 CA file for validating the certificate presented by the PostgreSQL server. Must be PEM encoded.

Link copied to clipboard
val tlsCertificate: String? = null

The x509 client certificate for connecting to the database. Must be PEM encoded.

Link copied to clipboard
val username: String? = null

The root credential username used in the connection URL

Link copied to clipboard

Username generation template.

Link copied to clipboard

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