target_vpn_gateways

Creates, updates, deletes, gets or lists a target_vpn_gateways resource.

Overview

Name	target_vpn_gateways
Type	Resource
Id	google.compute.target_vpn_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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 withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
forwardingRules	array	[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created usingcompute.forwardingRules.insert and associated with a VPN gateway.
kind	string	Output only. [Output Only] Type of resource. Alwayscompute#targetVpnGateway for target VPN gateways. (default: compute#targetVpnGateway)
labelFingerprint	string (byte)	A fingerprint for the labels being applied to this TargetVpnGateway, 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
labels	object	Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
network	string	URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
params	object	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: TargetVpnGatewayParams)
region	string	[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. (CREATING, DELETING, FAILED, READY)
tunnels	array	[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of TargetVpnGateway resources.
kind	string	Output only. [Output Only] Type of resource. Alwayscompute#targetVpnGateway for target VPN gateways. (default: compute#targetVpnGatewayList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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 withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
forwardingRules	array	[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created usingcompute.forwardingRules.insert and associated with a VPN gateway.
kind	string	Output only. [Output Only] Type of resource. Alwayscompute#targetVpnGateway for target VPN gateways. (default: compute#targetVpnGateway)
labelFingerprint	string (byte)	A fingerprint for the labels being applied to this TargetVpnGateway, 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
labels	object	Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
network	string	URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
params	object	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: TargetVpnGatewayParams)
region	string	[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. (CREATING, DELETING, FAILED, READY)
tunnels	array	[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, targetVpnGateway		Returns the specified target VPN gateway.
list	select	project, region	orderBy, maxResults, pageToken, filter, returnPartialSuccess	Retrieves a list of target VPN gateways available to the specified project and region.
aggregated_list	select	project	returnPartialSuccess, maxResults, pageToken, filter, serviceProjectNumber, includeAllScopes, orderBy	Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Creates a target VPN gateway in the specified project and region using the data included in the request.
delete	delete	project, region, targetVpnGateway	requestId	Deletes the specified target VPN gateway.
set_labels	exec	project, region, resource	requestId	Sets the labels on a TargetVpnGateway. To learn more about labels, read theLabeling Resources documentation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project	string
region	string
resource	string
targetVpnGateway	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified target VPN gateway.

SELECT
id,
name,
creationTimestamp,
description,
forwardingRules,
kind,
labelFingerprint,
labels,
network,
params,
region,
selfLink,
status,
tunnels
FROM google.compute.target_vpn_gateways
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND targetVpnGateway = '{{ targetVpnGateway }}' -- required
;

list

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

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.target_vpn_gateways
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

aggregated_list

Retrieves an aggregated list of target VPN gateways.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
description,
forwardingRules,
kind,
labelFingerprint,
labels,
network,
params,
region,
selfLink,
status,
tunnels
FROM google.compute.target_vpn_gateways
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

insert

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

INSERT INTO google.compute.target_vpn_gateways (
data__region,
data__tunnels,
data__forwardingRules,
data__network,
data__labelFingerprint,
data__status,
data__params,
data__name,
data__selfLink,
data__id,
data__description,
data__labels,
project,
region,
requestId
)
SELECT 
'{{ region }}',
'{{ tunnels }}',
'{{ forwardingRules }}',
'{{ network }}',
'{{ labelFingerprint }}',
'{{ status }}',
'{{ params }}',
'{{ name }}',
'{{ selfLink }}',
'{{ id }}',
'{{ description }}',
'{{ labels }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: target_vpn_gateways
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the target_vpn_gateways resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the target_vpn_gateways resource.
  - name: region
    value: "{{ region }}"
    description: |
      [Output Only] URL of the region where the target VPN gateway resides.
      You must specify this field as part of the HTTP request URL. It is
      not settable as a field in the request body.
  - name: tunnels
    value:
      - "{{ tunnels }}"
    description: |
      [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are
      created using the compute.vpntunnels.insert method and
      associated with a VPN gateway.
  - name: forwardingRules
    value:
      - "{{ forwardingRules }}"
    description: |
      [Output Only] A list of URLs to the ForwardingRule resources.
      ForwardingRules are created usingcompute.forwardingRules.insert and associated with a VPN
      gateway.
  - name: network
    value: "{{ network }}"
    description: |
      URL of the network to which this VPN gateway is attached. Provided by the
      client when the VPN gateway is created.
  - name: labelFingerprint
    value: "{{ labelFingerprint }}"
    description: |
      A fingerprint for the labels being applied to this TargetVpnGateway, 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 error412 conditionNotMet.
      To see the latest fingerprint, make a get() request to
      retrieve a TargetVpnGateway.
  - name: status
    value: "{{ status }}"
    description: |
      [Output Only] The status of the VPN gateway,
      which can be one of the following: CREATING, READY, FAILED, or DELETING.
    valid_values: ['CREATING', 'DELETING', 'FAILED', 'READY']
  - name: params
    description: |
      Input only. [Input Only] Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      Label values may be empty.
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes the specified target VPN gateway.

DELETE FROM google.compute.target_vpn_gateways
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND targetVpnGateway = '{{ targetVpnGateway }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_labels

Sets the labels on a TargetVpnGateway. To learn more about labels, read theLabeling
Resources documentation.

EXEC google.compute.target_vpn_gateways.set_labels 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@resource='{{ resource }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;