Class VpnGateway (1.18.0)

VpnGateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 .

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
creation_timestamp str
[Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
description str
An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
gateway_ip_version str
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used. Check the GatewayIpVersion enum for the list of possible values. This field is a member of oneof_ _gateway_ip_version.
id int
[Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind str
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. This field is a member of oneof_ _kind.
label_fingerprint str
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 a VpnGateway. This field is a member of oneof_ _label_fingerprint.
labels MutableMapping[str, str]
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.
name str
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. This field is a member of oneof_ _name.
network str
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. This field is a member of oneof_ _network.
region str
[Output Only] URL of the region where the VPN gateway resides. This field is a member of oneof_ _region.
self_link str
[Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
stack_type str
The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. Check the StackType enum for the list of possible values. This field is a member of oneof_ _stack_type.
vpn_interfaces MutableSequence[google.cloud.compute_v1.types.VpnGatewayVpnGatewayInterface]
The list of VPN interfaces associated with this VPN gateway.

Classes

GatewayIpVersion

GatewayIpVersion(value)

The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.

Values: UNDEFINED_GATEWAY_IP_VERSION (0): A value indicating that the enum field is not set. IPV4 (2254341): Every HA-VPN gateway interface is configured with an IPv4 address. IPV6 (2254343): Every HA-VPN gateway interface is configured with an IPv6 address.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

StackType

StackType(value)

The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.

Values: UNDEFINED_STACK_TYPE (0): A value indicating that the enum field is not set. IPV4_IPV6 (22197249): Enable VPN gateway with both IPv4 and IPv6 protocols. IPV4_ONLY (22373798): Enable VPN gateway with only IPv4 protocol.