Give Feedback

database_config

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

Configure engine-specific settings for a database cluster. Different database engines support different configuration options. This module allows you to set options like eviction policies for Redis/Valkey, SQL mode for MySQL, and other engine-specific settings. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Databases.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`cluster_id` str / required		The UUID of the database cluster.
`config` dict / required		The configuration settings for the database cluster. Settings vary by database engine.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Configure Valkey eviction policy
  digitalocean.cloud.database_config:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    config:
      redis_maxmemory_policy: allkeys-lru

- name: Configure MySQL settings
  digitalocean.cloud.database_config:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    config:
      sql_mode: TRADITIONAL
      connect_timeout: 30

- name: Configure PostgreSQL settings
  digitalocean.cloud.database_config:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    config:
      autovacuum_vacuum_cost_delay: 20
      log_min_duration_statement: 1000

Return Values

Key Returned Description

Key	Returned	Description
`config` dict	always	Database configuration settings. Sample: `{ "redis_maxmemory_policy": "allkeys-lru" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Database config result information. Sample: `[ "Updated database configuration", "Database configuration would be updated" ]`

config
dict

always

Database configuration settings.
Sample:

{
  "redis_maxmemory_policy": "allkeys-lru"
}

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str