published on Thursday, Jun 11, 2026 by Volcengine
published on Thursday, Jun 11, 2026 by Volcengine
BGP neighbor
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const directConnectBgpPeerDemo = new volcenginecc.directconnect.BgpPeer("DirectConnectBgpPeerDemo", {
authKey: "QWExxxxx",
bgpPeerName: "ccapi-test",
description: "test",
ipVersion: "IPv4",
remoteAsn: 4294960000,
virtualInterfaceId: "dcv-33cjs5xxxxxxxxx",
});
import pulumi
import pulumi_volcenginecc as volcenginecc
direct_connect_bgp_peer_demo = volcenginecc.directconnect.BgpPeer("DirectConnectBgpPeerDemo",
auth_key="QWExxxxx",
bgp_peer_name="ccapi-test",
description="test",
ip_version="IPv4",
remote_asn=4294960000,
virtual_interface_id="dcv-33cjs5xxxxxxxxx")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/directconnect"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := directconnect.NewBgpPeer(ctx, "DirectConnectBgpPeerDemo", &directconnect.BgpPeerArgs{
AuthKey: pulumi.String("QWExxxxx"),
BgpPeerName: pulumi.String("ccapi-test"),
Description: pulumi.String("test"),
IpVersion: pulumi.String("IPv4"),
RemoteAsn: pulumi.Int(4294960000),
VirtualInterfaceId: pulumi.String("dcv-33cjs5xxxxxxxxx"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var directConnectBgpPeerDemo = new Volcenginecc.Directconnect.BgpPeer("DirectConnectBgpPeerDemo", new()
{
AuthKey = "QWExxxxx",
BgpPeerName = "ccapi-test",
Description = "test",
IpVersion = "IPv4",
RemoteAsn = 4294960000,
VirtualInterfaceId = "dcv-33cjs5xxxxxxxxx",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.directconnect.BgpPeer;
import com.volcengine.volcenginecc.directconnect.BgpPeerArgs;
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 directConnectBgpPeerDemo = new BgpPeer("directConnectBgpPeerDemo", BgpPeerArgs.builder()
.authKey("QWExxxxx")
.bgpPeerName("ccapi-test")
.description("test")
.ipVersion("IPv4")
.remoteAsn(4294960000)
.virtualInterfaceId("dcv-33cjs5xxxxxxxxx")
.build());
}
}
resources:
directConnectBgpPeerDemo:
type: volcenginecc:directconnect:BgpPeer
name: DirectConnectBgpPeerDemo
properties:
authKey: QWExxxxx
bgpPeerName: ccapi-test
description: test
ipVersion: IPv4
remoteAsn: 4.29496e+09
virtualInterfaceId: dcv-33cjs5xxxxxxxxx
Example coming soon!
Create BgpPeer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BgpPeer(name: string, args: BgpPeerArgs, opts?: CustomResourceOptions);@overload
def BgpPeer(resource_name: str,
args: BgpPeerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BgpPeer(resource_name: str,
opts: Optional[ResourceOptions] = None,
remote_asn: Optional[int] = None,
virtual_interface_id: Optional[str] = None,
auth_key: Optional[str] = None,
bgp_peer_name: Optional[str] = None,
description: Optional[str] = None,
ip_version: Optional[str] = None)func NewBgpPeer(ctx *Context, name string, args BgpPeerArgs, opts ...ResourceOption) (*BgpPeer, error)public BgpPeer(string name, BgpPeerArgs args, CustomResourceOptions? opts = null)
public BgpPeer(String name, BgpPeerArgs args)
public BgpPeer(String name, BgpPeerArgs args, CustomResourceOptions options)
type: volcenginecc:directconnect:BgpPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "volcenginecc_directconnect_bgppeer" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args BgpPeerArgs
- 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 BgpPeerArgs
- 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 BgpPeerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BgpPeerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BgpPeerArgs
- 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 bgpPeerResource = new Volcenginecc.Directconnect.BgpPeer("bgpPeerResource", new()
{
RemoteAsn = 0,
VirtualInterfaceId = "string",
AuthKey = "string",
BgpPeerName = "string",
Description = "string",
IpVersion = "string",
});
example, err := directconnect.NewBgpPeer(ctx, "bgpPeerResource", &directconnect.BgpPeerArgs{
RemoteAsn: pulumi.Int(0),
VirtualInterfaceId: pulumi.String("string"),
AuthKey: pulumi.String("string"),
BgpPeerName: pulumi.String("string"),
Description: pulumi.String("string"),
IpVersion: pulumi.String("string"),
})
resource "volcenginecc_directconnect_bgppeer" "bgpPeerResource" {
remote_asn = 0
virtual_interface_id = "string"
auth_key = "string"
bgp_peer_name = "string"
description = "string"
ip_version = "string"
}
var bgpPeerResource = new BgpPeer("bgpPeerResource", BgpPeerArgs.builder()
.remoteAsn(0)
.virtualInterfaceId("string")
.authKey("string")
.bgpPeerName("string")
.description("string")
.ipVersion("string")
.build());
bgp_peer_resource = volcenginecc.directconnect.BgpPeer("bgpPeerResource",
remote_asn=0,
virtual_interface_id="string",
auth_key="string",
bgp_peer_name="string",
description="string",
ip_version="string")
const bgpPeerResource = new volcenginecc.directconnect.BgpPeer("bgpPeerResource", {
remoteAsn: 0,
virtualInterfaceId: "string",
authKey: "string",
bgpPeerName: "string",
description: "string",
ipVersion: "string",
});
type: volcenginecc:directconnect:BgpPeer
properties:
authKey: string
bgpPeerName: string
description: string
ipVersion: string
remoteAsn: 0
virtualInterfaceId: string
BgpPeer 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 BgpPeer resource accepts the following input properties:
- Remote
Asn int - Peer ASN of the BGP neighbor.
- Virtual
Interface stringId - ID of the virtual interface where the BGP neighbor is located.
- Auth
Key string - Authentication key of the BGP neighbor.
- Bgp
Peer stringName - Name of the BGP neighbor.
- Description string
- Description of the BGP neighbor.
- Ip
Version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- Remote
Asn int - Peer ASN of the BGP neighbor.
- Virtual
Interface stringId - ID of the virtual interface where the BGP neighbor is located.
- Auth
Key string - Authentication key of the BGP neighbor.
- Bgp
Peer stringName - Name of the BGP neighbor.
- Description string
- Description of the BGP neighbor.
- Ip
Version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- remote_
asn number - Peer ASN of the BGP neighbor.
- virtual_
interface_ stringid - ID of the virtual interface where the BGP neighbor is located.
- auth_
key string - Authentication key of the BGP neighbor.
- bgp_
peer_ stringname - Name of the BGP neighbor.
- description string
- Description of the BGP neighbor.
- ip_
version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- remote
Asn Integer - Peer ASN of the BGP neighbor.
- virtual
Interface StringId - ID of the virtual interface where the BGP neighbor is located.
- auth
Key String - Authentication key of the BGP neighbor.
- bgp
Peer StringName - Name of the BGP neighbor.
- description String
- Description of the BGP neighbor.
- ip
Version String - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- remote
Asn number - Peer ASN of the BGP neighbor.
- virtual
Interface stringId - ID of the virtual interface where the BGP neighbor is located.
- auth
Key string - Authentication key of the BGP neighbor.
- bgp
Peer stringName - Name of the BGP neighbor.
- description string
- Description of the BGP neighbor.
- ip
Version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- remote_
asn int - Peer ASN of the BGP neighbor.
- virtual_
interface_ strid - ID of the virtual interface where the BGP neighbor is located.
- auth_
key str - Authentication key of the BGP neighbor.
- bgp_
peer_ strname - Name of the BGP neighbor.
- description str
- Description of the BGP neighbor.
- ip_
version str - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- remote
Asn Number - Peer ASN of the BGP neighbor.
- virtual
Interface StringId - ID of the virtual interface where the BGP neighbor is located.
- auth
Key String - Authentication key of the BGP neighbor.
- bgp
Peer StringName - Name of the BGP neighbor.
- description String
- Description of the BGP neighbor.
- ip
Version String - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
Outputs
All input properties are implicitly available as output properties. Additionally, the BgpPeer resource produces the following output properties:
- Account
Id string - ID of the account to which the BGP neighbor belongs.
- Bgp
Peer stringId - ID of the BGP neighbor.
- Creation
Time string - Time when the BGP neighbor was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Local
Asn int - ASN of the Volcano side.
- Session
Status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- Status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- Update
Time string - Time when the BGP neighbor was updated.
- Account
Id string - ID of the account to which the BGP neighbor belongs.
- Bgp
Peer stringId - ID of the BGP neighbor.
- Creation
Time string - Time when the BGP neighbor was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Local
Asn int - ASN of the Volcano side.
- Session
Status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- Status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- Update
Time string - Time when the BGP neighbor was updated.
- account_
id string - ID of the account to which the BGP neighbor belongs.
- bgp_
peer_ stringid - ID of the BGP neighbor.
- creation_
time string - Time when the BGP neighbor was created.
- id string
- The provider-assigned unique ID for this managed resource.
- local_
asn number - ASN of the Volcano side.
- session_
status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update_
time string - Time when the BGP neighbor was updated.
- account
Id String - ID of the account to which the BGP neighbor belongs.
- bgp
Peer StringId - ID of the BGP neighbor.
- creation
Time String - Time when the BGP neighbor was created.
- id String
- The provider-assigned unique ID for this managed resource.
- local
Asn Integer - ASN of the Volcano side.
- session
Status String - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status String
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update
Time String - Time when the BGP neighbor was updated.
- account
Id string - ID of the account to which the BGP neighbor belongs.
- bgp
Peer stringId - ID of the BGP neighbor.
- creation
Time string - Time when the BGP neighbor was created.
- id string
- The provider-assigned unique ID for this managed resource.
- local
Asn number - ASN of the Volcano side.
- session
Status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update
Time string - Time when the BGP neighbor was updated.
- account_
id str - ID of the account to which the BGP neighbor belongs.
- bgp_
peer_ strid - ID of the BGP neighbor.
- creation_
time str - Time when the BGP neighbor was created.
- id str
- The provider-assigned unique ID for this managed resource.
- local_
asn int - ASN of the Volcano side.
- session_
status str - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status str
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update_
time str - Time when the BGP neighbor was updated.
- account
Id String - ID of the account to which the BGP neighbor belongs.
- bgp
Peer StringId - ID of the BGP neighbor.
- creation
Time String - Time when the BGP neighbor was created.
- id String
- The provider-assigned unique ID for this managed resource.
- local
Asn Number - ASN of the Volcano side.
- session
Status String - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status String
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update
Time String - Time when the BGP neighbor was updated.
Look up Existing BgpPeer Resource
Get an existing BgpPeer 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?: BgpPeerState, opts?: CustomResourceOptions): BgpPeer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
auth_key: Optional[str] = None,
bgp_peer_id: Optional[str] = None,
bgp_peer_name: Optional[str] = None,
creation_time: Optional[str] = None,
description: Optional[str] = None,
ip_version: Optional[str] = None,
local_asn: Optional[int] = None,
remote_asn: Optional[int] = None,
session_status: Optional[str] = None,
status: Optional[str] = None,
update_time: Optional[str] = None,
virtual_interface_id: Optional[str] = None) -> BgpPeerfunc GetBgpPeer(ctx *Context, name string, id IDInput, state *BgpPeerState, opts ...ResourceOption) (*BgpPeer, error)public static BgpPeer Get(string name, Input<string> id, BgpPeerState? state, CustomResourceOptions? opts = null)public static BgpPeer get(String name, Output<String> id, BgpPeerState state, CustomResourceOptions options)resources: _: type: volcenginecc:directconnect:BgpPeer get: id: ${id}import {
to = volcenginecc_directconnect_bgppeer.example
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.
- Account
Id string - ID of the account to which the BGP neighbor belongs.
- Auth
Key string - Authentication key of the BGP neighbor.
- Bgp
Peer stringId - ID of the BGP neighbor.
- Bgp
Peer stringName - Name of the BGP neighbor.
- Creation
Time string - Time when the BGP neighbor was created.
- Description string
- Description of the BGP neighbor.
- Ip
Version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- Local
Asn int - ASN of the Volcano side.
- Remote
Asn int - Peer ASN of the BGP neighbor.
- Session
Status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- Status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- Update
Time string - Time when the BGP neighbor was updated.
- Virtual
Interface stringId - ID of the virtual interface where the BGP neighbor is located.
- Account
Id string - ID of the account to which the BGP neighbor belongs.
- Auth
Key string - Authentication key of the BGP neighbor.
- Bgp
Peer stringId - ID of the BGP neighbor.
- Bgp
Peer stringName - Name of the BGP neighbor.
- Creation
Time string - Time when the BGP neighbor was created.
- Description string
- Description of the BGP neighbor.
- Ip
Version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- Local
Asn int - ASN of the Volcano side.
- Remote
Asn int - Peer ASN of the BGP neighbor.
- Session
Status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- Status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- Update
Time string - Time when the BGP neighbor was updated.
- Virtual
Interface stringId - ID of the virtual interface where the BGP neighbor is located.
- account_
id string - ID of the account to which the BGP neighbor belongs.
- auth_
key string - Authentication key of the BGP neighbor.
- bgp_
peer_ stringid - ID of the BGP neighbor.
- bgp_
peer_ stringname - Name of the BGP neighbor.
- creation_
time string - Time when the BGP neighbor was created.
- description string
- Description of the BGP neighbor.
- ip_
version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- local_
asn number - ASN of the Volcano side.
- remote_
asn number - Peer ASN of the BGP neighbor.
- session_
status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update_
time string - Time when the BGP neighbor was updated.
- virtual_
interface_ stringid - ID of the virtual interface where the BGP neighbor is located.
- account
Id String - ID of the account to which the BGP neighbor belongs.
- auth
Key String - Authentication key of the BGP neighbor.
- bgp
Peer StringId - ID of the BGP neighbor.
- bgp
Peer StringName - Name of the BGP neighbor.
- creation
Time String - Time when the BGP neighbor was created.
- description String
- Description of the BGP neighbor.
- ip
Version String - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- local
Asn Integer - ASN of the Volcano side.
- remote
Asn Integer - Peer ASN of the BGP neighbor.
- session
Status String - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status String
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update
Time String - Time when the BGP neighbor was updated.
- virtual
Interface StringId - ID of the virtual interface where the BGP neighbor is located.
- account
Id string - ID of the account to which the BGP neighbor belongs.
- auth
Key string - Authentication key of the BGP neighbor.
- bgp
Peer stringId - ID of the BGP neighbor.
- bgp
Peer stringName - Name of the BGP neighbor.
- creation
Time string - Time when the BGP neighbor was created.
- description string
- Description of the BGP neighbor.
- ip
Version string - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- local
Asn number - ASN of the Volcano side.
- remote
Asn number - Peer ASN of the BGP neighbor.
- session
Status string - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status string
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update
Time string - Time when the BGP neighbor was updated.
- virtual
Interface stringId - ID of the virtual interface where the BGP neighbor is located.
- account_
id str - ID of the account to which the BGP neighbor belongs.
- auth_
key str - Authentication key of the BGP neighbor.
- bgp_
peer_ strid - ID of the BGP neighbor.
- bgp_
peer_ strname - Name of the BGP neighbor.
- creation_
time str - Time when the BGP neighbor was created.
- description str
- Description of the BGP neighbor.
- ip_
version str - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- local_
asn int - ASN of the Volcano side.
- remote_
asn int - Peer ASN of the BGP neighbor.
- session_
status str - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status str
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update_
time str - Time when the BGP neighbor was updated.
- virtual_
interface_ strid - ID of the virtual interface where the BGP neighbor is located.
- account
Id String - ID of the account to which the BGP neighbor belongs.
- auth
Key String - Authentication key of the BGP neighbor.
- bgp
Peer StringId - ID of the BGP neighbor.
- bgp
Peer StringName - Name of the BGP neighbor.
- creation
Time String - Time when the BGP neighbor was created.
- description String
- Description of the BGP neighbor.
- ip
Version String - IP type of the BGP neighbor. IPv4 indicates IPv4 type, IPv6 indicates IPv6 type.
- local
Asn Number - ASN of the Volcano side.
- remote
Asn Number - Peer ASN of the BGP neighbor.
- session
Status String - Session status of the BGP neighbor. Up indicates normal, Down indicates not operational.
- status String
- Status of the BGP neighbor. Creating means the neighbor is being created, Deleting means it is being deleted, Pending means it is being configured, Available means it is available.
- update
Time String - Time when the BGP neighbor was updated.
- virtual
Interface StringId - ID of the virtual interface where the BGP neighbor is located.
Import
$ pulumi import volcenginecc:directconnect/bgpPeer:BgpPeer example "bgp_peer_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Jun 11, 2026 by Volcengine