Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. RouterInterface
Google Cloud v8.31.0 published on Thursday, May 15, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.compute.RouterInterface

Explore with Pulumi AI

gcp logo
Google Cloud v8.31.0 published on Thursday, May 15, 2025 by Pulumi
pulumi/pulumi-gcp

    Manages a Cloud Router interface. For more information see the official documentation and API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const foobar = new gcp.compute.RouterInterface("foobar", {
    name: "interface-1",
    router: "router-1",
    region: "us-central1",
    ipRange: "169.254.1.1/30",
    vpnTunnel: "tunnel-1",
});

    import pulumi
import pulumi_gcp as gcp

foobar = gcp.compute.RouterInterface("foobar",
    name="interface-1",
    router="router-1",
    region="us-central1",
    ip_range="169.254.1.1/30",
    vpn_tunnel="tunnel-1")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRouterInterface(ctx, "foobar", &compute.RouterInterfaceArgs{
			Name:      pulumi.String("interface-1"),
			Router:    pulumi.String("router-1"),
			Region:    pulumi.String("us-central1"),
			IpRange:   pulumi.String("169.254.1.1/30"),
			VpnTunnel: pulumi.String("tunnel-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var foobar = new Gcp.Compute.RouterInterface("foobar", new()
    {
        Name = "interface-1",
        Router = "router-1",
        Region = "us-central1",
        IpRange = "169.254.1.1/30",
        VpnTunnel = "tunnel-1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RouterInterface;
import com.pulumi.gcp.compute.RouterInterfaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foobar = new RouterInterface("foobar", RouterInterfaceArgs.builder()
            .name("interface-1")
            .router("router-1")
            .region("us-central1")
            .ipRange("169.254.1.1/30")
            .vpnTunnel("tunnel-1")
            .build());

    }
}

    resources:
  foobar:
    type: gcp:compute:RouterInterface
    properties:
      name: interface-1
      router: router-1
      region: us-central1
      ipRange: 169.254.1.1/30
      vpnTunnel: tunnel-1

    Create RouterInterface Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RouterInterface(name: string, args: RouterInterfaceArgs, opts?: CustomResourceOptions);
    @overload
def RouterInterface(resource_name: str,
                    args: RouterInterfaceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def RouterInterface(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    router: Optional[str] = None,
                    interconnect_attachment: Optional[str] = None,
                    ip_range: Optional[str] = None,
                    ip_version: Optional[str] = None,
                    name: Optional[str] = None,
                    private_ip_address: Optional[str] = None,
                    project: Optional[str] = None,
                    redundant_interface: Optional[str] = None,
                    region: Optional[str] = None,
                    subnetwork: Optional[str] = None,
                    vpn_tunnel: Optional[str] = None)
    func NewRouterInterface(ctx *Context, name string, args RouterInterfaceArgs, opts ...ResourceOption) (*RouterInterface, error)
    public RouterInterface(string name, RouterInterfaceArgs args, CustomResourceOptions? opts = null)
    public RouterInterface(String name, RouterInterfaceArgs args)
public RouterInterface(String name, RouterInterfaceArgs args, CustomResourceOptions options)

    type: gcp:compute:RouterInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RouterInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RouterInterfaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RouterInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouterInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouterInterfaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var routerInterfaceResource = new Gcp.Compute.RouterInterface("routerInterfaceResource", new()
{
    Router = "string",
    InterconnectAttachment = "string",
    IpRange = "string",
    IpVersion = "string",
    Name = "string",
    PrivateIpAddress = "string",
    Project = "string",
    RedundantInterface = "string",
    Region = "string",
    Subnetwork = "string",
    VpnTunnel = "string",
});

    example, err := compute.NewRouterInterface(ctx, "routerInterfaceResource", &compute.RouterInterfaceArgs{
	Router:                 pulumi.String("string"),
	InterconnectAttachment: pulumi.String("string"),
	IpRange:                pulumi.String("string"),
	IpVersion:              pulumi.String("string"),
	Name:                   pulumi.String("string"),
	PrivateIpAddress:       pulumi.String("string"),
	Project:                pulumi.String("string"),
	RedundantInterface:     pulumi.String("string"),
	Region:                 pulumi.String("string"),
	Subnetwork:             pulumi.String("string"),
	VpnTunnel:              pulumi.String("string"),
})

    var routerInterfaceResource = new RouterInterface("routerInterfaceResource", RouterInterfaceArgs.builder()
    .router("string")
    .interconnectAttachment("string")
    .ipRange("string")
    .ipVersion("string")
    .name("string")
    .privateIpAddress("string")
    .project("string")
    .redundantInterface("string")
    .region("string")
    .subnetwork("string")
    .vpnTunnel("string")
    .build());

    router_interface_resource = gcp.compute.RouterInterface("routerInterfaceResource",
    router="string",
    interconnect_attachment="string",
    ip_range="string",
    ip_version="string",
    name="string",
    private_ip_address="string",
    project="string",
    redundant_interface="string",
    region="string",
    subnetwork="string",
    vpn_tunnel="string")

    const routerInterfaceResource = new gcp.compute.RouterInterface("routerInterfaceResource", {
    router: "string",
    interconnectAttachment: "string",
    ipRange: "string",
    ipVersion: "string",
    name: "string",
    privateIpAddress: "string",
    project: "string",
    redundantInterface: "string",
    region: "string",
    subnetwork: "string",
    vpnTunnel: "string",
});

    type: gcp:compute:RouterInterface
properties:
    interconnectAttachment: string
    ipRange: string
    ipVersion: string
    name: string
    privateIpAddress: string
    project: string
    redundantInterface: string
    region: string
    router: string
    subnetwork: string
    vpnTunnel: string

    RouterInterface Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RouterInterface resource accepts the following input properties:

    Router string

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    InterconnectAttachment string
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    IpRange string
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    IpVersion string
    IP version of this interface. Can be either IPV4 or IPV6.
    Name string
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    PrivateIpAddress string
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    Project string
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    RedundantInterface string
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    Region string
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    Subnetwork string
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    VpnTunnel string
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    Router string

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    InterconnectAttachment string
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    IpRange string
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    IpVersion string
    IP version of this interface. Can be either IPV4 or IPV6.
    Name string
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    PrivateIpAddress string
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    Project string
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    RedundantInterface string
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    Region string
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    Subnetwork string
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    VpnTunnel string
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    router String

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    interconnectAttachment String
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ipRange String
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ipVersion String
    IP version of this interface. Can be either IPV4 or IPV6.
    name String
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    privateIpAddress String
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project String
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundantInterface String
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region String
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    subnetwork String
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpnTunnel String
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    router string

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    interconnectAttachment string
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ipRange string
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ipVersion string
    IP version of this interface. Can be either IPV4 or IPV6.
    name string
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    privateIpAddress string
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project string
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundantInterface string
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region string
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    subnetwork string
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpnTunnel string
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    router str

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    interconnect_attachment str
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ip_range str
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ip_version str
    IP version of this interface. Can be either IPV4 or IPV6.
    name str
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    private_ip_address str
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project str
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundant_interface str
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region str
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    subnetwork str
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpn_tunnel str
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    router String

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    interconnectAttachment String
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ipRange String
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ipVersion String
    IP version of this interface. Can be either IPV4 or IPV6.
    name String
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    privateIpAddress String
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project String
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundantInterface String
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region String
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    subnetwork String
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpnTunnel String
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RouterInterface Resource

    Get an existing RouterInterface 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?: RouterInterfaceState, opts?: CustomResourceOptions): RouterInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        interconnect_attachment: Optional[str] = None,
        ip_range: Optional[str] = None,
        ip_version: Optional[str] = None,
        name: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        project: Optional[str] = None,
        redundant_interface: Optional[str] = None,
        region: Optional[str] = None,
        router: Optional[str] = None,
        subnetwork: Optional[str] = None,
        vpn_tunnel: Optional[str] = None) -> RouterInterface
    func GetRouterInterface(ctx *Context, name string, id IDInput, state *RouterInterfaceState, opts ...ResourceOption) (*RouterInterface, error)
    public static RouterInterface Get(string name, Input<string> id, RouterInterfaceState? state, CustomResourceOptions? opts = null)
    public static RouterInterface get(String name, Output<String> id, RouterInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: gcp:compute:RouterInterface    get:      id: ${id}
    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.
    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:
    InterconnectAttachment string
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    IpRange string
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    IpVersion string
    IP version of this interface. Can be either IPV4 or IPV6.
    Name string
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    PrivateIpAddress string
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    Project string
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    RedundantInterface string
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    Region string
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    Router string

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    Subnetwork string
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    VpnTunnel string
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    InterconnectAttachment string
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    IpRange string
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    IpVersion string
    IP version of this interface. Can be either IPV4 or IPV6.
    Name string
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    PrivateIpAddress string
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    Project string
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    RedundantInterface string
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    Region string
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    Router string

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    Subnetwork string
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    VpnTunnel string
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    interconnectAttachment String
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ipRange String
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ipVersion String
    IP version of this interface. Can be either IPV4 or IPV6.
    name String
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    privateIpAddress String
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project String
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundantInterface String
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region String
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    router String

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    subnetwork String
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpnTunnel String
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    interconnectAttachment string
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ipRange string
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ipVersion string
    IP version of this interface. Can be either IPV4 or IPV6.
    name string
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    privateIpAddress string
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project string
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundantInterface string
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region string
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    router string

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    subnetwork string
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpnTunnel string
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    interconnect_attachment str
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ip_range str
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ip_version str
    IP version of this interface. Can be either IPV4 or IPV6.
    name str
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    private_ip_address str
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project str
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundant_interface str
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region str
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    router str

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    subnetwork str
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpn_tunnel str
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    interconnectAttachment String
    The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    ipRange String
    IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.
    ipVersion String
    IP version of this interface. Can be either IPV4 or IPV6.
    name String
    A unique name for the interface, required by GCE. Changing this forces a new interface to be created.
    privateIpAddress String
    The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance. Changing this forces a new interface to be created.
    project String
    The ID of the project in which this interface's routerbelongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.
    redundantInterface String
    The name of the interface that is redundant to this interface. Changing this forces a new interface to be created.
    region String
    The region this interface's router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.
    router String

    The name of the router this interface will be attached to. Changing this forces a new interface to be created.

    In addition to the above required fields, a router interface must have specified either ip_range or exactly one of vpn_tunnel, interconnect_attachment or subnetwork, or both.

    subnetwork String
    The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.
    vpnTunnel String
    The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel, interconnect_attachment or subnetwork can be specified.

    Import

    Router interfaces can be imported using the project (optional), region, router, and name, e.g.

    • {{project_id}}/{{region}}/{{router}}/{{name}}

    • {{region}}/{{router}}/{{name}}

    When using the pulumi import command, router interfaces can be imported using one of the formats above. For example:

    $ pulumi import gcp:compute/routerInterface:RouterInterface default {{project_id}}/{{region}}/{{router}}/{{name}}

    $ pulumi import gcp:compute/routerInterface:RouterInterface default {{region}}/{{router}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.31.0 published on Thursday, May 15, 2025 by Pulumi
    pulumi/pulumi-gcp