DigitalOcean Create

DigitalOcean Create

Certified

Create a DigitalOcean database cluster

Creates a new managed database cluster. Provisioning typically takes several minutes; this task returns as soon as the API accepts the request, without waiting for the cluster to become online.

yaml
type: io.kestra.plugin.digitalocean.database.Create

Create a single-node Postgres cluster in nyc1

yaml
id: digitalocean_create_database
namespace: company.team

tasks:
  - id: create_database
    type: io.kestra.plugin.digitalocean.database.Create
    apiToken: "{{ secret('DIGITALOCEAN_TOKEN') }}"
    name: "prod-postgres"
    engine: "pg"
    engineVersion: "16"
    region: "nyc1"
    size: "db-s-1vcpu-1gb"
    numNodes: 1
Properties

DigitalOcean API token

Personal access token used to authenticate against the DigitalOcean API v2, sent as Authorization: Bearer <token>. Create one (prefixed dop_v1_) in the DigitalOcean control panel under API > Tokens, and store it as a Kestra secret.

Engine

Database engine, one of pg, mysql, redis, mongodb, kafka, or opensearch.

Engine version

Version of the selected engine, e.g. 16 for pg.

Database cluster name

Human-readable name for the cluster, must be unique on the account.

Region

Datacenter region slug to create the cluster in, e.g. nyc1, ams3, sgp1.

Size

Database cluster size slug, e.g. db-s-1vcpu-1gb.

Defaulthttps://api.digitalocean.com

DigitalOcean API base URL

Base endpoint for all DigitalOcean API calls. Defaults to https://api.digitalocean.com.

Default1

Number of nodes

Number of nodes in the cluster, from 1 (no standby) to 3. Defaults to 1.

HTTP client options

Optional HTTP configuration (timeouts, proxy, SSL) applied to every DigitalOcean API call.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

Database engine

One of pg, mysql, redis, mongodb, kafka, or opensearch.

Connection host

Hostname to connect to the cluster's primary connection.

Database cluster ID

UUID assigned by DigitalOcean.

Database cluster name

Connection port

Region slug

Datacenter region the cluster runs in, e.g. nyc1.

Cluster status

One of creating, online, resizing, or migrating.