VPNGateway

Represents a VPN gateway running in GCP. This virtual device is managed by Google, but used only by you.

To get more information about VpnGateway, see:

API documentation

Create a VPNGateway Resource

new VPNGateway(name: string, args: VPNGatewayArgs, opts?: CustomResourceOptions);

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

func NewVPNGateway(ctx *Context, name string, args VPNGatewayArgs, opts ...ResourceOption) (*VPNGateway, error)

public VPNGateway(string name, VPNGatewayArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VPNGatewayArgs: 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 VPNGatewayArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

VPNGateway Resource Properties

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

Inputs

The VPNGateway 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 VPNGateway resource produces the following output properties:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
GatewayId int: The unique identifier for the resource.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
GatewayId int: The unique identifier for the resource.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
gatewayId number: The unique identifier for the resource.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
gateway_id float: The unique identifier for the resource.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

Look up an Existing VPNGateway Resource

Get an existing VPNGateway 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?: VPNGatewayState, opts?: CustomResourceOptions): VPNGateway

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

func GetVPNGateway(ctx *Context, name string, id IDInput, state *VPNGatewayState, opts ...ResourceOption) (*VPNGateway, error)

public static VPNGateway Get(string name, Input<string> id, VPNGatewayState? 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:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource.
GatewayId int: The unique identifier for the 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.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource.
GatewayId int: The unique identifier for the 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.

creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional description of this resource.
gatewayId number: The unique identifier for the 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.

creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional description of this resource.
gateway_id float: The unique identifier for the 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.

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