Give Feedback

vpc_nat_gateway

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

Synopsis

Create or delete VPC NAT Gateways. VPC NAT Gateways allow resources in a private VPC to access the public internet without exposing them to incoming traffic. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-NAT-Gateways.

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 NAT Gateway. 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 NAT Gateway. Must be unique and may only contain alphanumeric characters, dashes, and periods.
`region` str		The slug identifier for the region where the NAT Gateway will be created.
`size` int		The size of the NAT Gateway (number of vCPUs). Common values are 1 (small), 2 (medium), 4 (large).
`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_uuid` str		The UUID of the VPC to create the NAT Gateway in. Required when creating a new NAT Gateway.

Examples

- name: Create VPC NAT Gateway
  digitalocean.cloud.vpc_nat_gateway:
    token: "{{ token }}"
    state: present
    name: my-nat-gateway
    vpc_uuid: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    region: nyc1
    size: 1

- name: Delete VPC NAT Gateway by name
  digitalocean.cloud.vpc_nat_gateway:
    token: "{{ token }}"
    state: absent
    name: my-nat-gateway

- name: Delete VPC NAT Gateway by ID
  digitalocean.cloud.vpc_nat_gateway:
    token: "{{ token }}"
    state: absent
    name: my-nat-gateway
    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 NAT Gateway result information. Sample: `[ "Created VPC NAT Gateway my-nat-gateway (5a4981aa-9653-4bd1-bef5-d6bff52042e4)", "Deleted VPC NAT Gateway my-nat-gateway (5a4981aa-9653-4bd1-bef5-d6bff52042e4)", "VPC NAT Gateway my-nat-gateway would be created", "VPC NAT Gateway my-nat-gateway (5a4981aa-9653-4bd1-bef5-d6bff52042e4) exists", "VPC NAT Gateway my-nat-gateway does not exist" ]`
`vpc_nat_gateway` dict	always	VPC NAT Gateway information. Sample: `{ "created_at": "2020-03-13T19:20:47.442049222Z", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "my-nat-gateway", "public_ip": "192.0.2.1", "region": "nyc1", "size": "small", "status": "ACTIVE", "vpc_uuid": "5a4981aa-9653-4bd1-bef5-d6bff52042e4" }`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

VPC NAT Gateway result information.
Sample:

[
  "Created VPC NAT Gateway my-nat-gateway (5a4981aa-9653-4bd1-bef5-d6bff52042e4)",
  "Deleted VPC NAT Gateway my-nat-gateway (5a4981aa-9653-4bd1-bef5-d6bff52042e4)",
  "VPC NAT Gateway my-nat-gateway would be created",
  "VPC NAT Gateway my-nat-gateway (5a4981aa-9653-4bd1-bef5-d6bff52042e4) exists",
  "VPC NAT Gateway my-nat-gateway does not exist"
]

vpc_nat_gateway
dict