---
module: database_connection
short_description: Manage database secrets engine connections in HashiCorp Vault.
version_added: 1.2.0
author: my-name
description:
- This module manages (create, update, delete, and reset) the lifecycle of database
connection configurations within the HashiCorp Vault Database secrets engine.
options:
state:
description:
- Goal state for the database connection.
- Use V(present) to create or update the connection.
- Use V(reset) to trigger a connection reset.
- Use V(absent) to remove the connection configuration.
choices: [present, absent, reset]
default: present
type: str
database_mount_path:
description: Database secret engine mount path.
type: str
default: database
aliases: [vault_database_mount_path]
name:
description: The name of the database connection configuration.
required: true
type: str
aliases: [connection_name]
username:
description:
- The username to connect to the database.
required: false
type: str
aliases: [connection_username]
password:
description:
- The password to connect to the database.
required: false
type: str
aliases: [connection_password]
disable_escaping:
description: Determines whether special characters in the username and password fields will be escaped.
type: bool
default: false
connection_url:
description: The connection string used to connect to the database.
type: str
plugin_name:
description:
- The name of the plugin to use for this connection.
- Required when O(state=present).
required: false
type: str
plugin_version:
description:
- The semantic version of the plugin to use for this connection.
type: str
required: false
plugin_options:
description:
- Additional parameters specific to the plugin.
- This should be a dictionary of options required by the specific database plugin.
type: dict
verify_connection:
description: Specifies if the connection is verified during initial configuration.
default: true
type: bool
allowed_roles:
description: A list of roles authorized to use this connection.
type: list
elements: str
root_rotation_statements:
description:
- Specifies the database statements to be executed to rotate the root user's credentials.
- Refer to the specific Vault database plugin documentation for supported formatting.
type: list
elements: str
password_policy:
description:
- The name of the password policy to use when generating passwords for this database.
- If not specified, Vault uses a default policy (20 characters, mixed case, number, dash).
type: str
extends_documentation_fragment:
- hashicorp.vault.vault_auth.modules