@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
322 lines (321 loc) • 10 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Fabric V4 API compatible resource allows creation and management of Equinix Fabric connection
*
* Additional documentation:
* * Getting Started: https://docs.equinix.com/en-us/Content/Interconnection/FCR/connections/FCR-connect-azureQC.htm#ConfigureRoutingDetailsintheFabricPortal
* * API: https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols
*
* ## Example Usage
* ### example 1
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const direct = new equinix.fabric.RoutingProtocol("direct", {
* connectionUuid: "<some_id>",
* type: "DIRECT",
* name: "direct_rp",
* directIpv4: {
* equinixIfaceIp: "190.1.1.1/30",
* },
* directIpv6: {
* equinixIfaceIp: "190::1:1/126",
* },
* });
* ```
* ### example 2
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const bgp = new equinix.fabric.RoutingProtocol("bgp", {
* connectionUuid: "<same_connection_id_as_first_equinix_fabric_routing_protocol>",
* type: "BGP",
* name: "bgp_rp",
* bgpIpv4: {
* customerPeerIp: "190.1.1.2",
* enabled: true,
* },
* bgpIpv6: {
* customerPeerIp: "190::1:2",
* enabled: true,
* },
* customerAsn: 4532,
* });
* ```
* ### example 3
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const direct = new equinix.fabric.RoutingProtocol("direct", {
* connectionUuid: "<some_id>",
* type: "DIRECT",
* name: "direct_rp",
* directIpv4: {
* equinixIfaceIp: "190.1.1.1/30",
* },
* directIpv6: {
* equinixIfaceIp: "190::1:1/126",
* },
* });
* const bgp = new equinix.fabric.RoutingProtocol("bgp", {
* connectionUuid: "<same_connection_id_as_first_equinix_fabric_routing_protocol>",
* type: "BGP",
* name: "bgp_rp",
* bgpIpv4: {
* customerPeerIp: "190.1.1.2",
* enabled: true,
* },
* bgpIpv6: {
* customerPeerIp: "190::1:2",
* enabled: true,
* },
* customerAsn: 4532,
* }, {
* dependsOn: [direct],
* });
* ```
*/
export declare class RoutingProtocol extends pulumi.CustomResource {
/**
* Get an existing RoutingProtocol 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?: RoutingProtocolState, opts?: pulumi.CustomResourceOptions): RoutingProtocol;
/**
* Returns true if the given object is an instance of RoutingProtocol. 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 RoutingProtocol;
/**
* Enable AS number override
*/
readonly asOverrideEnabled: pulumi.Output<boolean>;
/**
* Bidirectional Forwarding Detection
*/
readonly bfd: pulumi.Output<outputs.fabric.RoutingProtocolBfd>;
/**
* BGP authorization key
*/
readonly bgpAuthKey: pulumi.Output<string>;
/**
* Routing Protocol BGP IPv4
*/
readonly bgpIpv4: pulumi.Output<outputs.fabric.RoutingProtocolBgpIpv4>;
/**
* Routing Protocol BGP IPv6
*/
readonly bgpIpv6: pulumi.Output<outputs.fabric.RoutingProtocolBgpIpv6>;
/**
* Captures Routing Protocol lifecycle change information
*/
readonly changeLogs: pulumi.Output<outputs.fabric.RoutingProtocolChangeLog[]>;
/**
* Routing Protocol configuration Changes
*/
readonly changes: pulumi.Output<outputs.fabric.RoutingProtocolChange[]>;
/**
* Connection URI associated with Routing Protocol
*/
readonly connectionUuid: pulumi.Output<string>;
/**
* Customer-provided ASN
*/
readonly customerAsn: pulumi.Output<number>;
/**
* Customer-provided Fabric Routing Protocol description
*/
readonly description: pulumi.Output<string>;
/**
* Routing Protocol Direct IPv4
*/
readonly directIpv4: pulumi.Output<outputs.fabric.RoutingProtocolDirectIpv4>;
/**
* Routing Protocol Direct IPv6
*/
readonly directIpv6: pulumi.Output<outputs.fabric.RoutingProtocolDirectIpv6>;
/**
* Equinix ASN
*/
readonly equinixAsn: pulumi.Output<number>;
/**
* Routing Protocol URI information
*/
readonly href: pulumi.Output<string>;
/**
* Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
*/
readonly name: pulumi.Output<string>;
/**
* Routing Protocol type-specific operational data
*/
readonly operations: pulumi.Output<outputs.fabric.RoutingProtocolOperation[]>;
/**
* Routing Protocol overall state
*/
readonly state: pulumi.Output<string>;
/**
* Defines the routing protocol type like BGP or DIRECT
*/
readonly type: pulumi.Output<string>;
/**
* Equinix-assigned routing protocol identifier
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a RoutingProtocol 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: RoutingProtocolArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RoutingProtocol resources.
*/
export interface RoutingProtocolState {
/**
* Enable AS number override
*/
asOverrideEnabled?: pulumi.Input<boolean>;
/**
* Bidirectional Forwarding Detection
*/
bfd?: pulumi.Input<inputs.fabric.RoutingProtocolBfd>;
/**
* BGP authorization key
*/
bgpAuthKey?: pulumi.Input<string>;
/**
* Routing Protocol BGP IPv4
*/
bgpIpv4?: pulumi.Input<inputs.fabric.RoutingProtocolBgpIpv4>;
/**
* Routing Protocol BGP IPv6
*/
bgpIpv6?: pulumi.Input<inputs.fabric.RoutingProtocolBgpIpv6>;
/**
* Captures Routing Protocol lifecycle change information
*/
changeLogs?: pulumi.Input<pulumi.Input<inputs.fabric.RoutingProtocolChangeLog>[]>;
/**
* Routing Protocol configuration Changes
*/
changes?: pulumi.Input<pulumi.Input<inputs.fabric.RoutingProtocolChange>[]>;
/**
* Connection URI associated with Routing Protocol
*/
connectionUuid?: pulumi.Input<string>;
/**
* Customer-provided ASN
*/
customerAsn?: pulumi.Input<number>;
/**
* Customer-provided Fabric Routing Protocol description
*/
description?: pulumi.Input<string>;
/**
* Routing Protocol Direct IPv4
*/
directIpv4?: pulumi.Input<inputs.fabric.RoutingProtocolDirectIpv4>;
/**
* Routing Protocol Direct IPv6
*/
directIpv6?: pulumi.Input<inputs.fabric.RoutingProtocolDirectIpv6>;
/**
* Equinix ASN
*/
equinixAsn?: pulumi.Input<number>;
/**
* Routing Protocol URI information
*/
href?: pulumi.Input<string>;
/**
* Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
*/
name?: pulumi.Input<string>;
/**
* Routing Protocol type-specific operational data
*/
operations?: pulumi.Input<pulumi.Input<inputs.fabric.RoutingProtocolOperation>[]>;
/**
* Routing Protocol overall state
*/
state?: pulumi.Input<string>;
/**
* Defines the routing protocol type like BGP or DIRECT
*/
type?: pulumi.Input<string>;
/**
* Equinix-assigned routing protocol identifier
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RoutingProtocol resource.
*/
export interface RoutingProtocolArgs {
/**
* Enable AS number override
*/
asOverrideEnabled?: pulumi.Input<boolean>;
/**
* Bidirectional Forwarding Detection
*/
bfd?: pulumi.Input<inputs.fabric.RoutingProtocolBfd>;
/**
* BGP authorization key
*/
bgpAuthKey?: pulumi.Input<string>;
/**
* Routing Protocol BGP IPv4
*/
bgpIpv4?: pulumi.Input<inputs.fabric.RoutingProtocolBgpIpv4>;
/**
* Routing Protocol BGP IPv6
*/
bgpIpv6?: pulumi.Input<inputs.fabric.RoutingProtocolBgpIpv6>;
/**
* Connection URI associated with Routing Protocol
*/
connectionUuid: pulumi.Input<string>;
/**
* Customer-provided ASN
*/
customerAsn?: pulumi.Input<number>;
/**
* Customer-provided Fabric Routing Protocol description
*/
description?: pulumi.Input<string>;
/**
* Routing Protocol Direct IPv4
*/
directIpv4?: pulumi.Input<inputs.fabric.RoutingProtocolDirectIpv4>;
/**
* Routing Protocol Direct IPv6
*/
directIpv6?: pulumi.Input<inputs.fabric.RoutingProtocolDirectIpv6>;
/**
* Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
*/
name?: pulumi.Input<string>;
/**
* Defines the routing protocol type like BGP or DIRECT
*/
type?: pulumi.Input<string>;
/**
* Equinix-assigned routing protocol identifier
*/
uuid?: pulumi.Input<string>;
}