pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/NetworkPeeringArgs

NetworkPeeringArgs

data class NetworkPeeringArgs(val exportCustomRoutes: Output<Boolean>? = null, val exportSubnetRoutesWithPublicIp: Output<Boolean>? = null, val importCustomRoutes: Output<Boolean>? = null, val importSubnetRoutesWithPublicIp: Output<Boolean>? = null, val name: Output<String>? = null, val network: Output<String>? = null, val peerNetwork: Output<String>? = null, val stackType: Output<String>? = null) : ConvertibleToJava<NetworkPeeringArgs>

Manages a network peering within GCE. For more information see the official documentation and API.

Both networks must create a peering with each other for the peering to be functional. Subnets IP ranges across peered VPC networks cannot overlap.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.Network("default", {
    name: "foobar",
    autoCreateSubnetworks: false,
});
const other = new gcp.compute.Network("other", {
    name: "other",
    autoCreateSubnetworks: false,
});
const peering1 = new gcp.compute.NetworkPeering("peering1", {
    name: "peering1",
    network: _default.selfLink,
    peerNetwork: other.selfLink,
});
const peering2 = new gcp.compute.NetworkPeering("peering2", {
    name: "peering2",
    network: other.selfLink,
    peerNetwork: _default.selfLink,
});

import pulumi
import pulumi_gcp as gcp
default = gcp.compute.Network("default",
    name="foobar",
    auto_create_subnetworks=False)
other = gcp.compute.Network("other",
    name="other",
    auto_create_subnetworks=False)
peering1 = gcp.compute.NetworkPeering("peering1",
    name="peering1",
    network=default.self_link,
    peer_network=other.self_link)
peering2 = gcp.compute.NetworkPeering("peering2",
    name="peering2",
    network=other.self_link,
    peer_network=default.self_link)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Compute.Network("default", new()
    {
        Name = "foobar",
        AutoCreateSubnetworks = false,
    });
    var other = new Gcp.Compute.Network("other", new()
    {
        Name = "other",
        AutoCreateSubnetworks = false,
    });
    var peering1 = new Gcp.Compute.NetworkPeering("peering1", new()
    {
        Name = "peering1",
        Network = @default.SelfLink,
        PeerNetwork = other.SelfLink,
    });
    var peering2 = new Gcp.Compute.NetworkPeering("peering2", new()
    {
        Name = "peering2",
        Network = other.SelfLink,
        PeerNetwork = @default.SelfLink,
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name:                  pulumi.String("foobar"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		other, err := compute.NewNetwork(ctx, "other", &compute.NetworkArgs{
			Name:                  pulumi.String("other"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewNetworkPeering(ctx, "peering1", &compute.NetworkPeeringArgs{
			Name:        pulumi.String("peering1"),
			Network:     _default.SelfLink,
			PeerNetwork: other.SelfLink,
		})
		if err != nil {
			return err
		}
		_, err = compute.NewNetworkPeering(ctx, "peering2", &compute.NetworkPeeringArgs{
			Name:        pulumi.String("peering2"),
			Network:     other.SelfLink,
			PeerNetwork: _default.SelfLink,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.compute.NetworkPeering;
import com.pulumi.gcp.compute.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 default_ = new Network("default", NetworkArgs.builder()
            .name("foobar")
            .autoCreateSubnetworks("false")
            .build());
        var other = new Network("other", NetworkArgs.builder()
            .name("other")
            .autoCreateSubnetworks("false")
            .build());
        var peering1 = new NetworkPeering("peering1", NetworkPeeringArgs.builder()
            .name("peering1")
            .network(default_.selfLink())
            .peerNetwork(other.selfLink())
            .build());
        var peering2 = new NetworkPeering("peering2", NetworkPeeringArgs.builder()
            .name("peering2")
            .network(other.selfLink())
            .peerNetwork(default_.selfLink())
            .build());
    }
}

resources:
  peering1:
    type: gcp:compute:NetworkPeering
    properties:
      name: peering1
      network: ${default.selfLink}
      peerNetwork: ${other.selfLink}
  peering2:
    type: gcp:compute:NetworkPeering
    properties:
      name: peering2
      network: ${other.selfLink}
      peerNetwork: ${default.selfLink}
  default:
    type: gcp:compute:Network
    properties:
      name: foobar
      autoCreateSubnetworks: 'false'
  other:
    type: gcp:compute:Network
    properties:
      name: other
      autoCreateSubnetworks: 'false'

Import

VPC network peerings can be imported using the name and project of the primary network the peering exists in and the name of the network peering

{{project_id}}/{{network_id}}/{{peering_id}} When using the pulumi import command, VPC network peerings can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/networkPeering:NetworkPeering default {{project_id}}/{{network_id}}/{{peering_id}}

Constructors

NetworkPeeringArgs

constructor(exportCustomRoutes: Output<Boolean>? = null, exportSubnetRoutesWithPublicIp: Output<Boolean>? = null, importCustomRoutes: Output<Boolean>? = null, importSubnetRoutesWithPublicIp: Output<Boolean>? = null, name: Output<String>? = null, network: Output<String>? = null, peerNetwork: Output<String>? = null, stackType: Output<String>? = null)

Properties

exportCustomRoutes

val exportCustomRoutes: Output<Boolean>? = null

Whether to export the custom routes to the peer network. Defaults to false.

exportSubnetRoutesWithPublicIp

val exportSubnetRoutesWithPublicIp: Output<Boolean>? = null

Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

importCustomRoutes

val importCustomRoutes: Output<Boolean>? = null

Whether to import the custom routes from the peer network. Defaults to false.

importSubnetRoutesWithPublicIp

val importSubnetRoutesWithPublicIp: Output<Boolean>? = null

Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field.

name

val name: Output<String>? = null

Name of the peering.

network

val network: Output<String>? = null

The primary network of the peering.

peerNetwork

val peerNetwork: Output<String>? = null

The peer network in the peering. The peer network may belong to a different project.

stackType

val stackType: Output<String>? = null

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Possible values: "IPV4_ONLY", "IPV4_IPV6".

Functions

toJava

open override fun toJava(): NetworkPeeringArgs