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

Name	Datatype	Description
id	string	[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 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.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
forwardingRules	array	[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
kind	string	[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
labelFingerprint	string	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 error 412 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 the setLabels method. Each label key/value pair must comply with RFC1035. 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.
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.
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

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
get	SELECT	project, region, targetVpnGateway	Returns the specified target VPN gateway.
list	SELECT	project, region	Retrieves a list of target VPN gateways available to the specified project and region.
insert	INSERT	project, region	Creates a target VPN gateway in the specified project and region using the data included in the request.
delete	DELETE	project, region, targetVpnGateway	Deletes the specified target VPN gateway.
set_labels	EXEC	project, region, resource	Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.

SELECT examples

Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

INSERT example

Use the following StackQL query and manifest file to create a new target_vpn_gateways resource.

All Properties

/*+ create */
INSERT INTO google.compute.target_vpn_gateways (
project,
region,
name,
description,
region,
network,
tunnels,
status,
forwardingRules,
labels,
labelFingerprint
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ network }}',
'{{ tunnels }}',
'{{ status }}',
'{{ forwardingRules }}',
'{{ labels }}',
'{{ labelFingerprint }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: region
      value: string
    - name: network
      value: string
    - name: tunnels
      value:
        - string
    - name: status
      value: string
    - name: selfLink
      value: string
    - name: forwardingRules
      value:
        - string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string

DELETE example

Deletes the specified target_vpn_gateways resource.

/*+ delete */
DELETE FROM google.compute.target_vpn_gateways
WHERE project = '{{ project }}'
AND region = '{{ region }}'
AND targetVpnGateway = '{{ targetVpnGateway }}';