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.
- acceptedType: enum
Verbs requiredThe 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. - activeType: stringFormat: uuidnullable
Job Id requiredThe 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.
- createdType: stringFormat: date-time
At requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- descriptionType: stringnullablerequired
- desiredType: boolean
Applied requiredWhether 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.
- dhType: 2 or 5 or 14enum
Group requiredInteger numbers.
- dpdType: booleanrequired
- encryptionType: "aes128" or "aes192" or "aes256"enumrequired
- failureType: stringnullable
Reason requiredWhy the last job failed and what to do next, while
failed; why a delete stopped, whileremoving; null otherwise. - gatewayType: "router" or "appliance"enum
Kind requiredThe kind of the VPC's VPN gateway the connection terminates on.
- idType: stringFormat: uuidrequired
- ikeType: integer
Lifetime Seconds requiredInteger numbers.
- ikeType: "v1" or "v2"enum
Version required - integrityType: "sha256" or "sha384" or "sha512"enumrequired
- ipsecType: integer
Lifetime Seconds requiredInteger numbers.
- localType: stringnullable
Endpoint Address requiredThe public IPv4 address the customer's peer connects to: the address of the VPC's VPN gateway.
- nameType: stringrequired
- peerType: string
Address required - peerType: array of string
Cidrs requiredThe peer's networks, each rewritten to its network address.
- pfsType: 2 or 5 or 14enum
Group requiredInteger numbers.
- providerType: stringnullable
State requiredThe provider's own state string as last read, beside the mapped
state;absentwhen the provider had no connection at that read, and null until the first read. Aconnectedstate over anabsentprovider state is a connection the provider no longer holds — update it to rebuild it. - stateType: enumrequired
A VPN connection's lifecycle.
creatingandremovingare owned by a job, whichactiveJobIdnames.connecting,connected,disconnectedanderrorare 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.disconnectedis 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.erroris the provider reporting an error on a live connection.failedis the last job on the connection failing, withfailureReasonsaying why and what to do next. Aremovingconnection whosefailureReasonis 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.valuescreatingconnectingconnecteddisconnectederrorfailedremoving - updatedType: stringFormat: date-time
At requiredThe 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.
.png)