Give Feedback

database_db

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

Synopsis

Create or delete databases within a managed 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.
`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.
`name` str / required		The name of the database.
`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: Create database
  digitalocean.cloud.database_db:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: my_database

- name: Delete database
  digitalocean.cloud.database_db:
    token: "{{ token }}"
    state: absent
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: my_database

Return Values

Key Returned Description

Key	Returned	Description
`db` dict	always	Database information. Sample: `{ "name": "my_database" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Database result information. Sample: `[ "Created database my_database", "Deleted database my_database", "Database my_database would be created", "Database my_database exists", "Database my_database does not exist" ]`

db
dict

always

Database information.
Sample:

{
  "name": "my_database"
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str