VpnGateway

The VPC's VPN gateway: what its site-to-site VPN connections terminate on. A VPC has at most one, created before its first connection and removed after its last.

activeJobId
Type: stringFormat: uuidnullable
required

The create or remove job driving the gateway right now; null when none is. Recomputed on every read.
address
Type: stringnullable
required

The public IPv4 address the customer's peers connect to. Null until the creation has made it.
createdAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
failureReason
Type: stringnullable
required

Why the creation failed and what to do next, while failed; why a removal stopped, while removing; null otherwise.
id
Type: stringFormat: uuid
required
kind
Type: "router" or "appliance"enum
required

What implements the gateway on the platform side.
reservedBlock
Type: stringnullable
required

The block of the VPC's range the gateway holds for itself, which no subnet can take; null where the gateway needs none.
state
Type: enum
required

A VPN gateway's lifecycle. creating and removing are owned by a job, which activeJobId names. ready takes VPN connections. failed is a creation that could not finish, with failureReason saying why; remove it and create it again. A removing gateway whose failureReason is set is a removal that stopped; it is retried automatically. A named schema rather than an inline enum so a generated client keys on the member names.

values
creatingreadyfailedremoving
updatedAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
vpcId
Type: stringFormat: uuid
required

VpnGatewayStatus

VpnGatewayNotFoundCode