VpnConnection

A site-to-site VPN connection from this VPC to the customer's own IPsec peer. The parameter fields hold the values last saved, which after a failed update can differ from what the provider runs until a retry applies them — desiredApplied says which. The pre-shared key is write-only and is never returned.

  • The verbs this connection's state accepts now. A verb listed here is not refused for the state; a change already in flight, a missing permission or feature, or a refusal of the body can still refuse it. Computed when the connection is read: on a connection being deleted it can change as time passes, with no change to updatedAt.

  • The create, update, reset or delete job driving this connection right now; null when none is. Recomputed on every read, so any reader picks the job up, not only the one that started it.

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

  • Whether the values saved last have been applied at the provider: cleared when an update saves new values, set once a job has applied them. While it is false, the saved values are not yet what the provider runs.

  • Integer numbers.

  • Why the last job failed and what to do next, while failed; why a delete stopped, while removing; null otherwise.

  • The kind of the VPC's VPN gateway the connection terminates on.

  • Integer numbers.

  • Integer numbers.

  • The public IPv4 address the customer's peer connects to: the address of the VPC's VPN gateway.

  • The peer's networks, each rewritten to its network address.

  • Integer numbers.

  • The provider's own state string as last read, beside the mapped state; absent when the provider had no connection at that read, and null until the first read. A connected state over an absent provider state is a connection the provider no longer holds — update it to rebuild it.

  • A VPN connection's lifecycle. creating and removing are owned by a job, which activeJobId names. connecting, connected, disconnected and error are what the provider reports about a built connection; they are refreshed when the VPC's VPN connections are read, so the state is as fresh as the last read. disconnected is not a fault: an idle connection can rest there until traffic brings it up, and a peer that stopped answering dead-peer detection reads the same. error is the provider reporting an error on a live connection. failed is the last job on the connection failing, with failureReason saying why and what to do next. A removing connection whose failureReason is set is a delete that failed and stopped; the delete can be retried at once. A named schema rather than an inline enum so a generated client keys on the member names.

    values
    creatingconnectingconnecteddisconnectederrorfailedremoving
  • The last change a tenant or a job made to the connection. The refresh of the provider-reported state a read runs does not move it.