Give Feedback

vpc_peering

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

Synopsis

Create or delete VPC Peerings. VPC Peerings join two VPC networks with a secure, private connection. This allows resources in those networks to connect to each other’s private IP addresses as if they were in the same network. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-Peerings.

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.
`id` str		The unique identifier of the VPC Peering. 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 VPC Peering. Must be unique and may only contain alphanumeric characters, dashes, and periods.
`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`
`vpc_ids` list / elements=str		An array of two VPC IDs that the peering will connect. Required when creating a new VPC Peering.

Examples

- name: Create VPC Peering
  digitalocean.cloud.vpc_peering:
    token: "{{ token }}"
    state: present
    name: my-vpc-peering
    vpc_ids:
      - 5a4981aa-9653-4bd1-bef5-d6bff52042e4
      - 9a4981aa-9653-4bd1-bef5-d6bff52042e5

- name: Delete VPC Peering by name
  digitalocean.cloud.vpc_peering:
    token: "{{ token }}"
    state: absent
    name: my-vpc-peering

- name: Delete VPC Peering by ID
  digitalocean.cloud.vpc_peering:
    token: "{{ token }}"
    state: absent
    name: my-vpc-peering
    id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4

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	VPC Peering result information. Sample: `[ "Created VPC Peering my-vpc-peering (5a4981aa-9653-4bd1-bef5-d6bff52042e4)", "Deleted VPC Peering my-vpc-peering (5a4981aa-9653-4bd1-bef5-d6bff52042e4)", "VPC Peering my-vpc-peering would be created", "VPC Peering my-vpc-peering (5a4981aa-9653-4bd1-bef5-d6bff52042e4) exists", "VPC Peering my-vpc-peering does not exist" ]`
`vpc_peering` dict	always	VPC Peering information. Sample: `{ "created_at": "2020-03-13T19:20:47.442049222Z", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "my-vpc-peering", "status": "ACTIVE", "vpc_ids": [ "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "9a4981aa-9653-4bd1-bef5-d6bff52042e5" ] }`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

VPC Peering result information.
Sample:

[
  "Created VPC Peering my-vpc-peering (5a4981aa-9653-4bd1-bef5-d6bff52042e4)",
  "Deleted VPC Peering my-vpc-peering (5a4981aa-9653-4bd1-bef5-d6bff52042e4)",
  "VPC Peering my-vpc-peering would be created",
  "VPC Peering my-vpc-peering (5a4981aa-9653-4bd1-bef5-d6bff52042e4) exists",
  "VPC Peering my-vpc-peering does not exist"
]

vpc_peering
dict