Give Feedback

droplet_autoscale_pool

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

Synopsis

Create or delete Droplet Autoscale Pools. Droplet Autoscale Pools allow you to automatically scale the number of Droplets in a pool based on resource utilization or scheduled times. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplet-Autoscale-Pools.

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.
`config` dict		Configuration for the autoscale pool.
`droplet_template` dict		Template for creating Droplets in the pool.
`id` str		The unique identifier of the Droplet Autoscale Pool. Used for lookup when deleting or updating.
`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 Droplet Autoscale 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`

Examples

- name: Create Droplet Autoscale Pool
  digitalocean.cloud.droplet_autoscale_pool:
    token: "{{ token }}"
    state: present
    name: my-autoscale-pool
    config:
      min_instances: 1
      max_instances: 10
      target_cpu_utilization: 0.7
      cooldown_minutes: 5
    droplet_template:
      size: s-1vcpu-1gb
      region: nyc1
      image: ubuntu-22-04-x64
      ssh_keys:
        - "{{ ssh_key_id }}"

- name: Delete Droplet Autoscale Pool
  digitalocean.cloud.droplet_autoscale_pool:
    token: "{{ token }}"
    state: absent
    name: my-autoscale-pool

Return Values

Key Returned Description

Key	Returned	Description
`droplet_autoscale_pool` dict	always	Droplet Autoscale Pool information. Sample: `{ "config": { "cooldown_minutes": 5, "max_instances": 10, "min_instances": 1, "target_cpu_utilization": 0.7 }, "created_at": "2020-03-13T19:20:47.442049222Z", "current_utilization": { "cpu": 0.45, "memory": 0.32 }, "droplet_template": { "image": "ubuntu-22-04-x64", "region": "nyc1", "size": "s-1vcpu-1gb" }, "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "my-autoscale-pool", "status": "active" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Droplet Autoscale Pool result information. Sample: `[ "Created Droplet Autoscale Pool my-autoscale-pool", "Deleted Droplet Autoscale Pool my-autoscale-pool", "Droplet Autoscale Pool my-autoscale-pool would be created", "Droplet Autoscale Pool my-autoscale-pool exists", "Droplet Autoscale Pool my-autoscale-pool does not exist" ]`

droplet_autoscale_pool
dict

always

Droplet Autoscale Pool information.
Sample:

{
  "config": {
    "cooldown_minutes": 5,
    "max_instances": 10,
    "min_instances": 1,
    "target_cpu_utilization": 0.7
  },
  "created_at": "2020-03-13T19:20:47.442049222Z",
  "current_utilization": {
    "cpu": 0.45,
    "memory": 0.32
  },
  "droplet_template": {
    "image": "ubuntu-22-04-x64",
    "region": "nyc1",
    "size": "s-1vcpu-1gb"
  },
  "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
  "name": "my-autoscale-pool",
  "status": "active"
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str