@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
88 lines (87 loc) • 2.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to retrieve a VRF resource.
*
* See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const exampleVrf = equinix.metal.getVrf({
* vrfId: "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
* });
* ```
*/
export declare function getVrf(args: GetVrfArgs, opts?: pulumi.InvokeOptions): Promise<GetVrfResult>;
/**
* A collection of arguments for invoking getVrf.
*/
export interface GetVrfArgs {
/**
* ID of the VRF resource
*/
vrfId: string;
}
/**
* A collection of values returned by getVrf.
*/
export interface GetVrfResult {
/**
* Description of the VRF.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
*/
readonly ipRanges: string[];
/**
* The 4-byte ASN set on the VRF.
*/
readonly localAsn: number;
/**
* Metro ID or Code where the VRF will be deployed.
*/
readonly metro: string;
/**
* User-supplied name of the VRF, unique to the project
*/
readonly name: string;
/**
* Project ID where the VRF will be deployed.
*/
readonly projectId: string;
readonly vrfId: string;
}
/**
* Use this data source to retrieve a VRF resource.
*
* See the [Virtual Routing and Forwarding documentation](https://deploy.equinix.com/developers/docs/metal/layer2-networking/vrf/) for product details and API reference material.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const exampleVrf = equinix.metal.getVrf({
* vrfId: "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
* });
* ```
*/
export declare function getVrfOutput(args: GetVrfOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVrfResult>;
/**
* A collection of arguments for invoking getVrf.
*/
export interface GetVrfOutputArgs {
/**
* ID of the VRF resource
*/
vrfId: pulumi.Input<string>;
}