gcp.compute.RouterPeer
Explore with Pulumi AI
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
To get more information about RouterBgpPeer, see:
- API documentation
- How-to Guides
Example Usage
Router Peer Basic
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var peer = new Gcp.Compute.RouterPeer("peer", new()
{
AdvertisedRoutePriority = 100,
Interface = "interface-1",
PeerAsn = 65513,
Region = "us-central1",
Router = "my-router",
});
});
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.NewRouterPeer(ctx, "peer", &compute.RouterPeerArgs{
AdvertisedRoutePriority: pulumi.Int(100),
Interface: pulumi.String("interface-1"),
PeerAsn: pulumi.Int(65513),
Region: pulumi.String("us-central1"),
Router: pulumi.String("my-router"),
})
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.RouterPeer;
import com.pulumi.gcp.compute.RouterPeerArgs;
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 peer = new RouterPeer("peer", RouterPeerArgs.builder()
.advertisedRoutePriority(100)
.interface_("interface-1")
.peerAsn(65513)
.region("us-central1")
.router("my-router")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
peer = gcp.compute.RouterPeer("peer",
advertised_route_priority=100,
interface="interface-1",
peer_asn=65513,
region="us-central1",
router="my-router")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const peer = new gcp.compute.RouterPeer("peer", {
advertisedRoutePriority: 100,
"interface": "interface-1",
peerAsn: 65513,
region: "us-central1",
router: "my-router",
});
resources:
peer:
type: gcp:compute:RouterPeer
properties:
advertisedRoutePriority: 100
interface: interface-1
peerAsn: 65513
region: us-central1
router: my-router
Router Peer Disabled
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var peer = new Gcp.Compute.RouterPeer("peer", new()
{
AdvertisedRoutePriority = 100,
Enable = false,
Interface = "interface-1",
PeerAsn = 65513,
PeerIpAddress = "169.254.1.2",
Region = "us-central1",
Router = "my-router",
});
});
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.NewRouterPeer(ctx, "peer", &compute.RouterPeerArgs{
AdvertisedRoutePriority: pulumi.Int(100),
Enable: pulumi.Bool(false),
Interface: pulumi.String("interface-1"),
PeerAsn: pulumi.Int(65513),
PeerIpAddress: pulumi.String("169.254.1.2"),
Region: pulumi.String("us-central1"),
Router: pulumi.String("my-router"),
})
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.RouterPeer;
import com.pulumi.gcp.compute.RouterPeerArgs;
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 peer = new RouterPeer("peer", RouterPeerArgs.builder()
.advertisedRoutePriority(100)
.enable(false)
.interface_("interface-1")
.peerAsn(65513)
.peerIpAddress("169.254.1.2")
.region("us-central1")
.router("my-router")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
peer = gcp.compute.RouterPeer("peer",
advertised_route_priority=100,
enable=False,
interface="interface-1",
peer_asn=65513,
peer_ip_address="169.254.1.2",
region="us-central1",
router="my-router")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const peer = new gcp.compute.RouterPeer("peer", {
advertisedRoutePriority: 100,
enable: false,
"interface": "interface-1",
peerAsn: 65513,
peerIpAddress: "169.254.1.2",
region: "us-central1",
router: "my-router",
});
resources:
peer:
type: gcp:compute:RouterPeer
properties:
advertisedRoutePriority: 100
enable: false
interface: interface-1
peerAsn: 65513
peerIpAddress: 169.254.1.2
region: us-central1
router: my-router
Router Peer Bfd
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var peer = new Gcp.Compute.RouterPeer("peer", new()
{
AdvertisedRoutePriority = 100,
Bfd = new Gcp.Compute.Inputs.RouterPeerBfdArgs
{
MinReceiveInterval = 1000,
MinTransmitInterval = 1000,
Multiplier = 5,
SessionInitializationMode = "ACTIVE",
},
Interface = "interface-1",
PeerAsn = 65513,
PeerIpAddress = "169.254.1.2",
Region = "us-central1",
Router = "my-router",
});
});
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.NewRouterPeer(ctx, "peer", &compute.RouterPeerArgs{
AdvertisedRoutePriority: pulumi.Int(100),
Bfd: &compute.RouterPeerBfdArgs{
MinReceiveInterval: pulumi.Int(1000),
MinTransmitInterval: pulumi.Int(1000),
Multiplier: pulumi.Int(5),
SessionInitializationMode: pulumi.String("ACTIVE"),
},
Interface: pulumi.String("interface-1"),
PeerAsn: pulumi.Int(65513),
PeerIpAddress: pulumi.String("169.254.1.2"),
Region: pulumi.String("us-central1"),
Router: pulumi.String("my-router"),
})
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.RouterPeer;
import com.pulumi.gcp.compute.RouterPeerArgs;
import com.pulumi.gcp.compute.inputs.RouterPeerBfdArgs;
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 peer = new RouterPeer("peer", RouterPeerArgs.builder()
.advertisedRoutePriority(100)
.bfd(RouterPeerBfdArgs.builder()
.minReceiveInterval(1000)
.minTransmitInterval(1000)
.multiplier(5)
.sessionInitializationMode("ACTIVE")
.build())
.interface_("interface-1")
.peerAsn(65513)
.peerIpAddress("169.254.1.2")
.region("us-central1")
.router("my-router")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
peer = gcp.compute.RouterPeer("peer",
advertised_route_priority=100,
bfd=gcp.compute.RouterPeerBfdArgs(
min_receive_interval=1000,
min_transmit_interval=1000,
multiplier=5,
session_initialization_mode="ACTIVE",
),
interface="interface-1",
peer_asn=65513,
peer_ip_address="169.254.1.2",
region="us-central1",
router="my-router")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const peer = new gcp.compute.RouterPeer("peer", {
advertisedRoutePriority: 100,
bfd: {
minReceiveInterval: 1000,
minTransmitInterval: 1000,
multiplier: 5,
sessionInitializationMode: "ACTIVE",
},
"interface": "interface-1",
peerAsn: 65513,
peerIpAddress: "169.254.1.2",
region: "us-central1",
router: "my-router",
});
resources:
peer:
type: gcp:compute:RouterPeer
properties:
advertisedRoutePriority: 100
bfd:
minReceiveInterval: 1000
minTransmitInterval: 1000
multiplier: 5
sessionInitializationMode: ACTIVE
interface: interface-1
peerAsn: 65513
peerIpAddress: 169.254.1.2
region: us-central1
router: my-router
Router Peer Router Appliance
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var network = new Gcp.Compute.Network("network", new()
{
AutoCreateSubnetworks = false,
});
var subnetwork = new Gcp.Compute.Subnetwork("subnetwork", new()
{
Network = network.SelfLink,
IpCidrRange = "10.0.0.0/16",
Region = "us-central1",
});
var addrIntf = new Gcp.Compute.Address("addrIntf", new()
{
Region = subnetwork.Region,
Subnetwork = subnetwork.Id,
AddressType = "INTERNAL",
});
var addrIntfRedundant = new Gcp.Compute.Address("addrIntfRedundant", new()
{
Region = subnetwork.Region,
Subnetwork = subnetwork.Id,
AddressType = "INTERNAL",
});
var addrPeer = new Gcp.Compute.Address("addrPeer", new()
{
Region = subnetwork.Region,
Subnetwork = subnetwork.Id,
AddressType = "INTERNAL",
});
var instance = new Gcp.Compute.Instance("instance", new()
{
Zone = "us-central1-a",
MachineType = "e2-medium",
CanIpForward = true,
BootDisk = new Gcp.Compute.Inputs.InstanceBootDiskArgs
{
InitializeParams = new Gcp.Compute.Inputs.InstanceBootDiskInitializeParamsArgs
{
Image = "debian-cloud/debian-11",
},
},
NetworkInterfaces = new[]
{
new Gcp.Compute.Inputs.InstanceNetworkInterfaceArgs
{
NetworkIp = addrPeer.IPAddress,
Subnetwork = subnetwork.SelfLink,
},
},
});
var hub = new Gcp.NetworkConnectivity.Hub("hub");
var spoke = new Gcp.NetworkConnectivity.Spoke("spoke", new()
{
Location = subnetwork.Region,
Hub = hub.Id,
LinkedRouterApplianceInstances = new Gcp.NetworkConnectivity.Inputs.SpokeLinkedRouterApplianceInstancesArgs
{
Instances = new[]
{
new Gcp.NetworkConnectivity.Inputs.SpokeLinkedRouterApplianceInstancesInstanceArgs
{
VirtualMachine = instance.SelfLink,
IpAddress = addrPeer.IPAddress,
},
},
SiteToSiteDataTransfer = false,
},
});
var router = new Gcp.Compute.Router("router", new()
{
Region = subnetwork.Region,
Network = network.SelfLink,
Bgp = new Gcp.Compute.Inputs.RouterBgpArgs
{
Asn = 64514,
},
});
var interfaceRedundant = new Gcp.Compute.RouterInterface("interfaceRedundant", new()
{
Region = router.Region,
Router = router.Name,
Subnetwork = subnetwork.SelfLink,
PrivateIpAddress = addrIntfRedundant.IPAddress,
});
var @interface = new Gcp.Compute.RouterInterface("interface", new()
{
Region = router.Region,
Router = router.Name,
Subnetwork = subnetwork.SelfLink,
PrivateIpAddress = addrIntf.IPAddress,
RedundantInterface = interfaceRedundant.Name,
});
var peer = new Gcp.Compute.RouterPeer("peer", new()
{
Router = router.Name,
Region = router.Region,
Interface = @interface.Name,
RouterApplianceInstance = instance.SelfLink,
PeerAsn = 65513,
PeerIpAddress = addrPeer.IPAddress,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/networkconnectivity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
subnetwork, err := compute.NewSubnetwork(ctx, "subnetwork", &compute.SubnetworkArgs{
Network: network.SelfLink,
IpCidrRange: pulumi.String("10.0.0.0/16"),
Region: pulumi.String("us-central1"),
})
if err != nil {
return err
}
addrIntf, err := compute.NewAddress(ctx, "addrIntf", &compute.AddressArgs{
Region: subnetwork.Region,
Subnetwork: subnetwork.ID(),
AddressType: pulumi.String("INTERNAL"),
})
if err != nil {
return err
}
addrIntfRedundant, err := compute.NewAddress(ctx, "addrIntfRedundant", &compute.AddressArgs{
Region: subnetwork.Region,
Subnetwork: subnetwork.ID(),
AddressType: pulumi.String("INTERNAL"),
})
if err != nil {
return err
}
addrPeer, err := compute.NewAddress(ctx, "addrPeer", &compute.AddressArgs{
Region: subnetwork.Region,
Subnetwork: subnetwork.ID(),
AddressType: pulumi.String("INTERNAL"),
})
if err != nil {
return err
}
instance, err := compute.NewInstance(ctx, "instance", &compute.InstanceArgs{
Zone: pulumi.String("us-central1-a"),
MachineType: pulumi.String("e2-medium"),
CanIpForward: pulumi.Bool(true),
BootDisk: &compute.InstanceBootDiskArgs{
InitializeParams: &compute.InstanceBootDiskInitializeParamsArgs{
Image: pulumi.String("debian-cloud/debian-11"),
},
},
NetworkInterfaces: compute.InstanceNetworkInterfaceArray{
&compute.InstanceNetworkInterfaceArgs{
NetworkIp: addrPeer.Address,
Subnetwork: subnetwork.SelfLink,
},
},
})
if err != nil {
return err
}
hub, err := networkconnectivity.NewHub(ctx, "hub", nil)
if err != nil {
return err
}
_, err = networkconnectivity.NewSpoke(ctx, "spoke", &networkconnectivity.SpokeArgs{
Location: subnetwork.Region,
Hub: hub.ID(),
LinkedRouterApplianceInstances: &networkconnectivity.SpokeLinkedRouterApplianceInstancesArgs{
Instances: networkconnectivity.SpokeLinkedRouterApplianceInstancesInstanceArray{
&networkconnectivity.SpokeLinkedRouterApplianceInstancesInstanceArgs{
VirtualMachine: instance.SelfLink,
IpAddress: addrPeer.Address,
},
},
SiteToSiteDataTransfer: pulumi.Bool(false),
},
})
if err != nil {
return err
}
router, err := compute.NewRouter(ctx, "router", &compute.RouterArgs{
Region: subnetwork.Region,
Network: network.SelfLink,
Bgp: &compute.RouterBgpArgs{
Asn: pulumi.Int(64514),
},
})
if err != nil {
return err
}
interfaceRedundant, err := compute.NewRouterInterface(ctx, "interfaceRedundant", &compute.RouterInterfaceArgs{
Region: router.Region,
Router: router.Name,
Subnetwork: subnetwork.SelfLink,
PrivateIpAddress: addrIntfRedundant.Address,
})
if err != nil {
return err
}
interface, err := compute.NewRouterInterface(ctx, "interface", &compute.RouterInterfaceArgs{
Region: router.Region,
Router: router.Name,
Subnetwork: subnetwork.SelfLink,
PrivateIpAddress: addrIntf.Address,
RedundantInterface: interfaceRedundant.Name,
})
if err != nil {
return err
}
_, err = compute.NewRouterPeer(ctx, "peer", &compute.RouterPeerArgs{
Router: router.Name,
Region: router.Region,
Interface: interface.Name,
RouterApplianceInstance: instance.SelfLink,
PeerAsn: pulumi.Int(65513),
PeerIpAddress: addrPeer.Address,
})
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.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
import com.pulumi.gcp.compute.Instance;
import com.pulumi.gcp.compute.InstanceArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskInitializeParamsArgs;
import com.pulumi.gcp.compute.inputs.InstanceNetworkInterfaceArgs;
import com.pulumi.gcp.networkconnectivity.Hub;
import com.pulumi.gcp.networkconnectivity.Spoke;
import com.pulumi.gcp.networkconnectivity.SpokeArgs;
import com.pulumi.gcp.networkconnectivity.inputs.SpokeLinkedRouterApplianceInstancesArgs;
import com.pulumi.gcp.compute.Router;
import com.pulumi.gcp.compute.RouterArgs;
import com.pulumi.gcp.compute.inputs.RouterBgpArgs;
import com.pulumi.gcp.compute.RouterInterface;
import com.pulumi.gcp.compute.RouterInterfaceArgs;
import com.pulumi.gcp.compute.RouterPeer;
import com.pulumi.gcp.compute.RouterPeerArgs;
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 = new Network("network", NetworkArgs.builder()
.autoCreateSubnetworks(false)
.build());
var subnetwork = new Subnetwork("subnetwork", SubnetworkArgs.builder()
.network(network.selfLink())
.ipCidrRange("10.0.0.0/16")
.region("us-central1")
.build());
var addrIntf = new Address("addrIntf", AddressArgs.builder()
.region(subnetwork.region())
.subnetwork(subnetwork.id())
.addressType("INTERNAL")
.build());
var addrIntfRedundant = new Address("addrIntfRedundant", AddressArgs.builder()
.region(subnetwork.region())
.subnetwork(subnetwork.id())
.addressType("INTERNAL")
.build());
var addrPeer = new Address("addrPeer", AddressArgs.builder()
.region(subnetwork.region())
.subnetwork(subnetwork.id())
.addressType("INTERNAL")
.build());
var instance = new Instance("instance", InstanceArgs.builder()
.zone("us-central1-a")
.machineType("e2-medium")
.canIpForward(true)
.bootDisk(InstanceBootDiskArgs.builder()
.initializeParams(InstanceBootDiskInitializeParamsArgs.builder()
.image("debian-cloud/debian-11")
.build())
.build())
.networkInterfaces(InstanceNetworkInterfaceArgs.builder()
.networkIp(addrPeer.address())
.subnetwork(subnetwork.selfLink())
.build())
.build());
var hub = new Hub("hub");
var spoke = new Spoke("spoke", SpokeArgs.builder()
.location(subnetwork.region())
.hub(hub.id())
.linkedRouterApplianceInstances(SpokeLinkedRouterApplianceInstancesArgs.builder()
.instances(SpokeLinkedRouterApplianceInstancesInstanceArgs.builder()
.virtualMachine(instance.selfLink())
.ipAddress(addrPeer.address())
.build())
.siteToSiteDataTransfer(false)
.build())
.build());
var router = new Router("router", RouterArgs.builder()
.region(subnetwork.region())
.network(network.selfLink())
.bgp(RouterBgpArgs.builder()
.asn(64514)
.build())
.build());
var interfaceRedundant = new RouterInterface("interfaceRedundant", RouterInterfaceArgs.builder()
.region(router.region())
.router(router.name())
.subnetwork(subnetwork.selfLink())
.privateIpAddress(addrIntfRedundant.address())
.build());
var interface_ = new RouterInterface("interface", RouterInterfaceArgs.builder()
.region(router.region())
.router(router.name())
.subnetwork(subnetwork.selfLink())
.privateIpAddress(addrIntf.address())
.redundantInterface(interfaceRedundant.name())
.build());
var peer = new RouterPeer("peer", RouterPeerArgs.builder()
.router(router.name())
.region(router.region())
.interface_(interface_.name())
.routerApplianceInstance(instance.selfLink())
.peerAsn(65513)
.peerIpAddress(addrPeer.address())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
network = gcp.compute.Network("network", auto_create_subnetworks=False)
subnetwork = gcp.compute.Subnetwork("subnetwork",
network=network.self_link,
ip_cidr_range="10.0.0.0/16",
region="us-central1")
addr_intf = gcp.compute.Address("addrIntf",
region=subnetwork.region,
subnetwork=subnetwork.id,
address_type="INTERNAL")
addr_intf_redundant = gcp.compute.Address("addrIntfRedundant",
region=subnetwork.region,
subnetwork=subnetwork.id,
address_type="INTERNAL")
addr_peer = gcp.compute.Address("addrPeer",
region=subnetwork.region,
subnetwork=subnetwork.id,
address_type="INTERNAL")
instance = gcp.compute.Instance("instance",
zone="us-central1-a",
machine_type="e2-medium",
can_ip_forward=True,
boot_disk=gcp.compute.InstanceBootDiskArgs(
initialize_params=gcp.compute.InstanceBootDiskInitializeParamsArgs(
image="debian-cloud/debian-11",
),
),
network_interfaces=[gcp.compute.InstanceNetworkInterfaceArgs(
network_ip=addr_peer.address,
subnetwork=subnetwork.self_link,
)])
hub = gcp.networkconnectivity.Hub("hub")
spoke = gcp.networkconnectivity.Spoke("spoke",
location=subnetwork.region,
hub=hub.id,
linked_router_appliance_instances=gcp.networkconnectivity.SpokeLinkedRouterApplianceInstancesArgs(
instances=[gcp.networkconnectivity.SpokeLinkedRouterApplianceInstancesInstanceArgs(
virtual_machine=instance.self_link,
ip_address=addr_peer.address,
)],
site_to_site_data_transfer=False,
))
router = gcp.compute.Router("router",
region=subnetwork.region,
network=network.self_link,
bgp=gcp.compute.RouterBgpArgs(
asn=64514,
))
interface_redundant = gcp.compute.RouterInterface("interfaceRedundant",
region=router.region,
router=router.name,
subnetwork=subnetwork.self_link,
private_ip_address=addr_intf_redundant.address)
interface = gcp.compute.RouterInterface("interface",
region=router.region,
router=router.name,
subnetwork=subnetwork.self_link,
private_ip_address=addr_intf.address,
redundant_interface=interface_redundant.name)
peer = gcp.compute.RouterPeer("peer",
router=router.name,
region=router.region,
interface=interface.name,
router_appliance_instance=instance.self_link,
peer_asn=65513,
peer_ip_address=addr_peer.address)
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const network = new gcp.compute.Network("network", {autoCreateSubnetworks: false});
const subnetwork = new gcp.compute.Subnetwork("subnetwork", {
network: network.selfLink,
ipCidrRange: "10.0.0.0/16",
region: "us-central1",
});
const addrIntf = new gcp.compute.Address("addrIntf", {
region: subnetwork.region,
subnetwork: subnetwork.id,
addressType: "INTERNAL",
});
const addrIntfRedundant = new gcp.compute.Address("addrIntfRedundant", {
region: subnetwork.region,
subnetwork: subnetwork.id,
addressType: "INTERNAL",
});
const addrPeer = new gcp.compute.Address("addrPeer", {
region: subnetwork.region,
subnetwork: subnetwork.id,
addressType: "INTERNAL",
});
const instance = new gcp.compute.Instance("instance", {
zone: "us-central1-a",
machineType: "e2-medium",
canIpForward: true,
bootDisk: {
initializeParams: {
image: "debian-cloud/debian-11",
},
},
networkInterfaces: [{
networkIp: addrPeer.address,
subnetwork: subnetwork.selfLink,
}],
});
const hub = new gcp.networkconnectivity.Hub("hub", {});
const spoke = new gcp.networkconnectivity.Spoke("spoke", {
location: subnetwork.region,
hub: hub.id,
linkedRouterApplianceInstances: {
instances: [{
virtualMachine: instance.selfLink,
ipAddress: addrPeer.address,
}],
siteToSiteDataTransfer: false,
},
});
const router = new gcp.compute.Router("router", {
region: subnetwork.region,
network: network.selfLink,
bgp: {
asn: 64514,
},
});
const interfaceRedundant = new gcp.compute.RouterInterface("interfaceRedundant", {
region: router.region,
router: router.name,
subnetwork: subnetwork.selfLink,
privateIpAddress: addrIntfRedundant.address,
});
const _interface = new gcp.compute.RouterInterface("interface", {
region: router.region,
router: router.name,
subnetwork: subnetwork.selfLink,
privateIpAddress: addrIntf.address,
redundantInterface: interfaceRedundant.name,
});
const peer = new gcp.compute.RouterPeer("peer", {
router: router.name,
region: router.region,
"interface": _interface.name,
routerApplianceInstance: instance.selfLink,
peerAsn: 65513,
peerIpAddress: addrPeer.address,
});
resources:
network:
type: gcp:compute:Network
properties:
autoCreateSubnetworks: false
subnetwork:
type: gcp:compute:Subnetwork
properties:
network: ${network.selfLink}
ipCidrRange: 10.0.0.0/16
region: us-central1
addrIntf:
type: gcp:compute:Address
properties:
region: ${subnetwork.region}
subnetwork: ${subnetwork.id}
addressType: INTERNAL
addrIntfRedundant:
type: gcp:compute:Address
properties:
region: ${subnetwork.region}
subnetwork: ${subnetwork.id}
addressType: INTERNAL
addrPeer:
type: gcp:compute:Address
properties:
region: ${subnetwork.region}
subnetwork: ${subnetwork.id}
addressType: INTERNAL
instance:
type: gcp:compute:Instance
properties:
zone: us-central1-a
machineType: e2-medium
canIpForward: true
bootDisk:
initializeParams:
image: debian-cloud/debian-11
networkInterfaces:
- networkIp: ${addrPeer.address}
subnetwork: ${subnetwork.selfLink}
hub:
type: gcp:networkconnectivity:Hub
spoke:
type: gcp:networkconnectivity:Spoke
properties:
location: ${subnetwork.region}
hub: ${hub.id}
linkedRouterApplianceInstances:
instances:
- virtualMachine: ${instance.selfLink}
ipAddress: ${addrPeer.address}
siteToSiteDataTransfer: false
router:
type: gcp:compute:Router
properties:
region: ${subnetwork.region}
network: ${network.selfLink}
bgp:
asn: 64514
interfaceRedundant:
type: gcp:compute:RouterInterface
properties:
region: ${router.region}
router: ${router.name}
subnetwork: ${subnetwork.selfLink}
privateIpAddress: ${addrIntfRedundant.address}
interface:
type: gcp:compute:RouterInterface
properties:
region: ${router.region}
router: ${router.name}
subnetwork: ${subnetwork.selfLink}
privateIpAddress: ${addrIntf.address}
redundantInterface: ${interfaceRedundant.name}
peer:
type: gcp:compute:RouterPeer
properties:
router: ${router.name}
region: ${router.region}
interface: ${interface.name}
routerApplianceInstance: ${instance.selfLink}
peerAsn: 65513
peerIpAddress: ${addrPeer.address}
Create RouterPeer Resource
new RouterPeer(name: string, args: RouterPeerArgs, opts?: CustomResourceOptions);
@overload
def RouterPeer(resource_name: str,
opts: Optional[ResourceOptions] = None,
advertise_mode: Optional[str] = None,
advertised_groups: Optional[Sequence[str]] = None,
advertised_ip_ranges: Optional[Sequence[RouterPeerAdvertisedIpRangeArgs]] = None,
advertised_route_priority: Optional[int] = None,
bfd: Optional[RouterPeerBfdArgs] = None,
enable: Optional[bool] = None,
enable_ipv6: Optional[bool] = None,
interface: Optional[str] = None,
ip_address: Optional[str] = None,
ipv6_nexthop_address: Optional[str] = None,
name: Optional[str] = None,
peer_asn: Optional[int] = None,
peer_ip_address: Optional[str] = None,
peer_ipv6_nexthop_address: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
router: Optional[str] = None,
router_appliance_instance: Optional[str] = None)
@overload
def RouterPeer(resource_name: str,
args: RouterPeerArgs,
opts: Optional[ResourceOptions] = None)
func NewRouterPeer(ctx *Context, name string, args RouterPeerArgs, opts ...ResourceOption) (*RouterPeer, error)
public RouterPeer(string name, RouterPeerArgs args, CustomResourceOptions? opts = null)
public RouterPeer(String name, RouterPeerArgs args)
public RouterPeer(String name, RouterPeerArgs args, CustomResourceOptions options)
type: gcp:compute:RouterPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouterPeerArgs
- 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 RouterPeerArgs
- 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 RouterPeerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouterPeerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RouterPeerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
RouterPeer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The RouterPeer resource accepts the following input properties:
- Interface string
Name of the interface the BGP peer is associated with.
- Peer
Asn int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- Router string
The name of the Cloud Router in which this BgpPeer will be configured.
- Advertise
Mode string User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- Advertised
Groups List<string> User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- Advertised
Ip List<RouterRanges Peer Advertised Ip Range> User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- Advertised
Route intPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- Bfd
Router
Peer Bfd BFD configuration for the BGP peering. Structure is documented below.
- Enable bool
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- Enable
Ipv6 bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- Ip
Address string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- Ipv6Nexthop
Address string IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Name string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Peer
Ip stringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- Peer
Ipv6Nexthop stringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- Router
Appliance stringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- Interface string
Name of the interface the BGP peer is associated with.
- Peer
Asn int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- Router string
The name of the Cloud Router in which this BgpPeer will be configured.
- Advertise
Mode string User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- Advertised
Groups []string User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- Advertised
Ip []RouterRanges Peer Advertised Ip Range Args User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- Advertised
Route intPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- Bfd
Router
Peer Bfd Args BFD configuration for the BGP peering. Structure is documented below.
- Enable bool
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- Enable
Ipv6 bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- Ip
Address string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- Ipv6Nexthop
Address string IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Name string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Peer
Ip stringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- Peer
Ipv6Nexthop stringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- Router
Appliance stringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- interface_ String
Name of the interface the BGP peer is associated with.
- peer
Asn Integer Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- router String
The name of the Cloud Router in which this BgpPeer will be configured.
- advertise
Mode String User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised
Groups List<String> User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised
Ip List<RouterRanges Peer Advertised Ip Range> User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised
Route IntegerPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd
Router
Peer Bfd BFD configuration for the BGP peering. Structure is documented below.
- enable Boolean
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable
Ipv6 Boolean Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- ip
Address String IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6Nexthop
Address String IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- name String
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer
Ip StringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer
Ipv6Nexthop StringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router
Appliance StringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- interface string
Name of the interface the BGP peer is associated with.
- peer
Asn number Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- router string
The name of the Cloud Router in which this BgpPeer will be configured.
- advertise
Mode string User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised
Groups string[] User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised
Ip RouterRanges Peer Advertised Ip Range[] User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised
Route numberPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd
Router
Peer Bfd BFD configuration for the BGP peering. Structure is documented below.
- enable boolean
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable
Ipv6 boolean Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- ip
Address string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6Nexthop
Address string IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- name string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer
Ip stringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer
Ipv6Nexthop stringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router
Appliance stringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- interface str
Name of the interface the BGP peer is associated with.
- peer_
asn int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- router str
The name of the Cloud Router in which this BgpPeer will be configured.
- advertise_
mode str User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised_
groups Sequence[str] User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised_
ip_ Sequence[Routerranges Peer Advertised Ip Range Args] User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised_
route_ intpriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd
Router
Peer Bfd Args BFD configuration for the BGP peering. Structure is documented below.
- enable bool
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable_
ipv6 bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- ip_
address str IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6_
nexthop_ straddress IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- name str
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer_
ip_ straddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer_
ipv6_ strnexthop_ address IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router_
appliance_ strinstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- interface String
Name of the interface the BGP peer is associated with.
- peer
Asn Number Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- router String
The name of the Cloud Router in which this BgpPeer will be configured.
- advertise
Mode String User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised
Groups List<String> User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised
Ip List<Property Map>Ranges User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised
Route NumberPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd Property Map
BFD configuration for the BGP peering. Structure is documented below.
- enable Boolean
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable
Ipv6 Boolean Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- ip
Address String IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6Nexthop
Address String IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- name String
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer
Ip StringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer
Ipv6Nexthop StringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router
Appliance StringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
Outputs
All input properties are implicitly available as output properties. Additionally, the RouterPeer resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Management
Type string The resource that configures and manages this BGP peer.
- Id string
The provider-assigned unique ID for this managed resource.
- Management
Type string The resource that configures and manages this BGP peer.
- id String
The provider-assigned unique ID for this managed resource.
- management
Type String The resource that configures and manages this BGP peer.
- id string
The provider-assigned unique ID for this managed resource.
- management
Type string The resource that configures and manages this BGP peer.
- id str
The provider-assigned unique ID for this managed resource.
- management_
type str The resource that configures and manages this BGP peer.
- id String
The provider-assigned unique ID for this managed resource.
- management
Type String The resource that configures and manages this BGP peer.
Look up Existing RouterPeer Resource
Get an existing RouterPeer 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?: RouterPeerState, opts?: CustomResourceOptions): RouterPeer
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advertise_mode: Optional[str] = None,
advertised_groups: Optional[Sequence[str]] = None,
advertised_ip_ranges: Optional[Sequence[RouterPeerAdvertisedIpRangeArgs]] = None,
advertised_route_priority: Optional[int] = None,
bfd: Optional[RouterPeerBfdArgs] = None,
enable: Optional[bool] = None,
enable_ipv6: Optional[bool] = None,
interface: Optional[str] = None,
ip_address: Optional[str] = None,
ipv6_nexthop_address: Optional[str] = None,
management_type: Optional[str] = None,
name: Optional[str] = None,
peer_asn: Optional[int] = None,
peer_ip_address: Optional[str] = None,
peer_ipv6_nexthop_address: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
router: Optional[str] = None,
router_appliance_instance: Optional[str] = None) -> RouterPeer
func GetRouterPeer(ctx *Context, name string, id IDInput, state *RouterPeerState, opts ...ResourceOption) (*RouterPeer, error)
public static RouterPeer Get(string name, Input<string> id, RouterPeerState? state, CustomResourceOptions? opts = null)
public static RouterPeer get(String name, Output<String> id, RouterPeerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Advertise
Mode string User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- Advertised
Groups List<string> User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- Advertised
Ip List<RouterRanges Peer Advertised Ip Range> User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- Advertised
Route intPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- Bfd
Router
Peer Bfd BFD configuration for the BGP peering. Structure is documented below.
- Enable bool
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- Enable
Ipv6 bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- Interface string
Name of the interface the BGP peer is associated with.
- Ip
Address string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- Ipv6Nexthop
Address string IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Management
Type string The resource that configures and manages this BGP peer.
- Name string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Peer
Asn int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- Peer
Ip stringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- Peer
Ipv6Nexthop stringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- Router string
The name of the Cloud Router in which this BgpPeer will be configured.
- Router
Appliance stringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- Advertise
Mode string User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- Advertised
Groups []string User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- Advertised
Ip []RouterRanges Peer Advertised Ip Range Args User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- Advertised
Route intPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- Bfd
Router
Peer Bfd Args BFD configuration for the BGP peering. Structure is documented below.
- Enable bool
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- Enable
Ipv6 bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- Interface string
Name of the interface the BGP peer is associated with.
- Ip
Address string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- Ipv6Nexthop
Address string IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Management
Type string The resource that configures and manages this BGP peer.
- Name string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Peer
Asn int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- Peer
Ip stringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- Peer
Ipv6Nexthop stringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- Router string
The name of the Cloud Router in which this BgpPeer will be configured.
- Router
Appliance stringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- advertise
Mode String User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised
Groups List<String> User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised
Ip List<RouterRanges Peer Advertised Ip Range> User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised
Route IntegerPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd
Router
Peer Bfd BFD configuration for the BGP peering. Structure is documented below.
- enable Boolean
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable
Ipv6 Boolean Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- interface_ String
Name of the interface the BGP peer is associated with.
- ip
Address String IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6Nexthop
Address String IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- management
Type String The resource that configures and manages this BGP peer.
- name String
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer
Asn Integer Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- peer
Ip StringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer
Ipv6Nexthop StringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router String
The name of the Cloud Router in which this BgpPeer will be configured.
- router
Appliance StringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- advertise
Mode string User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised
Groups string[] User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised
Ip RouterRanges Peer Advertised Ip Range[] User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised
Route numberPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd
Router
Peer Bfd BFD configuration for the BGP peering. Structure is documented below.
- enable boolean
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable
Ipv6 boolean Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- interface string
Name of the interface the BGP peer is associated with.
- ip
Address string IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6Nexthop
Address string IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- management
Type string The resource that configures and manages this BGP peer.
- name string
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer
Asn number Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- peer
Ip stringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer
Ipv6Nexthop stringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router string
The name of the Cloud Router in which this BgpPeer will be configured.
- router
Appliance stringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- advertise_
mode str User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised_
groups Sequence[str] User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised_
ip_ Sequence[Routerranges Peer Advertised Ip Range Args] User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised_
route_ intpriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd
Router
Peer Bfd Args BFD configuration for the BGP peering. Structure is documented below.
- enable bool
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable_
ipv6 bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- interface str
Name of the interface the BGP peer is associated with.
- ip_
address str IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6_
nexthop_ straddress IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- management_
type str The resource that configures and manages this BGP peer.
- name str
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer_
asn int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- peer_
ip_ straddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer_
ipv6_ strnexthop_ address IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router str
The name of the Cloud Router in which this BgpPeer will be configured.
- router_
appliance_ strinstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
- advertise
Mode String User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are:
DEFAULT
,CUSTOM
Default value isDEFAULT
. Possible values are:DEFAULT
,CUSTOM
.- advertised
Groups List<String> User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
- advertised
Ip List<Property Map>Ranges User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is
CUSTOM
and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.- advertised
Route NumberPriority The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.
- bfd Property Map
BFD configuration for the BGP peering. Structure is documented below.
- enable Boolean
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
- enable
Ipv6 Boolean Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
- interface String
Name of the interface the BGP peer is associated with.
- ip
Address String IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
- ipv6Nexthop
Address String IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- management
Type String The resource that configures and manages this BGP peer.
- name String
Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- peer
Asn Number Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
- peer
Ip StringAddress IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if
ip_address
is set.- peer
Ipv6Nexthop StringAddress IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
- router String
The name of the Cloud Router in which this BgpPeer will be configured.
- router
Appliance StringInstance The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
Supporting Types
RouterPeerAdvertisedIpRange, RouterPeerAdvertisedIpRangeArgs
- Range string
The IP range to advertise. The value must be a CIDR-formatted string.
- Description string
User-specified description for the IP range.
- Range string
The IP range to advertise. The value must be a CIDR-formatted string.
- Description string
User-specified description for the IP range.
- range String
The IP range to advertise. The value must be a CIDR-formatted string.
- description String
User-specified description for the IP range.
- range string
The IP range to advertise. The value must be a CIDR-formatted string.
- description string
User-specified description for the IP range.
- range str
The IP range to advertise. The value must be a CIDR-formatted string.
- description str
User-specified description for the IP range.
- range String
The IP range to advertise. The value must be a CIDR-formatted string.
- description String
User-specified description for the IP range.
RouterPeerBfd, RouterPeerBfdArgs
- Session
Initialization stringMode The BFD session initialization mode for this BGP peer. If set to
ACTIVE
, the Cloud Router will initiate the BFD session for this BGP peer. If set toPASSIVE
, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set toDISABLED
, BFD is disabled for this BGP peer. Possible values are:ACTIVE
,DISABLED
,PASSIVE
.- Min
Receive intInterval The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000.
- Min
Transmit intInterval The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000.
- Multiplier int
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16.
- Session
Initialization stringMode The BFD session initialization mode for this BGP peer. If set to
ACTIVE
, the Cloud Router will initiate the BFD session for this BGP peer. If set toPASSIVE
, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set toDISABLED
, BFD is disabled for this BGP peer. Possible values are:ACTIVE
,DISABLED
,PASSIVE
.- Min
Receive intInterval The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000.
- Min
Transmit intInterval The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000.
- Multiplier int
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16.
- session
Initialization StringMode The BFD session initialization mode for this BGP peer. If set to
ACTIVE
, the Cloud Router will initiate the BFD session for this BGP peer. If set toPASSIVE
, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set toDISABLED
, BFD is disabled for this BGP peer. Possible values are:ACTIVE
,DISABLED
,PASSIVE
.- min
Receive IntegerInterval The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000.
- min
Transmit IntegerInterval The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000.
- multiplier Integer
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16.
- session
Initialization stringMode The BFD session initialization mode for this BGP peer. If set to
ACTIVE
, the Cloud Router will initiate the BFD session for this BGP peer. If set toPASSIVE
, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set toDISABLED
, BFD is disabled for this BGP peer. Possible values are:ACTIVE
,DISABLED
,PASSIVE
.- min
Receive numberInterval The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000.
- min
Transmit numberInterval The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000.
- multiplier number
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16.
- session_
initialization_ strmode The BFD session initialization mode for this BGP peer. If set to
ACTIVE
, the Cloud Router will initiate the BFD session for this BGP peer. If set toPASSIVE
, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set toDISABLED
, BFD is disabled for this BGP peer. Possible values are:ACTIVE
,DISABLED
,PASSIVE
.- min_
receive_ intinterval The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000.
- min_
transmit_ intinterval The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000.
- multiplier int
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16.
- session
Initialization StringMode The BFD session initialization mode for this BGP peer. If set to
ACTIVE
, the Cloud Router will initiate the BFD session for this BGP peer. If set toPASSIVE
, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set toDISABLED
, BFD is disabled for this BGP peer. Possible values are:ACTIVE
,DISABLED
,PASSIVE
.- min
Receive NumberInterval The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000.
- min
Transmit NumberInterval The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000.
- multiplier Number
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16.
Import
RouterBgpPeer can be imported using any of these accepted formats* projects/{{project}}/regions/{{region}}/routers/{{router}}/{{name}}
* {{project}}/{{region}}/{{router}}/{{name}}
* {{region}}/{{router}}/{{name}}
* {{router}}/{{name}}
In Terraform v1.5.0 and later, use an import
block to import RouterBgpPeer using one of the formats above. For exampletf import {
id = “projects/{{project}}/regions/{{region}}/routers/{{router}}/{{name}}”
to = google_compute_router_peer.default }
$ pulumi import gcp:compute/routerPeer:RouterPeer When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), RouterBgpPeer can be imported using one of the formats above. For example
$ pulumi import gcp:compute/routerPeer:RouterPeer default projects/{{project}}/regions/{{region}}/routers/{{router}}/{{name}}
$ pulumi import gcp:compute/routerPeer:RouterPeer default {{project}}/{{region}}/{{router}}/{{name}}
$ pulumi import gcp:compute/routerPeer:RouterPeer default {{region}}/{{router}}/{{name}}
$ pulumi import gcp:compute/routerPeer:RouterPeer default {{router}}/{{name}}
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.