@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
167 lines (166 loc) • 5.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource `equinix.networkedge.Bgp` allows creation and management of Equinix Network Edge BGP peering configurations.
*
* ## Example Usage
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const test = new equinix.networkedge.Bgp("test", {
* connectionId: "54014acf-9730-4b55-a791-459283d05fb1",
* localIpAddress: "10.1.1.1/30",
* localAsn: 12345,
* remoteIpAddress: "10.1.1.2",
* remoteAsn: 66123,
* authenticationKey: "secret",
* });
* ```
*
* ## Import
*
* This resource can be imported using an existing ID:
*
* ```sh
* $ pulumi import equinix:networkedge/bgp:Bgp example {existing_id}
* ```
*/
export declare class Bgp extends pulumi.CustomResource {
/**
* Get an existing Bgp resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BgpState, opts?: pulumi.CustomResourceOptions): Bgp;
/**
* Returns true if the given object is an instance of Bgp. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Bgp;
/**
* shared key used for BGP peer authentication.
*/
readonly authenticationKey: pulumi.Output<string | undefined>;
/**
* identifier of a connection established between. network device and remote service provider that will be used for peering.
*/
readonly connectionId: pulumi.Output<string>;
/**
* unique identifier of a network device that is a local peer in a given BGP peering configuration.
*/
readonly deviceId: pulumi.Output<string>;
/**
* Local ASN number.
*/
readonly localAsn: pulumi.Output<number>;
/**
* IP address in CIDR format of a local device.
*/
readonly localIpAddress: pulumi.Output<string>;
/**
* BGP peering configuration provisioning status, one of `PROVISIONING`, `PENDING_UPDATE`, `PROVISIONED`, `FAILED`.
*/
readonly provisioningStatus: pulumi.Output<string>;
/**
* Remote ASN number.
*/
readonly remoteAsn: pulumi.Output<number>;
/**
* IP address of remote peer.
*/
readonly remoteIpAddress: pulumi.Output<string>;
/**
* BGP peer state, one of `Idle`, `Connect`, `Active`, `OpenSent`, `OpenConfirm`, `Established`.
*/
readonly state: pulumi.Output<string>;
/**
* BGP peering configuration unique identifier.
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a Bgp resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BgpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Bgp resources.
*/
export interface BgpState {
/**
* shared key used for BGP peer authentication.
*/
authenticationKey?: pulumi.Input<string>;
/**
* identifier of a connection established between. network device and remote service provider that will be used for peering.
*/
connectionId?: pulumi.Input<string>;
/**
* unique identifier of a network device that is a local peer in a given BGP peering configuration.
*/
deviceId?: pulumi.Input<string>;
/**
* Local ASN number.
*/
localAsn?: pulumi.Input<number>;
/**
* IP address in CIDR format of a local device.
*/
localIpAddress?: pulumi.Input<string>;
/**
* BGP peering configuration provisioning status, one of `PROVISIONING`, `PENDING_UPDATE`, `PROVISIONED`, `FAILED`.
*/
provisioningStatus?: pulumi.Input<string>;
/**
* Remote ASN number.
*/
remoteAsn?: pulumi.Input<number>;
/**
* IP address of remote peer.
*/
remoteIpAddress?: pulumi.Input<string>;
/**
* BGP peer state, one of `Idle`, `Connect`, `Active`, `OpenSent`, `OpenConfirm`, `Established`.
*/
state?: pulumi.Input<string>;
/**
* BGP peering configuration unique identifier.
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Bgp resource.
*/
export interface BgpArgs {
/**
* shared key used for BGP peer authentication.
*/
authenticationKey?: pulumi.Input<string>;
/**
* identifier of a connection established between. network device and remote service provider that will be used for peering.
*/
connectionId: pulumi.Input<string>;
/**
* Local ASN number.
*/
localAsn: pulumi.Input<number>;
/**
* IP address in CIDR format of a local device.
*/
localIpAddress: pulumi.Input<string>;
/**
* Remote ASN number.
*/
remoteAsn: pulumi.Input<number>;
/**
* IP address of remote peer.
*/
remoteIpAddress: pulumi.Input<string>;
}