Give Feedback

database_replica

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

Synopsis

Create or delete read-only replicas for a database cluster. Read-only replicas allow you to increase read throughput by offloading read queries to replica nodes. 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 read-only replica.
`region` str		The slug identifier for the region where the replica will be created.
`size` str		The slug identifier for the size of the replica node.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`tags` list / elements=str		An array of tags to apply to the replica.
`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 replica
  digitalocean.cloud.database_replica:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: read-replica-nyc1
    region: nyc1
    size: db-s-1vcpu-1gb

- name: Delete database replica
  digitalocean.cloud.database_replica:
    token: "{{ token }}"
    state: absent
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    name: read-replica-nyc1

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	Database replica result information. Sample: `[ "Created database replica read-replica-nyc1", "Deleted database replica read-replica-nyc1", "Database replica read-replica-nyc1 would be created", "Database replica read-replica-nyc1 exists", "Database replica read-replica-nyc1 does not exist" ]`
`replica` dict	always	Database replica information. Sample: `{ "connection": { "host": "read-replica-nyc1.db.ondigitalocean.com", "password": "example-password", "port": 25060, "ssl": true, "uri": "postgres://doadmin:example-password@...", "user": "doadmin" }, "created_at": "2020-03-13T19:20:47.442049222Z", "name": "read-replica-nyc1", "region": "nyc1", "status": "online" }`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Database replica result information.
Sample:

[
  "Created database replica read-replica-nyc1",
  "Deleted database replica read-replica-nyc1",
  "Database replica read-replica-nyc1 would be created",
  "Database replica read-replica-nyc1 exists",
  "Database replica read-replica-nyc1 does not exist"
]

replica
dict