DigitalOcean Terraform Provider Reference

The DigitalOcean Terraform provider is used to interact with the resources supported by DigitalOcean. The provider needs to be configured with the proper credentials before it can be used.

For a step-by-step guide to installing and configuring Terraform, please see How to Configure Terraform for DigitalOcean.

Example Usage

terraform {
  required_providers {
    digitalocean = {
      source = "digitalocean/digitalocean"
      version = "~> 2.0"
    }
  }
}

# Set the variable value in *.tfvars file
# or using -var="do_token=..." CLI option
variable "do_token" {}

# Configure the DigitalOcean Provider
provider "digitalocean" {
  token = var.do_token
}

# Create a web server
resource "digitalocean_droplet" "web" {
  # ...
}

Argument Reference

The following arguments are supported:

  • token - (Required) This is the DO API token. Alternatively, this can also be specified using environment variables ordered by precedence:
    • DIGITALOCEAN_TOKEN
    • DIGITALOCEAN_ACCESS_TOKEN
  • spaces_access_id - (Optional) The access key ID used for Spaces API operations (Defaults to the value of the SPACES_ACCESS_KEY_ID environment variable).
  • spaces_secret_key - (Optional) The secret access key used for Spaces API operations (Defaults to the value of the SPACES_SECRET_ACCESS_KEY environment variable).
  • api_endpoint - (Optional) This can be used to override the base URL for DigitalOcean API requests (Defaults to the value of the DIGITALOCEAN_API_URL environment variable or https://api.digitalocean.com if unset).
  • spaces_endpoint - (Optional) This can be used to override the endpoint URL used for DigitalOcean Spaces requests. (It defaults to the value of the SPACES_ENDPOINT_URL environment variable or https://{{.Region}}.digitaloceanspaces.com if unset.) The provider will replace {{.Region}} (via Go’s templating engine) with the slug of the applicable Spaces region.

Resources and Data Sources

The following resources and data sources are available:

A complete reference for every resource available to the DigitalOcean Terraform provider.
A complete reference for every data source available to the DigitalOcean Terraform provider.