1. Packages
  2. Volcengine
  3. API Docs
  4. direct_connect
  5. BgpPeers
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.direct_connect.BgpPeers

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

Use this data source to query detailed information of direct connect bgp peers

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.direct_connect.BgpPeers({
    ids: ["bgp-171w6pn39ruo04d1w33iq****"],
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.direct_connect.bgp_peers(ids=["bgp-171w6pn39ruo04d1w33iq****"])
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/direct_connect"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := direct_connect.BgpPeers(ctx, &direct_connect.BgpPeersArgs{
			Ids: []string{
				"bgp-171w6pn39ruo04d1w33iq****",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Direct_connect.BgpPeers.Invoke(new()
    {
        Ids = new[]
        {
            "bgp-171w6pn39ruo04d1w33iq****",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.direct_connect.Direct_connectFunctions;
import com.pulumi.volcengine.direct_connect.inputs.BgpPeersArgs;
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 foo = Direct_connectFunctions.BgpPeers(BgpPeersArgs.builder()
            .ids("bgp-171w6pn39ruo04d1w33iq****")
            .build());

    }
}
Copy
variables:
  foo:
    fn::invoke:
      Function: volcengine:direct_connect:BgpPeers
      Arguments:
        ids:
          - bgp-171w6pn39ruo04d1w33iq****
Copy

Using BgpPeers

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function bgpPeers(args: BgpPeersArgs, opts?: InvokeOptions): Promise<BgpPeersResult>
function bgpPeersOutput(args: BgpPeersOutputArgs, opts?: InvokeOptions): Output<BgpPeersResult>
Copy
def bgp_peers(bgp_peer_name: Optional[str] = None,
              direct_connect_gateway_id: Optional[str] = None,
              ids: Optional[Sequence[str]] = None,
              name_regex: Optional[str] = None,
              output_file: Optional[str] = None,
              remote_asn: Optional[int] = None,
              virtual_interface_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> BgpPeersResult
def bgp_peers_output(bgp_peer_name: Optional[pulumi.Input[str]] = None,
              direct_connect_gateway_id: Optional[pulumi.Input[str]] = None,
              ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              remote_asn: Optional[pulumi.Input[int]] = None,
              virtual_interface_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[BgpPeersResult]
Copy
func BgpPeers(ctx *Context, args *BgpPeersArgs, opts ...InvokeOption) (*BgpPeersResult, error)
func BgpPeersOutput(ctx *Context, args *BgpPeersOutputArgs, opts ...InvokeOption) BgpPeersResultOutput
Copy
public static class BgpPeers 
{
    public static Task<BgpPeersResult> InvokeAsync(BgpPeersArgs args, InvokeOptions? opts = null)
    public static Output<BgpPeersResult> Invoke(BgpPeersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<BgpPeersResult> bgpPeers(BgpPeersArgs args, InvokeOptions options)
public static Output<BgpPeersResult> bgpPeers(BgpPeersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: volcengine:direct_connect:BgpPeers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BgpPeerName string
The name of bgp peer.
DirectConnectGatewayId string
The id of direct connect gateway.
Ids List<string>
A list of IDs.
NameRegex string
A Name Regex of Resource.
OutputFile string
File name where to save data source results.
RemoteAsn int
The remote asn of bgp peer.
VirtualInterfaceId string
The id of virtual interface.
BgpPeerName string
The name of bgp peer.
DirectConnectGatewayId string
The id of direct connect gateway.
Ids []string
A list of IDs.
NameRegex string
A Name Regex of Resource.
OutputFile string
File name where to save data source results.
RemoteAsn int
The remote asn of bgp peer.
VirtualInterfaceId string
The id of virtual interface.
bgpPeerName String
The name of bgp peer.
directConnectGatewayId String
The id of direct connect gateway.
ids List<String>
A list of IDs.
nameRegex String
A Name Regex of Resource.
outputFile String
File name where to save data source results.
remoteAsn Integer
The remote asn of bgp peer.
virtualInterfaceId String
The id of virtual interface.
bgpPeerName string
The name of bgp peer.
directConnectGatewayId string
The id of direct connect gateway.
ids string[]
A list of IDs.
nameRegex string
A Name Regex of Resource.
outputFile string
File name where to save data source results.
remoteAsn number
The remote asn of bgp peer.
virtualInterfaceId string
The id of virtual interface.
bgp_peer_name str
The name of bgp peer.
direct_connect_gateway_id str
The id of direct connect gateway.
ids Sequence[str]
A list of IDs.
name_regex str
A Name Regex of Resource.
output_file str
File name where to save data source results.
remote_asn int
The remote asn of bgp peer.
virtual_interface_id str
The id of virtual interface.
bgpPeerName String
The name of bgp peer.
directConnectGatewayId String
The id of direct connect gateway.
ids List<String>
A list of IDs.
nameRegex String
A Name Regex of Resource.
outputFile String
File name where to save data source results.
remoteAsn Number
The remote asn of bgp peer.
virtualInterfaceId String
The id of virtual interface.

BgpPeers Result

The following output properties are available:

BgpPeers List<BgpPeersBgpPeer>
The collection of query.
Id string
The provider-assigned unique ID for this managed resource.
TotalCount int
The total count of query.
BgpPeerName string
The name of bgp peer.
DirectConnectGatewayId string
Ids List<string>
NameRegex string
OutputFile string
RemoteAsn int
The remote asn of bgp peer.
VirtualInterfaceId string
The id of virtual interface.
BgpPeers []BgpPeersBgpPeer
The collection of query.
Id string
The provider-assigned unique ID for this managed resource.
TotalCount int
The total count of query.
BgpPeerName string
The name of bgp peer.
DirectConnectGatewayId string
Ids []string
NameRegex string
OutputFile string
RemoteAsn int
The remote asn of bgp peer.
VirtualInterfaceId string
The id of virtual interface.
bgpPeers List<BgpPeersBgpPeer>
The collection of query.
id String
The provider-assigned unique ID for this managed resource.
totalCount Integer
The total count of query.
bgpPeerName String
The name of bgp peer.
directConnectGatewayId String
ids List<String>
nameRegex String
outputFile String
remoteAsn Integer
The remote asn of bgp peer.
virtualInterfaceId String
The id of virtual interface.
bgpPeers BgpPeersBgpPeer[]
The collection of query.
id string
The provider-assigned unique ID for this managed resource.
totalCount number
The total count of query.
bgpPeerName string
The name of bgp peer.
directConnectGatewayId string
ids string[]
nameRegex string
outputFile string
remoteAsn number
The remote asn of bgp peer.
virtualInterfaceId string
The id of virtual interface.
bgp_peers Sequence[BgpPeersBgpPeer]
The collection of query.
id str
The provider-assigned unique ID for this managed resource.
total_count int
The total count of query.
bgp_peer_name str
The name of bgp peer.
direct_connect_gateway_id str
ids Sequence[str]
name_regex str
output_file str
remote_asn int
The remote asn of bgp peer.
virtual_interface_id str
The id of virtual interface.
bgpPeers List<Property Map>
The collection of query.
id String
The provider-assigned unique ID for this managed resource.
totalCount Number
The total count of query.
bgpPeerName String
The name of bgp peer.
directConnectGatewayId String
ids List<String>
nameRegex String
outputFile String
remoteAsn Number
The remote asn of bgp peer.
virtualInterfaceId String
The id of virtual interface.

Supporting Types

BgpPeersBgpPeer

AccountId This property is required. string
The id of account.
AuthKey This property is required. string
The key of auth.
BgpPeerId This property is required. string
The id of bgp peer.
BgpPeerName This property is required. string
The name of bgp peer.
CreationTime This property is required. string
The create time of bgp peer.
Description This property is required. string
The Description of bgp peer.
LocalAsn This property is required. int
The local asn of bgp peer.
RemoteAsn This property is required. int
The remote asn of bgp peer.
SessionStatus This property is required. string
The session status of bgp peer.
Status This property is required. string
The status of bgp peer.
UpdateTime This property is required. string
The update time of bgp peer.
VirtualInterfaceId This property is required. string
The id of virtual interface.
AccountId This property is required. string
The id of account.
AuthKey This property is required. string
The key of auth.
BgpPeerId This property is required. string
The id of bgp peer.
BgpPeerName This property is required. string
The name of bgp peer.
CreationTime This property is required. string
The create time of bgp peer.
Description This property is required. string
The Description of bgp peer.
LocalAsn This property is required. int
The local asn of bgp peer.
RemoteAsn This property is required. int
The remote asn of bgp peer.
SessionStatus This property is required. string
The session status of bgp peer.
Status This property is required. string
The status of bgp peer.
UpdateTime This property is required. string
The update time of bgp peer.
VirtualInterfaceId This property is required. string
The id of virtual interface.
accountId This property is required. String
The id of account.
authKey This property is required. String
The key of auth.
bgpPeerId This property is required. String
The id of bgp peer.
bgpPeerName This property is required. String
The name of bgp peer.
creationTime This property is required. String
The create time of bgp peer.
description This property is required. String
The Description of bgp peer.
localAsn This property is required. Integer
The local asn of bgp peer.
remoteAsn This property is required. Integer
The remote asn of bgp peer.
sessionStatus This property is required. String
The session status of bgp peer.
status This property is required. String
The status of bgp peer.
updateTime This property is required. String
The update time of bgp peer.
virtualInterfaceId This property is required. String
The id of virtual interface.
accountId This property is required. string
The id of account.
authKey This property is required. string
The key of auth.
bgpPeerId This property is required. string
The id of bgp peer.
bgpPeerName This property is required. string
The name of bgp peer.
creationTime This property is required. string
The create time of bgp peer.
description This property is required. string
The Description of bgp peer.
localAsn This property is required. number
The local asn of bgp peer.
remoteAsn This property is required. number
The remote asn of bgp peer.
sessionStatus This property is required. string
The session status of bgp peer.
status This property is required. string
The status of bgp peer.
updateTime This property is required. string
The update time of bgp peer.
virtualInterfaceId This property is required. string
The id of virtual interface.
account_id This property is required. str
The id of account.
auth_key This property is required. str
The key of auth.
bgp_peer_id This property is required. str
The id of bgp peer.
bgp_peer_name This property is required. str
The name of bgp peer.
creation_time This property is required. str
The create time of bgp peer.
description This property is required. str
The Description of bgp peer.
local_asn This property is required. int
The local asn of bgp peer.
remote_asn This property is required. int
The remote asn of bgp peer.
session_status This property is required. str
The session status of bgp peer.
status This property is required. str
The status of bgp peer.
update_time This property is required. str
The update time of bgp peer.
virtual_interface_id This property is required. str
The id of virtual interface.
accountId This property is required. String
The id of account.
authKey This property is required. String
The key of auth.
bgpPeerId This property is required. String
The id of bgp peer.
bgpPeerName This property is required. String
The name of bgp peer.
creationTime This property is required. String
The create time of bgp peer.
description This property is required. String
The Description of bgp peer.
localAsn This property is required. Number
The local asn of bgp peer.
remoteAsn This property is required. Number
The remote asn of bgp peer.
sessionStatus This property is required. String
The session status of bgp peer.
status This property is required. String
The status of bgp peer.
updateTime This property is required. String
The update time of bgp peer.
virtualInterfaceId This property is required. String
The id of virtual interface.

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine