REST Resource: vpnGateways

Resource: VpnGateway

Represents a HA VPN gateway.

HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "network": string,
  "selfLink": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "vpnInterfaces": [
    {
      "id": integer,
      "ipAddress": string
    }
  ],
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

description

string

An optional description of this resource. Provide this property when you create the resource.

region

string

[Output Only] URL of the region where the VPN gateway resides.

network

string

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an VpnGateway.

A base64-encoded string.

vpnInterfaces[]

object

A list of interfaces on this VPN gateway.

vpnInterfaces[].id

integer (uint32 format)

The numeric ID of this VPN gateway interface.

vpnInterfaces[].ipAddress

string

[Output Only] The external IP address for this VPN gateway interface.

kind

string

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

Methods

aggregatedList

Retrieves an aggregated list of VPN gateways.

delete

Deletes the specified VPN gateway.

get

Returns the specified VPN gateway.

getStatus

Returns the status for the specified VPN gateway.

insert

Creates a VPN gateway in the specified project and region using the data included in the request.

list

Retrieves a list of VPN gateways available to the specified project and region.

setLabels

Sets the labels on a VpnGateway.

testIamPermissions

Returns permissions that a caller has on the specified resource.