HaVpnGateway

Represents a VPN gateway running in GCP. This virtual device is managed by Google, but used only by you. This type of VPN Gateway allows for the creation of VPN solutions with higher availability than classic Target VPN Gateways.

To get more information about HaVpnGateway, see:

API documentation
How-to Guides
- Choosing a VPN
- Cloud VPN Overview

Create a HaVpnGateway Resource

new HaVpnGateway(name: string, args: HaVpnGatewayArgs, opts?: CustomResourceOptions);

def HaVpnGateway(resource_name, opts=None, description=None, name=None, network=None, project=None, region=None, __props__=None);

func NewHaVpnGateway(ctx *Context, name string, args HaVpnGatewayArgs, opts ...ResourceOption) (*HaVpnGateway, error)

public HaVpnGateway(string name, HaVpnGatewayArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args HaVpnGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HaVpnGatewayArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HaVpnGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

HaVpnGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The HaVpnGateway resource accepts the following input properties:

Network string: The network this VPN gateway is accepting traffic for.
Description string: An optional description of this resource.
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? 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region this gateway should sit in.

Network string: The network this VPN gateway is accepting traffic for.
Description string: An optional description of this resource.
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? 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region this gateway should sit in.

network string: The network this VPN gateway is accepting traffic for.
description string: An optional description of this resource.
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? 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: The region this gateway should sit in.

network str: The network this VPN gateway is accepting traffic for.
description str: An optional description of this resource.
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? 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: The region this gateway should sit in.

Outputs

All input properties are implicitly available as output properties. Additionally, the HaVpnGateway resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
VpnInterfaces List<HaVpnGatewayVpnInterface>: A list of interfaces on this VPN gateway.

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
VpnInterfaces []HaVpnGatewayVpnInterface: A list of interfaces on this VPN gateway.

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.
vpnInterfaces HaVpnGatewayVpnInterface[]: A list of interfaces on this VPN gateway.

id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.
vpn_interfaces List[HaVpnGatewayVpnInterface]: A list of interfaces on this VPN gateway.

Look up an Existing HaVpnGateway Resource

Get an existing HaVpnGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HaVpnGatewayState, opts?: CustomResourceOptions): HaVpnGateway

static get(resource_name, id, opts=None, description=None, name=None, network=None, project=None, region=None, self_link=None, vpn_interfaces=None, __props__=None);

func GetHaVpnGateway(ctx *Context, name string, id IDInput, state *HaVpnGatewayState, opts ...ResourceOption) (*HaVpnGateway, error)

public static HaVpnGateway Get(string name, Input<string> id, HaVpnGatewayState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: An optional description of this resource.
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? 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.
Network string: The network this VPN gateway is accepting traffic for.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region this gateway should sit in.
SelfLink string: The URI of the created resource.
VpnInterfaces List<HaVpnGatewayVpnInterfaceArgs>: A list of interfaces on this VPN gateway.

Description string: An optional description of this resource.
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? 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.
Network string: The network this VPN gateway is accepting traffic for.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region this gateway should sit in.
SelfLink string: The URI of the created resource.
VpnInterfaces []HaVpnGatewayVpnInterface: A list of interfaces on this VPN gateway.

description string: An optional description of this resource.
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? 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.
network string: The network this VPN gateway is accepting traffic for.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: The region this gateway should sit in.
selfLink string: The URI of the created resource.
vpnInterfaces HaVpnGatewayVpnInterface[]: A list of interfaces on this VPN gateway.

description str: An optional description of this resource.
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? 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.
network str: The network this VPN gateway is accepting traffic for.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: The region this gateway should sit in.
self_link str: The URI of the created resource.
vpn_interfaces List[HaVpnGatewayVpnInterface]: A list of interfaces on this VPN gateway.

Supporting Types

HaVpnGatewayVpnInterface

See the output API doc for this type.

Id int: an identifier for the resource with format projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}
IpAddress string

Id int: an identifier for the resource with format projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}
IpAddress string

id number: an identifier for the resource with format projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}
ipAddress string

id float: an identifier for the resource with format projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}
ip_address str

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud