ec2.nat-gateways.create

Give a VPC a NAT gateway (one per VPC); answers 202 while it is built

POST /ec2/api/nat-gatewaysIAM ec2:CreateNatGatewayChanges state

A platform-run machine with a public IPv4 at a pinned address in the VPC, plus the network route 0.0.0.0/0 to it. Instances launched afterwards with `enablePublicIpv4: false` route through it on their own; older ones need one command (see the compute docs). One machine: not redundant.

Request syntax

POST /ec2/api/nat-gateways
{
  "vpcId": "string",
  "tags": "map of string"
}

Request body

  • vpcIdRequired

    string

    The VPC to serve

    Constraints: uuid

  • tagsOptional

    map of string

    Tags for the new resource, e.g. {"env": "prod", "project": "shop"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).

    Constraints: key=value

Response

202: `data` is the new NAT gateway in status `creating` (fields as in get); it turns `available` once its machine and route are in place.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ec2:CreateNatGateway on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ec2 nat-gateways create --vpc-id 00000000-0000-0000-0000-000000000000

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_nat-gateways_create.