ExternalVpnGateway

Represents a VPN gateway managed outside of GCP.

To get more information about ExternalVpnGateway, see:

API documentation

Create a ExternalVpnGateway Resource

new ExternalVpnGateway(name: string, args?: ExternalVpnGatewayArgs, opts?: CustomResourceOptions);

def ExternalVpnGateway(resource_name, opts=None, description=None, interfaces=None, name=None, project=None, redundancy_type=None, __props__=None);

func NewExternalVpnGateway(ctx *Context, name string, args *ExternalVpnGatewayArgs, opts ...ResourceOption) (*ExternalVpnGateway, error)

public ExternalVpnGateway(string name, ExternalVpnGatewayArgs? args = null, CustomResourceOptions? opts = null)

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

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

ExternalVpnGateway Resource Properties

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

Inputs

The ExternalVpnGateway resource accepts the following input properties:

Description string: An optional description of this resource.
Interfaces List<ExternalVpnGatewayInterfaceArgs>: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
RedundancyType string: Indicates the redundancy type of this external VPN gateway

Description string: An optional description of this resource.
Interfaces []ExternalVpnGatewayInterface: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
RedundancyType string: Indicates the redundancy type of this external VPN gateway

description string: An optional description of this resource.
interfaces ExternalVpnGatewayInterface[]: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
redundancyType string: Indicates the redundancy type of this external VPN gateway

description str: An optional description of this resource.
interfaces List[ExternalVpnGatewayInterface]: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
redundancy_type str: Indicates the redundancy type of this external VPN gateway

Outputs

All input properties are implicitly available as output properties. Additionally, the ExternalVpnGateway 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.

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created 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 ExternalVpnGateway Resource

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

static get(resource_name, id, opts=None, description=None, interfaces=None, name=None, project=None, redundancy_type=None, self_link=None, __props__=None);

func GetExternalVpnGateway(ctx *Context, name string, id IDInput, state *ExternalVpnGatewayState, opts ...ResourceOption) (*ExternalVpnGateway, error)

public static ExternalVpnGateway Get(string name, Input<string> id, ExternalVpnGatewayState? 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.
Interfaces List<ExternalVpnGatewayInterfaceArgs>: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
RedundancyType string: Indicates the redundancy type of this external VPN gateway
SelfLink string: The URI of the created resource.

Description string: An optional description of this resource.
Interfaces []ExternalVpnGatewayInterface: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
RedundancyType string: Indicates the redundancy type of this external VPN gateway
SelfLink string: The URI of the created resource.

description string: An optional description of this resource.
interfaces ExternalVpnGatewayInterface[]: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
redundancyType string: Indicates the redundancy type of this external VPN gateway
selfLink string: The URI of the created resource.

description str: An optional description of this resource.
interfaces List[ExternalVpnGatewayInterface]: A list of interfaces on this external VPN gateway. Structure is documented below.
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.
redundancy_type str: Indicates the redundancy type of this external VPN gateway
self_link str: The URI of the created resource.

Supporting Types

ExternalVpnGatewayInterface

See the input and output API doc for this type.

Id int: The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway * 0 - SINGLE_IP_INTERNALLY_REDUNDANT * 0, 1 - TWO_IPS_REDUNDANCY * 0, 1, 2, 3 - FOUR_IPS_REDUNDANCY
IpAddress string: IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider’s VPN gateway, it cannot be an IP address from Google Compute Engine.

Id int: The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway * 0 - SINGLE_IP_INTERNALLY_REDUNDANT * 0, 1 - TWO_IPS_REDUNDANCY * 0, 1, 2, 3 - FOUR_IPS_REDUNDANCY
IpAddress string: IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider’s VPN gateway, it cannot be an IP address from Google Compute Engine.

id number: The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway * 0 - SINGLE_IP_INTERNALLY_REDUNDANT * 0, 1 - TWO_IPS_REDUNDANCY * 0, 1, 2, 3 - FOUR_IPS_REDUNDANCY
ipAddress string: IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider’s VPN gateway, it cannot be an IP address from Google Compute Engine.

id float: The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway * 0 - SINGLE_IP_INTERNALLY_REDUNDANT * 0, 1 - TWO_IPS_REDUNDANCY * 0, 1, 2, 3 - FOUR_IPS_REDUNDANCY
ip_address str: IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider’s VPN gateway, it cannot be an IP address from Google Compute Engine.

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