NetworkPeering class

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

To get more information about NetworkPeering, see:

API documentation

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)

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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().ToIDOutput().ToStringOutput(),
			PeerNetwork:                    network_peering_peer_nw.ID().ToIDOutput().ToStringOutput(),
			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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_vmwareengine_network" "network-peering-nw" {
  name     = "default-np-nw"
  location = "global"
  type     = "STANDARD"
}
resource "gcp_vmwareengine_network" "network-peering-peer-nw" {
  name     = "peer-np-nw"
  location = "global"
  type     = "STANDARD"
}
resource "gcp_vmwareengine_networkpeering" "vmw-engine-network-peering" {
  name                                = "sample-network-peering"
  description                         = "Sample description"
  vmware_engine_network               = gcp_vmwareengine_network.network-peering-nw.id
  peer_network                        = gcp_vmwareengine_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 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.ArrayList;
import java.util.Arrays;
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)

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/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().ToIDOutput().ToStringOutput(),
			PeerNetworkType:     pulumi.String("STANDARD"),
			VmwareEngineNetwork: network_peering_standard_nw.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_network" "network-peering-vpc" {
  name = "default-vpc"
}
resource "gcp_vmwareengine_network" "network-peering-standard-nw" {
  name     = "default-standard-nw-np"
  location = "global"
  type     = "STANDARD"
}
resource "gcp_vmwareengine_networkpeering" "vmw-engine-network-peering" {
  name                  = "sample-network-peering"
  description           = "Sample description"
  peer_network          = gcp_compute_network.network-peering-vpc.id
  peer_network_type     = "STANDARD"
  vmware_engine_network = gcp_vmwareengine_network.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.vmwareengine.NetworkPeering;
import com.pulumi.gcp.vmwareengine.NetworkPeeringArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 com.pulumi.gcp.compute.Network("network-peering-vpc", com.pulumi.gcp.compute.NetworkArgs.builder()
            .name("default-vpc")
            .build());

        var network_peering_standard_nw = new com.pulumi.gcp.vmwareengine.Network("network-peering-standard-nw", com.pulumi.gcp.vmwareengine.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}

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}}

Constructors

NetworkPeering(String name, {NetworkPeeringArgs? args, CustomResourceOptions? options}): Creates a new NetworkPeering. name The Pulumi resource name. args Arguments used to configure this NetworkPeering. The set of arguments for NetworkPeering. options Resource options controlling this resource's behavior.
NetworkPeering.reference(String urn): Creates a typed reference to an existing NetworkPeering resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<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".
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: User-provided description for this network peering.
latefinal
exportCustomRoutes ↔ Output<bool?>: True if custom routes are exported to the peered network; false otherwise.
latefinal
exportCustomRoutesWithPublicIp ↔ Output<bool?>: True if all subnet routes with a public IP address range are exported; false otherwise.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
importCustomRoutes ↔ Output<bool?>: True if custom routes are imported from the peered network; false otherwise.
latefinal
importCustomRoutesWithPublicIp ↔ Output<bool?>: True if custom routes are imported from the peered network; false otherwise.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: The ID of the Network Peering.
latefinal
peerNetwork ↔ Output<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.
latefinal
peerNetworkType ↔ Output<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, GOOGLE_CLOUD_NETAPP_VOLUMES.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state ↔ Output<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.
latefinal
stateDetails ↔ Output<String>: Details about the current state of the network peering.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
uid ↔ Output<String>: System-generated unique identifier for the resource.
latefinal
updateTime ↔ Output<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".
latefinal
urn ↔ Output<String>: latefinalinherited
vmwareEngineNetwork ↔ Output<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.
latefinal
vmwareEngineNetworkCanonical ↔ Output<String>: The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
latefinal

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {NetworkPeeringState? state, CustomResourceOptions? options}) → NetworkPeering: Gets an existing NetworkPeering resource's state with the given name and id.