Give Feedback

database_connection_pool

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

Synopsis

Create or delete connection pools for PostgreSQL database clusters. Connection pools can be used to allow a database to share its idle connections. 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.
`db` str / required		The database for use with the connection pool.
`mode` str	Choices: `session` `transaction` (default) `statement`	The PgBouncer transaction mode for the connection pool.
`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 connection pool.
`size` int	Default: `10`	The desired size of the PgBouncer connection pool.
`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`
`user` str / required		The name of the user for use with the connection pool.

Examples

- name: Create connection pool
  digitalocean.cloud.database_connection_pool:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: my_pool
    mode: transaction
    size: 10
    db: defaultdb
    user: doadmin

- name: Delete connection pool
  digitalocean.cloud.database_connection_pool:
    token: "{{ token }}"
    state: absent
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: my_pool
    db: defaultdb
    user: doadmin

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Connection pool result information. Sample: `[ "Created connection pool my_pool", "Deleted connection pool my_pool", "Connection pool my_pool would be created", "Connection pool my_pool exists", "Connection pool my_pool does not exist" ]`
`pool` dict	always	Connection pool information. Sample: `{ "connection": { "database": "my_pool", "host": "host.db.ondigitalocean.com", "password": "example-password", "port": 25061, "ssl": true, "uri": "postgres://doadmin:example-password@...", "user": "doadmin" }, "db": "defaultdb", "mode": "transaction", "name": "my_pool", "size": 10, "user": "doadmin" }`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Connection pool result information.
Sample:

[
  "Created connection pool my_pool",
  "Deleted connection pool my_pool",
  "Connection pool my_pool would be created",
  "Connection pool my_pool exists",
  "Connection pool my_pool does not exist"
]

pool
dict