Give Feedback

database_maintenance_window

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

Synopsis

Configure the maintenance window for a database cluster. The maintenance window specifies when DigitalOcean will perform updates and maintenance on your database cluster. 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.
`day` str / required	Choices: `monday` `tuesday` `wednesday` `thursday` `friday` `saturday` `sunday`	The day of the week for the maintenance window.
`hour` str / required		The hour of the day for the maintenance window (in UTC, 24-hour format).
`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: Set database maintenance window
  digitalocean.cloud.database_maintenance_window:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    day: sunday
    hour: "03:00"

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`maintenance_window` dict	always	Database maintenance window configuration. Sample: `{ "day": "sunday", "description": "", "hour": "03:00", "pending": false }`
`msg` str	always	Database maintenance window result information. Sample: `[ "Updated database maintenance window", "Database maintenance window would be updated" ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

maintenance_window
dict

always

Database maintenance window configuration.
Sample:

{
  "day": "sunday",
  "description": "",
  "hour": "03:00",
  "pending": false
}

msg
str