@volcengine/pulumi/direct_connect/getBgpPeers.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of direct connect bgp peers
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.direct_connect.getBgpPeers({
 *     ids: ["bgp-171w6pn39ruo04d1w33iq****"],
 * });
 * ```
 */
export declare function getBgpPeers(args?: GetBgpPeersArgs, opts?: pulumi.InvokeOptions): Promise<GetBgpPeersResult>;
/**
 * A collection of arguments for invoking getBgpPeers.
 */
export interface GetBgpPeersArgs {
    /**
     * The name of bgp peer.
     */
    bgpPeerName?: string;
    /**
     * The id of direct connect gateway.
     */
    directConnectGatewayId?: string;
    /**
     * A list of IDs.
     */
    ids?: string[];
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * The remote asn of bgp peer.
     */
    remoteAsn?: number;
    /**
     * The id of virtual interface.
     */
    virtualInterfaceId?: string;
}
/**
 * A collection of values returned by getBgpPeers.
 */
export interface GetBgpPeersResult {
    /**
     * The name of bgp peer.
     */
    readonly bgpPeerName?: string;
    /**
     * The collection of query.
     */
    readonly bgpPeers: outputs.direct_connect.GetBgpPeersBgpPeer[];
    readonly directConnectGatewayId?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly ids?: string[];
    readonly nameRegex?: string;
    readonly outputFile?: string;
    /**
     * The remote asn of bgp peer.
     */
    readonly remoteAsn?: number;
    /**
     * The total count of query.
     */
    readonly totalCount: number;
    /**
     * The id of virtual interface.
     */
    readonly virtualInterfaceId?: string;
}
/**
 * Use this data source to query detailed information of direct connect bgp peers
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.direct_connect.getBgpPeers({
 *     ids: ["bgp-171w6pn39ruo04d1w33iq****"],
 * });
 * ```
 */
export declare function getBgpPeersOutput(args?: GetBgpPeersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetBgpPeersResult>;
/**
 * A collection of arguments for invoking getBgpPeers.
 */
export interface GetBgpPeersOutputArgs {
    /**
     * The name of bgp peer.
     */
    bgpPeerName?: pulumi.Input<string>;
    /**
     * The id of direct connect gateway.
     */
    directConnectGatewayId?: pulumi.Input<string>;
    /**
     * A list of IDs.
     */
    ids?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * The remote asn of bgp peer.
     */
    remoteAsn?: pulumi.Input<number>;
    /**
     * The id of virtual interface.
     */
    virtualInterfaceId?: pulumi.Input<string>;
}