REST Resource: projects.locations.vpnConnections

Resource: VpnConnection

A VPN connection .

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "natGatewayIp": string,
  "bgpRoutingMode": enum (BgpRoutingMode),
  "cluster": string,
  "vpc": string,
  "vpcProject": {
    object (VpcProject)
  },
  "enableHighAvailability": boolean,
  "details": {
    object (Details)
  }
}
Fields
name

string

Required. The resource name of VPN connection
createTime

string (Timestamp format)

Output only. The time when the VPN connection was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the VPN connection was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Labels associated with this resource.

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

string

NAT gateway IP, or WAN IP address. If a customer has multiple NAT IPs, the customer needs to configure NAT such that only one external IP maps to the GMEC Anthos cluster. This is empty if NAT is not used.
bgpRoutingMode
(deprecated)

enum (BgpRoutingMode)

Dynamic routing mode of the VPC network, regional or global.
cluster

string

The canonical Cluster name to connect to. It is in the form of projects/{project}/locations/{location}/clusters/{cluster}.
vpc

string

The network ID of VPC to connect to.
vpcProject

object (VpcProject)

Optional. Project detail of the VPC network. Required if VPC is in a different project than the cluster project.
enableHighAvailability

boolean

Whether this VPN connection has HA enabled on cluster side. If enabled, when creating VPN connection we will attempt to use 2 ANG floating IPs.
details

object (Details)

Output only. The created connection details.

BgpRoutingMode

Routing mode.

Enums
BGP_ROUTING_MODE_UNSPECIFIED Unknown.
REGIONAL Regional mode.
GLOBAL Global mode.

VpcProject

Project detail of the VPC network.

JSON representation 
{
  "projectId": string,
  "serviceAccount": string
}
Fields
projectId

string

The project of the VPC to connect to. If not specified, it is the same as the cluster project.
serviceAccount
(deprecated)

string

Optional. The service account in the VPC project configured by user. It is used to create/delete Cloud Router and Cloud HA VPNs for VPN connection. If this SA is changed during/after a VPN connection is created, you need to remove the Cloud Router and Cloud VPN resources in |projectId|. It is in the form of service-{projectNumber}@gcp-sa-edgecontainer.iam.gserviceaccount.com.

Details

The created connection details.

JSON representation 
{
  "state": enum (State),
  "error": string,
  "cloudRouter": {
    object (CloudRouter)
  },
  "cloudVpns": [
    {
      object (CloudVpn)
    }
  ]
}
Fields
state

enum (State)

The state of this connection.
error

string

The error message. This is only populated when state=ERROR.
cloudRouter

object (CloudRouter)

The Cloud Router info.
cloudVpns[]

object (CloudVpn)

Each connection has multiple Cloud VPN gateways.

State

The current connection state.

Enums
STATE_UNSPECIFIED Unknown.
STATE_CONNECTED Connected.
STATE_CONNECTING Still connecting.
STATE_ERROR Error occurred.

CloudRouter

The Cloud Router info.

JSON representation 
{
  "name": string
}
Fields
name

string

The associated Cloud Router name.

CloudVpn

The Cloud VPN info.

JSON representation 
{
  "gateway": string
}
Fields
gateway

string

The created Cloud VPN gateway name.

Methods

create

 Creates a new VPN connection in a given project and location.

delete

 Deletes a single VPN connection.

get

 Gets details of a single VPN connection.

list

 Lists VPN connections in a given project and location.