Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vmwareengine
  5. NetworkPeering
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.vmwareengine.NetworkPeering

Explore with Pulumi AI

gcp logo
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

    Represents a network peering resource. Network peerings are global resources.

    To get more information about NetworkPeering, see:

    Example Usage

    Vmware Engine Network Peering Ven

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

const network_peering_nw = new gcp.vmwareengine.Network("network-peering-nw", {
    name: "default-np-nw",
    location: "global",
    type: "STANDARD",
});
const network_peering_peer_nw = new gcp.vmwareengine.Network("network-peering-peer-nw", {
    name: "peer-np-nw",
    location: "global",
    type: "STANDARD",
});
const vmw_engine_network_peering = new gcp.vmwareengine.NetworkPeering("vmw-engine-network-peering", {
    name: "sample-network-peering",
    description: "Sample description",
    vmwareEngineNetwork: network_peering_nw.id,
    peerNetwork: network_peering_peer_nw.id,
    peerNetworkType: "VMWARE_ENGINE_NETWORK",
    exportCustomRoutes: false,
    importCustomRoutes: false,
    exportCustomRoutesWithPublicIp: false,
    importCustomRoutesWithPublicIp: false,
});

    import pulumi
import pulumi_gcp as gcp

network_peering_nw = gcp.vmwareengine.Network("network-peering-nw",
    name="default-np-nw",
    location="global",
    type="STANDARD")
network_peering_peer_nw = gcp.vmwareengine.Network("network-peering-peer-nw",
    name="peer-np-nw",
    location="global",
    type="STANDARD")
vmw_engine_network_peering = gcp.vmwareengine.NetworkPeering("vmw-engine-network-peering",
    name="sample-network-peering",
    description="Sample description",
    vmware_engine_network=network_peering_nw.id,
    peer_network=network_peering_peer_nw.id,
    peer_network_type="VMWARE_ENGINE_NETWORK",
    export_custom_routes=False,
    import_custom_routes=False,
    export_custom_routes_with_public_ip=False,
    import_custom_routes_with_public_ip=False)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network_peering_nw, err := vmwareengine.NewNetwork(ctx, "network-peering-nw", &vmwareengine.NetworkArgs{
			Name:     pulumi.String("default-np-nw"),
			Location: pulumi.String("global"),
			Type:     pulumi.String("STANDARD"),
		})
		if err != nil {
			return err
		}
		network_peering_peer_nw, err := vmwareengine.NewNetwork(ctx, "network-peering-peer-nw", &vmwareengine.NetworkArgs{
			Name:     pulumi.String("peer-np-nw"),
			Location: pulumi.String("global"),
			Type:     pulumi.String("STANDARD"),
		})
		if err != nil {
			return err
		}
		_, err = vmwareengine.NewNetworkPeering(ctx, "vmw-engine-network-peering", &vmwareengine.NetworkPeeringArgs{
			Name:                           pulumi.String("sample-network-peering"),
			Description:                    pulumi.String("Sample description"),
			VmwareEngineNetwork:            network_peering_nw.ID(),
			PeerNetwork:                    network_peering_peer_nw.ID(),
			PeerNetworkType:                pulumi.String("VMWARE_ENGINE_NETWORK"),
			ExportCustomRoutes:             pulumi.Bool(false),
			ImportCustomRoutes:             pulumi.Bool(false),
			ExportCustomRoutesWithPublicIp: pulumi.Bool(false),
			ImportCustomRoutesWithPublicIp: pulumi.Bool(false),
		})
		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 network_peering_nw = new Gcp.VMwareEngine.Network("network-peering-nw", new()
    {
        Name = "default-np-nw",
        Location = "global",
        Type = "STANDARD",
    });

    var network_peering_peer_nw = new Gcp.VMwareEngine.Network("network-peering-peer-nw", new()
    {
        Name = "peer-np-nw",
        Location = "global",
        Type = "STANDARD",
    });

    var vmw_engine_network_peering = new Gcp.VMwareEngine.NetworkPeering("vmw-engine-network-peering", new()
    {
        Name = "sample-network-peering",
        Description = "Sample description",
        VmwareEngineNetwork = network_peering_nw.Id,
        PeerNetwork = network_peering_peer_nw.Id,
        PeerNetworkType = "VMWARE_ENGINE_NETWORK",
        ExportCustomRoutes = false,
        ImportCustomRoutes = false,
        ExportCustomRoutesWithPublicIp = false,
        ImportCustomRoutesWithPublicIp = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vmwareengine.Network;
import com.pulumi.gcp.vmwareengine.NetworkArgs;
import com.pulumi.gcp.vmwareengine.NetworkPeering;
import com.pulumi.gcp.vmwareengine.NetworkPeeringArgs;
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 network_peering_nw = new Network("network-peering-nw", NetworkArgs.builder()
            .name("default-np-nw")
            .location("global")
            .type("STANDARD")
            .build());

        var network_peering_peer_nw = new Network("network-peering-peer-nw", NetworkArgs.builder()
            .name("peer-np-nw")
            .location("global")
            .type("STANDARD")
            .build());

        var vmw_engine_network_peering = new NetworkPeering("vmw-engine-network-peering", NetworkPeeringArgs.builder()
            .name("sample-network-peering")
            .description("Sample description")
            .vmwareEngineNetwork(network_peering_nw.id())
            .peerNetwork(network_peering_peer_nw.id())
            .peerNetworkType("VMWARE_ENGINE_NETWORK")
            .exportCustomRoutes(false)
            .importCustomRoutes(false)
            .exportCustomRoutesWithPublicIp(false)
            .importCustomRoutesWithPublicIp(false)
            .build());

    }
}

    resources:
  network-peering-nw:
    type: gcp:vmwareengine:Network
    properties:
      name: default-np-nw
      location: global
      type: STANDARD
  network-peering-peer-nw:
    type: gcp:vmwareengine:Network
    properties:
      name: peer-np-nw
      location: global
      type: STANDARD
  vmw-engine-network-peering:
    type: gcp:vmwareengine:NetworkPeering
    properties:
      name: sample-network-peering
      description: Sample description
      vmwareEngineNetwork: ${["network-peering-nw"].id}
      peerNetwork: ${["network-peering-peer-nw"].id}
      peerNetworkType: VMWARE_ENGINE_NETWORK
      exportCustomRoutes: false
      importCustomRoutes: false
      exportCustomRoutesWithPublicIp: false
      importCustomRoutesWithPublicIp: false

    Vmware Engine Network Peering Standard

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

const network_peering_vpc = new gcp.compute.Network("network-peering-vpc", {name: "default-vpc"});
const network_peering_standard_nw = new gcp.vmwareengine.Network("network-peering-standard-nw", {
    name: "default-standard-nw-np",
    location: "global",
    type: "STANDARD",
});
const vmw_engine_network_peering = new gcp.vmwareengine.NetworkPeering("vmw-engine-network-peering", {
    name: "sample-network-peering",
    description: "Sample description",
    peerNetwork: network_peering_vpc.id,
    peerNetworkType: "STANDARD",
    vmwareEngineNetwork: network_peering_standard_nw.id,
});

    import pulumi
import pulumi_gcp as gcp

network_peering_vpc = gcp.compute.Network("network-peering-vpc", name="default-vpc")
network_peering_standard_nw = gcp.vmwareengine.Network("network-peering-standard-nw",
    name="default-standard-nw-np",
    location="global",
    type="STANDARD")
vmw_engine_network_peering = gcp.vmwareengine.NetworkPeering("vmw-engine-network-peering",
    name="sample-network-peering",
    description="Sample description",
    peer_network=network_peering_vpc.id,
    peer_network_type="STANDARD",
    vmware_engine_network=network_peering_standard_nw.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network_peering_vpc, err := compute.NewNetwork(ctx, "network-peering-vpc", &compute.NetworkArgs{
			Name: pulumi.String("default-vpc"),
		})
		if err != nil {
			return err
		}
		network_peering_standard_nw, err := vmwareengine.NewNetwork(ctx, "network-peering-standard-nw", &vmwareengine.NetworkArgs{
			Name:     pulumi.String("default-standard-nw-np"),
			Location: pulumi.String("global"),
			Type:     pulumi.String("STANDARD"),
		})
		if err != nil {
			return err
		}
		_, err = vmwareengine.NewNetworkPeering(ctx, "vmw-engine-network-peering", &vmwareengine.NetworkPeeringArgs{
			Name:                pulumi.String("sample-network-peering"),
			Description:         pulumi.String("Sample description"),
			PeerNetwork:         network_peering_vpc.ID(),
			PeerNetworkType:     pulumi.String("STANDARD"),
			VmwareEngineNetwork: network_peering_standard_nw.ID(),
		})
		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 network_peering_vpc = new Gcp.Compute.Network("network-peering-vpc", new()
    {
        Name = "default-vpc",
    });

    var network_peering_standard_nw = new Gcp.VMwareEngine.Network("network-peering-standard-nw", new()
    {
        Name = "default-standard-nw-np",
        Location = "global",
        Type = "STANDARD",
    });

    var vmw_engine_network_peering = new Gcp.VMwareEngine.NetworkPeering("vmw-engine-network-peering", new()
    {
        Name = "sample-network-peering",
        Description = "Sample description",
        PeerNetwork = network_peering_vpc.Id,
        PeerNetworkType = "STANDARD",
        VmwareEngineNetwork = network_peering_standard_nw.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.vmwareengine.Network;
import com.pulumi.gcp.vmwareengine.NetworkArgs;
import com.pulumi.gcp.vmwareengine.NetworkPeering;
import com.pulumi.gcp.vmwareengine.NetworkPeeringArgs;
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 network_peering_vpc = new Network("network-peering-vpc", NetworkArgs.builder()
            .name("default-vpc")
            .build());

        var network_peering_standard_nw = new Network("network-peering-standard-nw", NetworkArgs.builder()
            .name("default-standard-nw-np")
            .location("global")
            .type("STANDARD")
            .build());

        var vmw_engine_network_peering = new NetworkPeering("vmw-engine-network-peering", NetworkPeeringArgs.builder()
            .name("sample-network-peering")
            .description("Sample description")
            .peerNetwork(network_peering_vpc.id())
            .peerNetworkType("STANDARD")
            .vmwareEngineNetwork(network_peering_standard_nw.id())
            .build());

    }
}

    resources:
  network-peering-vpc:
    type: gcp:compute:Network
    properties:
      name: default-vpc
  network-peering-standard-nw:
    type: gcp:vmwareengine:Network
    properties:
      name: default-standard-nw-np
      location: global
      type: STANDARD
  vmw-engine-network-peering:
    type: gcp:vmwareengine:NetworkPeering
    properties:
      name: sample-network-peering
      description: Sample description
      peerNetwork: ${["network-peering-vpc"].id}
      peerNetworkType: STANDARD
      vmwareEngineNetwork: ${["network-peering-standard-nw"].id}

    Create NetworkPeering Resource

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

    Constructor syntax

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

@overload
def NetworkPeering(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   peer_network: Optional[str] = None,
                   peer_network_type: Optional[str] = None,
                   vmware_engine_network: Optional[str] = None,
                   description: Optional[str] = None,
                   export_custom_routes: Optional[bool] = None,
                   export_custom_routes_with_public_ip: Optional[bool] = None,
                   import_custom_routes: Optional[bool] = None,
                   import_custom_routes_with_public_ip: Optional[bool] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None)
    func NewNetworkPeering(ctx *Context, name string, args NetworkPeeringArgs, opts ...ResourceOption) (*NetworkPeering, error)
    public NetworkPeering(string name, NetworkPeeringArgs args, CustomResourceOptions? opts = null)
    public NetworkPeering(String name, NetworkPeeringArgs args)
public NetworkPeering(String name, NetworkPeeringArgs args, CustomResourceOptions options)

    type: gcp:vmwareengine:NetworkPeering
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 NetworkPeeringArgs
    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 NetworkPeeringArgs
    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 NetworkPeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkPeeringArgs
    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 gcpNetworkPeeringResource = new Gcp.VMwareEngine.NetworkPeering("gcpNetworkPeeringResource", new()
{
    PeerNetwork = "string",
    PeerNetworkType = "string",
    VmwareEngineNetwork = "string",
    Description = "string",
    ExportCustomRoutes = false,
    ExportCustomRoutesWithPublicIp = false,
    ImportCustomRoutes = false,
    ImportCustomRoutesWithPublicIp = false,
    Name = "string",
    Project = "string",
});

    example, err := vmwareengine.NewNetworkPeering(ctx, "gcpNetworkPeeringResource", &vmwareengine.NetworkPeeringArgs{
	PeerNetwork:                    pulumi.String("string"),
	PeerNetworkType:                pulumi.String("string"),
	VmwareEngineNetwork:            pulumi.String("string"),
	Description:                    pulumi.String("string"),
	ExportCustomRoutes:             pulumi.Bool(false),
	ExportCustomRoutesWithPublicIp: pulumi.Bool(false),
	ImportCustomRoutes:             pulumi.Bool(false),
	ImportCustomRoutesWithPublicIp: pulumi.Bool(false),
	Name:                           pulumi.String("string"),
	Project:                        pulumi.String("string"),
})

    var gcpNetworkPeeringResource = new NetworkPeering("gcpNetworkPeeringResource", NetworkPeeringArgs.builder()
    .peerNetwork("string")
    .peerNetworkType("string")
    .vmwareEngineNetwork("string")
    .description("string")
    .exportCustomRoutes(false)
    .exportCustomRoutesWithPublicIp(false)
    .importCustomRoutes(false)
    .importCustomRoutesWithPublicIp(false)
    .name("string")
    .project("string")
    .build());

    gcp_network_peering_resource = gcp.vmwareengine.NetworkPeering("gcpNetworkPeeringResource",
    peer_network="string",
    peer_network_type="string",
    vmware_engine_network="string",
    description="string",
    export_custom_routes=False,
    export_custom_routes_with_public_ip=False,
    import_custom_routes=False,
    import_custom_routes_with_public_ip=False,
    name="string",
    project="string")

    const gcpNetworkPeeringResource = new gcp.vmwareengine.NetworkPeering("gcpNetworkPeeringResource", {
    peerNetwork: "string",
    peerNetworkType: "string",
    vmwareEngineNetwork: "string",
    description: "string",
    exportCustomRoutes: false,
    exportCustomRoutesWithPublicIp: false,
    importCustomRoutes: false,
    importCustomRoutesWithPublicIp: false,
    name: "string",
    project: "string",
});

    type: gcp:vmwareengine:NetworkPeering
properties:
    description: string
    exportCustomRoutes: false
    exportCustomRoutesWithPublicIp: false
    importCustomRoutes: false
    importCustomRoutesWithPublicIp: false
    name: string
    peerNetwork: string
    peerNetworkType: string
    project: string
    vmwareEngineNetwork: string

    NetworkPeering 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 NetworkPeering resource accepts the following input properties:

    PeerNetwork string
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    PeerNetworkType string
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    VmwareEngineNetwork string
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    Description string
    User-provided description for this network peering.
    ExportCustomRoutes bool
    True if custom routes are exported to the peered network; false otherwise.
    ExportCustomRoutesWithPublicIp bool
    True if all subnet routes with a public IP address range are exported; false otherwise.
    ImportCustomRoutes bool
    True if custom routes are imported from the peered network; false otherwise.
    ImportCustomRoutesWithPublicIp bool
    True if custom routes are imported from the peered network; false otherwise.
    Name string
    The ID of the Network Peering.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PeerNetwork string
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    PeerNetworkType string
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    VmwareEngineNetwork string
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    Description string
    User-provided description for this network peering.
    ExportCustomRoutes bool
    True if custom routes are exported to the peered network; false otherwise.
    ExportCustomRoutesWithPublicIp bool
    True if all subnet routes with a public IP address range are exported; false otherwise.
    ImportCustomRoutes bool
    True if custom routes are imported from the peered network; false otherwise.
    ImportCustomRoutesWithPublicIp bool
    True if custom routes are imported from the peered network; false otherwise.
    Name string
    The ID of the Network Peering.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    peerNetwork String
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peerNetworkType String
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    vmwareEngineNetwork String
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    description String
    User-provided description for this network peering.
    exportCustomRoutes Boolean
    True if custom routes are exported to the peered network; false otherwise.
    exportCustomRoutesWithPublicIp Boolean
    True if all subnet routes with a public IP address range are exported; false otherwise.
    importCustomRoutes Boolean
    True if custom routes are imported from the peered network; false otherwise.
    importCustomRoutesWithPublicIp Boolean
    True if custom routes are imported from the peered network; false otherwise.
    name String
    The ID of the Network Peering.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    peerNetwork string
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peerNetworkType string
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    vmwareEngineNetwork string
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    description string
    User-provided description for this network peering.
    exportCustomRoutes boolean
    True if custom routes are exported to the peered network; false otherwise.
    exportCustomRoutesWithPublicIp boolean
    True if all subnet routes with a public IP address range are exported; false otherwise.
    importCustomRoutes boolean
    True if custom routes are imported from the peered network; false otherwise.
    importCustomRoutesWithPublicIp boolean
    True if custom routes are imported from the peered network; false otherwise.
    name string
    The ID of the Network Peering.

    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    peer_network str
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peer_network_type str
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    vmware_engine_network str
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    description str
    User-provided description for this network peering.
    export_custom_routes bool
    True if custom routes are exported to the peered network; false otherwise.
    export_custom_routes_with_public_ip bool
    True if all subnet routes with a public IP address range are exported; false otherwise.
    import_custom_routes bool
    True if custom routes are imported from the peered network; false otherwise.
    import_custom_routes_with_public_ip bool
    True if custom routes are imported from the peered network; false otherwise.
    name str
    The ID of the Network Peering.

    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    peerNetwork String
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peerNetworkType String
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    vmwareEngineNetwork String
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    description String
    User-provided description for this network peering.
    exportCustomRoutes Boolean
    True if custom routes are exported to the peered network; false otherwise.
    exportCustomRoutesWithPublicIp Boolean
    True if all subnet routes with a public IP address range are exported; false otherwise.
    importCustomRoutes Boolean
    True if custom routes are imported from the peered network; false otherwise.
    importCustomRoutesWithPublicIp Boolean
    True if custom routes are imported from the peered network; false otherwise.
    name String
    The ID of the Network Peering.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    CreateTime string
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    StateDetails string
    Details about the current state of the network peering.
    Uid string
    System-generated unique identifier for the resource.
    UpdateTime string
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    VmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    CreateTime string
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    StateDetails string
    Details about the current state of the network peering.
    Uid string
    System-generated unique identifier for the resource.
    UpdateTime string
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    VmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    createTime String
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    stateDetails String
    Details about the current state of the network peering.
    uid String
    System-generated unique identifier for the resource.
    updateTime String
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmwareEngineNetworkCanonical String
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    createTime string
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    stateDetails string
    Details about the current state of the network peering.
    uid string
    System-generated unique identifier for the resource.
    updateTime string
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    create_time str
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    state_details str
    Details about the current state of the network peering.
    uid str
    System-generated unique identifier for the resource.
    update_time str
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmware_engine_network_canonical str
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    createTime String
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    stateDetails String
    Details about the current state of the network peering.
    uid String
    System-generated unique identifier for the resource.
    updateTime String
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmwareEngineNetworkCanonical String
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}

    Look up Existing NetworkPeering Resource

    Get an existing NetworkPeering 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?: NetworkPeeringState, opts?: CustomResourceOptions): NetworkPeering
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        export_custom_routes: Optional[bool] = None,
        export_custom_routes_with_public_ip: Optional[bool] = None,
        import_custom_routes: Optional[bool] = None,
        import_custom_routes_with_public_ip: Optional[bool] = None,
        name: Optional[str] = None,
        peer_network: Optional[str] = None,
        peer_network_type: Optional[str] = None,
        project: Optional[str] = None,
        state: Optional[str] = None,
        state_details: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None,
        vmware_engine_network: Optional[str] = None,
        vmware_engine_network_canonical: Optional[str] = None) -> NetworkPeering
    func GetNetworkPeering(ctx *Context, name string, id IDInput, state *NetworkPeeringState, opts ...ResourceOption) (*NetworkPeering, error)
    public static NetworkPeering Get(string name, Input<string> id, NetworkPeeringState? state, CustomResourceOptions? opts = null)
    public static NetworkPeering get(String name, Output<String> id, NetworkPeeringState state, CustomResourceOptions options)
    resources:  _:    type: gcp:vmwareengine:NetworkPeering    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:
    CreateTime string
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Description string
    User-provided description for this network peering.
    ExportCustomRoutes bool
    True if custom routes are exported to the peered network; false otherwise.
    ExportCustomRoutesWithPublicIp bool
    True if all subnet routes with a public IP address range are exported; false otherwise.
    ImportCustomRoutes bool
    True if custom routes are imported from the peered network; false otherwise.
    ImportCustomRoutesWithPublicIp bool
    True if custom routes are imported from the peered network; false otherwise.
    Name string
    The ID of the Network Peering.

    PeerNetwork string
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    PeerNetworkType string
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    State string
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    StateDetails string
    Details about the current state of the network peering.
    Uid string
    System-generated unique identifier for the resource.
    UpdateTime string
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    VmwareEngineNetwork string
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    VmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    CreateTime string
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Description string
    User-provided description for this network peering.
    ExportCustomRoutes bool
    True if custom routes are exported to the peered network; false otherwise.
    ExportCustomRoutesWithPublicIp bool
    True if all subnet routes with a public IP address range are exported; false otherwise.
    ImportCustomRoutes bool
    True if custom routes are imported from the peered network; false otherwise.
    ImportCustomRoutesWithPublicIp bool
    True if custom routes are imported from the peered network; false otherwise.
    Name string
    The ID of the Network Peering.

    PeerNetwork string
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    PeerNetworkType string
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    State string
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    StateDetails string
    Details about the current state of the network peering.
    Uid string
    System-generated unique identifier for the resource.
    UpdateTime string
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    VmwareEngineNetwork string
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    VmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    createTime String
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    description String
    User-provided description for this network peering.
    exportCustomRoutes Boolean
    True if custom routes are exported to the peered network; false otherwise.
    exportCustomRoutesWithPublicIp Boolean
    True if all subnet routes with a public IP address range are exported; false otherwise.
    importCustomRoutes Boolean
    True if custom routes are imported from the peered network; false otherwise.
    importCustomRoutesWithPublicIp Boolean
    True if custom routes are imported from the peered network; false otherwise.
    name String
    The ID of the Network Peering.

    peerNetwork String
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peerNetworkType String
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state String
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    stateDetails String
    Details about the current state of the network peering.
    uid String
    System-generated unique identifier for the resource.
    updateTime String
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmwareEngineNetwork String
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmwareEngineNetworkCanonical String
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    createTime string
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    description string
    User-provided description for this network peering.
    exportCustomRoutes boolean
    True if custom routes are exported to the peered network; false otherwise.
    exportCustomRoutesWithPublicIp boolean
    True if all subnet routes with a public IP address range are exported; false otherwise.
    importCustomRoutes boolean
    True if custom routes are imported from the peered network; false otherwise.
    importCustomRoutesWithPublicIp boolean
    True if custom routes are imported from the peered network; false otherwise.
    name string
    The ID of the Network Peering.

    peerNetwork string
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peerNetworkType string
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state string
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    stateDetails string
    Details about the current state of the network peering.
    uid string
    System-generated unique identifier for the resource.
    updateTime string
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmwareEngineNetwork string
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmwareEngineNetworkCanonical string
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    create_time str
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    description str
    User-provided description for this network peering.
    export_custom_routes bool
    True if custom routes are exported to the peered network; false otherwise.
    export_custom_routes_with_public_ip bool
    True if all subnet routes with a public IP address range are exported; false otherwise.
    import_custom_routes bool
    True if custom routes are imported from the peered network; false otherwise.
    import_custom_routes_with_public_ip bool
    True if custom routes are imported from the peered network; false otherwise.
    name str
    The ID of the Network Peering.

    peer_network str
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peer_network_type str
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state str
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    state_details str
    Details about the current state of the network peering.
    uid str
    System-generated unique identifier for the resource.
    update_time str
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmware_engine_network str
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmware_engine_network_canonical str
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
    createTime String
    Creation time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    description String
    User-provided description for this network peering.
    exportCustomRoutes Boolean
    True if custom routes are exported to the peered network; false otherwise.
    exportCustomRoutesWithPublicIp Boolean
    True if all subnet routes with a public IP address range are exported; false otherwise.
    importCustomRoutes Boolean
    True if custom routes are imported from the peered network; false otherwise.
    importCustomRoutesWithPublicIp Boolean
    True if custom routes are imported from the peered network; false otherwise.
    name String
    The ID of the Network Peering.

    peerNetwork String
    The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network.
    peerNetworkType String
    The type of the network to peer with the VMware Engine network. Possible values are: STANDARD, VMWARE_ENGINE_NETWORK, PRIVATE_SERVICES_ACCESS, NETAPP_CLOUD_VOLUMES, THIRD_PARTY_SERVICE, DELL_POWERSCALE.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state String
    State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.
    stateDetails String
    Details about the current state of the network peering.
    uid String
    System-generated unique identifier for the resource.
    updateTime String
    Last updated time of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    vmwareEngineNetwork String
    The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
    vmwareEngineNetworkCanonical String
    The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}

    Import

    NetworkPeering can be imported using any of these accepted formats:

    • projects/{{project}}/locations/global/networkPeerings/{{name}}

    • {{project}}/{{name}}

    • {{name}}

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

    $ pulumi import gcp:vmwareengine/networkPeering:NetworkPeering default projects/{{project}}/locations/global/networkPeerings/{{name}}

    $ pulumi import gcp:vmwareengine/networkPeering:NetworkPeering default {{project}}/{{name}}

    $ pulumi import gcp:vmwareengine/networkPeering:NetworkPeering default {{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.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
    pulumi/pulumi-gcp