@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
152 lines (151 loc) • 5.79 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 Route Filter Policy
*
* Additional Documentation:
* * Getting Started: https://docs.equinix.com/en-us/Content/Interconnection/FCR/FCR-route-filters.htm
* * API: https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#route-filters
*/
export declare class RouteFilter extends pulumi.CustomResource {
/**
* Get an existing RouteFilter 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?: RouteFilterState, opts?: pulumi.CustomResourceOptions): RouteFilter;
/**
* Returns true if the given object is an instance of RouteFilter. 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 RouteFilter;
readonly changeLogs: pulumi.Output<outputs.fabric.RouteFilterChangeLog[]>;
/**
* An object with the details of the previous change applied on the Route Filter
*/
readonly changes: pulumi.Output<outputs.fabric.RouteFilterChange[]>;
/**
* The number of Fabric Connections that this Route Filter is attached to
*/
readonly connectionsCount: pulumi.Output<number>;
/**
* Optional description to add to the Route Filter you will be creating
*/
readonly description: pulumi.Output<string>;
/**
* Route filter URI
*/
readonly href: pulumi.Output<string>;
/**
* Name of the Route Filter
*/
readonly name: pulumi.Output<string>;
/**
* The action that will be taken on ip ranges that don't match the rules present within the Route Filter
*/
readonly notMatchedRuleAction: pulumi.Output<string>;
/**
* The Project object that contains projectId and href that is related to the Fabric Project containing connections the Route Filter can be attached to
*/
readonly project: pulumi.Output<outputs.fabric.RouteFilterProject>;
/**
* The number of Route Filter Rules attached to this Route Filter
*/
readonly rulesCount: pulumi.Output<number>;
/**
* State of the Route Filter in its lifecycle
*/
readonly state: pulumi.Output<string>;
/**
* Route Filter Type. One of [ "BGP*IPv4*PREFIX*FILTER", "BGP*IPv6*PREFIX*FILTER" ]
*/
readonly type: pulumi.Output<string>;
/**
* Equinix Assigned ID for Route Filter
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a RouteFilter 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: RouteFilterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RouteFilter resources.
*/
export interface RouteFilterState {
changeLogs?: pulumi.Input<pulumi.Input<inputs.fabric.RouteFilterChangeLog>[]>;
/**
* An object with the details of the previous change applied on the Route Filter
*/
changes?: pulumi.Input<pulumi.Input<inputs.fabric.RouteFilterChange>[]>;
/**
* The number of Fabric Connections that this Route Filter is attached to
*/
connectionsCount?: pulumi.Input<number>;
/**
* Optional description to add to the Route Filter you will be creating
*/
description?: pulumi.Input<string>;
/**
* Route filter URI
*/
href?: pulumi.Input<string>;
/**
* Name of the Route Filter
*/
name?: pulumi.Input<string>;
/**
* The action that will be taken on ip ranges that don't match the rules present within the Route Filter
*/
notMatchedRuleAction?: pulumi.Input<string>;
/**
* The Project object that contains projectId and href that is related to the Fabric Project containing connections the Route Filter can be attached to
*/
project?: pulumi.Input<inputs.fabric.RouteFilterProject>;
/**
* The number of Route Filter Rules attached to this Route Filter
*/
rulesCount?: pulumi.Input<number>;
/**
* State of the Route Filter in its lifecycle
*/
state?: pulumi.Input<string>;
/**
* Route Filter Type. One of [ "BGP*IPv4*PREFIX*FILTER", "BGP*IPv6*PREFIX*FILTER" ]
*/
type?: pulumi.Input<string>;
/**
* Equinix Assigned ID for Route Filter
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RouteFilter resource.
*/
export interface RouteFilterArgs {
/**
* Optional description to add to the Route Filter you will be creating
*/
description?: pulumi.Input<string>;
/**
* Name of the Route Filter
*/
name?: pulumi.Input<string>;
/**
* The Project object that contains projectId and href that is related to the Fabric Project containing connections the Route Filter can be attached to
*/
project: pulumi.Input<inputs.fabric.RouteFilterProject>;
/**
* Route Filter Type. One of [ "BGP*IPv4*PREFIX*FILTER", "BGP*IPv6*PREFIX*FILTER" ]
*/
type: pulumi.Input<string>;
}