Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. BgpNetwork
Alibaba Cloud v3.77.0 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.vpc.BgpNetwork

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.77.0 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a VPC Bgp Network resource.

    For information about VPC Bgp Network and how to use it, see What is Bgp Network.

    NOTE: Available since v1.153.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";

const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const example = alicloud.expressconnect.getPhysicalConnections({
    nameRegex: "^preserved-NODELETING",
});
const vlanId = new random.index.Integer("vlan_id", {
    max: 2999,
    min: 1,
});
const exampleVirtualBorderRouter = new alicloud.expressconnect.VirtualBorderRouter("example", {
    localGatewayIp: "10.0.0.1",
    peerGatewayIp: "10.0.0.2",
    peeringSubnetMask: "255.255.255.252",
    physicalConnectionId: example.then(example => example.connections?.[0]?.id),
    virtualBorderRouterName: name,
    vlanId: vlanId.id,
    minRxInterval: 1000,
    minTxInterval: 1000,
    detectMultiplier: 10,
});
const exampleBgpNetwork = new alicloud.vpc.BgpNetwork("example", {
    dstCidrBlock: "192.168.0.0/24",
    routerId: exampleVirtualBorderRouter.id,
});

    import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-example"
example = alicloud.expressconnect.get_physical_connections(name_regex="^preserved-NODELETING")
vlan_id = random.index.Integer("vlan_id",
    max=2999,
    min=1)
example_virtual_border_router = alicloud.expressconnect.VirtualBorderRouter("example",
    local_gateway_ip="10.0.0.1",
    peer_gateway_ip="10.0.0.2",
    peering_subnet_mask="255.255.255.252",
    physical_connection_id=example.connections[0].id,
    virtual_border_router_name=name,
    vlan_id=vlan_id["id"],
    min_rx_interval=1000,
    min_tx_interval=1000,
    detect_multiplier=10)
example_bgp_network = alicloud.vpc.BgpNetwork("example",
    dst_cidr_block="192.168.0.0/24",
    router_id=example_virtual_border_router.id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/expressconnect"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		example, err := expressconnect.GetPhysicalConnections(ctx, &expressconnect.GetPhysicalConnectionsArgs{
			NameRegex: pulumi.StringRef("^preserved-NODELETING"),
		}, nil)
		if err != nil {
			return err
		}
		vlanId, err := random.NewInteger(ctx, "vlan_id", &random.IntegerArgs{
			Max: 2999,
			Min: 1,
		})
		if err != nil {
			return err
		}
		exampleVirtualBorderRouter, err := expressconnect.NewVirtualBorderRouter(ctx, "example", &expressconnect.VirtualBorderRouterArgs{
			LocalGatewayIp:          pulumi.String("10.0.0.1"),
			PeerGatewayIp:           pulumi.String("10.0.0.2"),
			PeeringSubnetMask:       pulumi.String("255.255.255.252"),
			PhysicalConnectionId:    pulumi.String(example.Connections[0].Id),
			VirtualBorderRouterName: pulumi.String(name),
			VlanId:                  vlanId.Id,
			MinRxInterval:           pulumi.Int(1000),
			MinTxInterval:           pulumi.Int(1000),
			DetectMultiplier:        pulumi.Int(10),
		})
		if err != nil {
			return err
		}
		_, err = vpc.NewBgpNetwork(ctx, "example", &vpc.BgpNetworkArgs{
			DstCidrBlock: pulumi.String("192.168.0.0/24"),
			RouterId:     exampleVirtualBorderRouter.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf-example";
    var example = AliCloud.ExpressConnect.GetPhysicalConnections.Invoke(new()
    {
        NameRegex = "^preserved-NODELETING",
    });

    var vlanId = new Random.Index.Integer("vlan_id", new()
    {
        Max = 2999,
        Min = 1,
    });

    var exampleVirtualBorderRouter = new AliCloud.ExpressConnect.VirtualBorderRouter("example", new()
    {
        LocalGatewayIp = "10.0.0.1",
        PeerGatewayIp = "10.0.0.2",
        PeeringSubnetMask = "255.255.255.252",
        PhysicalConnectionId = example.Apply(getPhysicalConnectionsResult => getPhysicalConnectionsResult.Connections[0]?.Id),
        VirtualBorderRouterName = name,
        VlanId = vlanId.Id,
        MinRxInterval = 1000,
        MinTxInterval = 1000,
        DetectMultiplier = 10,
    });

    var exampleBgpNetwork = new AliCloud.Vpc.BgpNetwork("example", new()
    {
        DstCidrBlock = "192.168.0.0/24",
        RouterId = exampleVirtualBorderRouter.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.expressconnect.ExpressconnectFunctions;
import com.pulumi.alicloud.expressconnect.inputs.GetPhysicalConnectionsArgs;
import com.pulumi.random.integer;
import com.pulumi.random.integerArgs;
import com.pulumi.alicloud.expressconnect.VirtualBorderRouter;
import com.pulumi.alicloud.expressconnect.VirtualBorderRouterArgs;
import com.pulumi.alicloud.vpc.BgpNetwork;
import com.pulumi.alicloud.vpc.BgpNetworkArgs;
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) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("tf-example");
        final var example = ExpressconnectFunctions.getPhysicalConnections(GetPhysicalConnectionsArgs.builder()
            .nameRegex("^preserved-NODELETING")
            .build());

        var vlanId = new Integer("vlanId", IntegerArgs.builder()
            .max(2999)
            .min(1)
            .build());

        var exampleVirtualBorderRouter = new VirtualBorderRouter("exampleVirtualBorderRouter", VirtualBorderRouterArgs.builder()
            .localGatewayIp("10.0.0.1")
            .peerGatewayIp("10.0.0.2")
            .peeringSubnetMask("255.255.255.252")
            .physicalConnectionId(example.connections()[0].id())
            .virtualBorderRouterName(name)
            .vlanId(vlanId.id())
            .minRxInterval(1000)
            .minTxInterval(1000)
            .detectMultiplier(10)
            .build());

        var exampleBgpNetwork = new BgpNetwork("exampleBgpNetwork", BgpNetworkArgs.builder()
            .dstCidrBlock("192.168.0.0/24")
            .routerId(exampleVirtualBorderRouter.id())
            .build());

    }
}

    configuration:
  name:
    type: string
    default: tf-example
resources:
  vlanId:
    type: random:integer
    name: vlan_id
    properties:
      max: 2999
      min: 1
  exampleVirtualBorderRouter:
    type: alicloud:expressconnect:VirtualBorderRouter
    name: example
    properties:
      localGatewayIp: 10.0.0.1
      peerGatewayIp: 10.0.0.2
      peeringSubnetMask: 255.255.255.252
      physicalConnectionId: ${example.connections[0].id}
      virtualBorderRouterName: ${name}
      vlanId: ${vlanId.id}
      minRxInterval: 1000
      minTxInterval: 1000
      detectMultiplier: 10
  exampleBgpNetwork:
    type: alicloud:vpc:BgpNetwork
    name: example
    properties:
      dstCidrBlock: 192.168.0.0/24
      routerId: ${exampleVirtualBorderRouter.id}
variables:
  example:
    fn::invoke:
      function: alicloud:expressconnect:getPhysicalConnections
      arguments:
        nameRegex: ^preserved-NODELETING

    Create BgpNetwork Resource

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

    Constructor syntax

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

@overload
def BgpNetwork(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               dst_cidr_block: Optional[str] = None,
               router_id: Optional[str] = None)
    func NewBgpNetwork(ctx *Context, name string, args BgpNetworkArgs, opts ...ResourceOption) (*BgpNetwork, error)
    public BgpNetwork(string name, BgpNetworkArgs args, CustomResourceOptions? opts = null)
    public BgpNetwork(String name, BgpNetworkArgs args)
public BgpNetwork(String name, BgpNetworkArgs args, CustomResourceOptions options)

    type: alicloud:vpc:BgpNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BgpNetworkArgs
    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 BgpNetworkArgs
    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 BgpNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BgpNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BgpNetworkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var bgpNetworkResource = new AliCloud.Vpc.BgpNetwork("bgpNetworkResource", new()
{
    DstCidrBlock = "string",
    RouterId = "string",
});

    example, err := vpc.NewBgpNetwork(ctx, "bgpNetworkResource", &vpc.BgpNetworkArgs{
	DstCidrBlock: pulumi.String("string"),
	RouterId:     pulumi.String("string"),
})

    var bgpNetworkResource = new BgpNetwork("bgpNetworkResource", BgpNetworkArgs.builder()
    .dstCidrBlock("string")
    .routerId("string")
    .build());

    bgp_network_resource = alicloud.vpc.BgpNetwork("bgpNetworkResource",
    dst_cidr_block="string",
    router_id="string")

    const bgpNetworkResource = new alicloud.vpc.BgpNetwork("bgpNetworkResource", {
    dstCidrBlock: "string",
    routerId: "string",
});

    type: alicloud:vpc:BgpNetwork
properties:
    dstCidrBlock: string
    routerId: string

    BgpNetwork Resource Properties

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

    Inputs

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

    The BgpNetwork resource accepts the following input properties:

    DstCidrBlock string
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    RouterId string
    The ID of the vRouter associated with the router interface.
    DstCidrBlock string
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    RouterId string
    The ID of the vRouter associated with the router interface.
    dstCidrBlock String
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    routerId String
    The ID of the vRouter associated with the router interface.
    dstCidrBlock string
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    routerId string
    The ID of the vRouter associated with the router interface.
    dst_cidr_block str
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    router_id str
    The ID of the vRouter associated with the router interface.
    dstCidrBlock String
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    routerId String
    The ID of the vRouter associated with the router interface.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The state of the advertised BGP network.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The state of the advertised BGP network.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The state of the advertised BGP network.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The state of the advertised BGP network.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The state of the advertised BGP network.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The state of the advertised BGP network.

    Look up Existing BgpNetwork Resource

    Get an existing BgpNetwork 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?: BgpNetworkState, opts?: CustomResourceOptions): BgpNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dst_cidr_block: Optional[str] = None,
        router_id: Optional[str] = None,
        status: Optional[str] = None) -> BgpNetwork
    func GetBgpNetwork(ctx *Context, name string, id IDInput, state *BgpNetworkState, opts ...ResourceOption) (*BgpNetwork, error)
    public static BgpNetwork Get(string name, Input<string> id, BgpNetworkState? state, CustomResourceOptions? opts = null)
    public static BgpNetwork get(String name, Output<String> id, BgpNetworkState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:vpc:BgpNetwork    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DstCidrBlock string
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    RouterId string
    The ID of the vRouter associated with the router interface.
    Status string
    The state of the advertised BGP network.
    DstCidrBlock string
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    RouterId string
    The ID of the vRouter associated with the router interface.
    Status string
    The state of the advertised BGP network.
    dstCidrBlock String
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    routerId String
    The ID of the vRouter associated with the router interface.
    status String
    The state of the advertised BGP network.
    dstCidrBlock string
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    routerId string
    The ID of the vRouter associated with the router interface.
    status string
    The state of the advertised BGP network.
    dst_cidr_block str
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    router_id str
    The ID of the vRouter associated with the router interface.
    status str
    The state of the advertised BGP network.
    dstCidrBlock String
    The CIDR block of the virtual private cloud (VPC) or vSwitch that you want to connect to a data center.
    routerId String
    The ID of the vRouter associated with the router interface.
    status String
    The state of the advertised BGP network.

    Import

    VPC Bgp Network can be imported using the id, e.g.

    $ pulumi import alicloud:vpc/bgpNetwork:BgpNetwork example <router_id>:<dst_cidr_block>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.77.0 published on Friday, May 2, 2025 by Pulumi
    pulumi/pulumi-alicloud