Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getRouteFilter
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

equinix.fabric.getRouteFilter

Explore with Pulumi AI

equinix logo
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible data resource that allow user to fetch route filter for a given UUID

    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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@pulumi/equinix";

const rfPolicy = equinix.fabric.getRouteFilter({
    uuid: "<uuid_of_route_filter",
});
export const id = rfPolicy.then(rfPolicy => rfPolicy.id);
export const type = rfPolicy.then(rfPolicy => rfPolicy.type);
export const state = rfPolicy.then(rfPolicy => rfPolicy.state);
export const notMatchedRulesAction = rfPolicy.then(rfPolicy => rfPolicy.notMatchedRuleAction);
export const connectionsCount = rfPolicy.then(rfPolicy => rfPolicy.connectionsCount);
export const rulesCount = rfPolicy.then(rfPolicy => rfPolicy.rulesCount);

    import pulumi
import pulumi_equinix as equinix

rf_policy = equinix.fabric.get_route_filter(uuid="<uuid_of_route_filter")
pulumi.export("id", rf_policy.id)
pulumi.export("type", rf_policy.type)
pulumi.export("state", rf_policy.state)
pulumi.export("notMatchedRulesAction", rf_policy.not_matched_rule_action)
pulumi.export("connectionsCount", rf_policy.connections_count)
pulumi.export("rulesCount", rf_policy.rules_count)

    package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/fabric"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		rfPolicy, err := fabric.LookupRouteFilter(ctx, &fabric.LookupRouteFilterArgs{
			Uuid: "<uuid_of_route_filter",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", rfPolicy.Id)
		ctx.Export("type", rfPolicy.Type)
		ctx.Export("state", rfPolicy.State)
		ctx.Export("notMatchedRulesAction", rfPolicy.NotMatchedRuleAction)
		ctx.Export("connectionsCount", rfPolicy.ConnectionsCount)
		ctx.Export("rulesCount", rfPolicy.RulesCount)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var rfPolicy = Equinix.Fabric.GetRouteFilter.Invoke(new()
    {
        Uuid = "<uuid_of_route_filter",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = rfPolicy.Apply(getRouteFilterResult => getRouteFilterResult.Id),
        ["type"] = rfPolicy.Apply(getRouteFilterResult => getRouteFilterResult.Type),
        ["state"] = rfPolicy.Apply(getRouteFilterResult => getRouteFilterResult.State),
        ["notMatchedRulesAction"] = rfPolicy.Apply(getRouteFilterResult => getRouteFilterResult.NotMatchedRuleAction),
        ["connectionsCount"] = rfPolicy.Apply(getRouteFilterResult => getRouteFilterResult.ConnectionsCount),
        ["rulesCount"] = rfPolicy.Apply(getRouteFilterResult => getRouteFilterResult.RulesCount),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.FabricFunctions;
import com.pulumi.equinix.fabric.inputs.GetRouteFilterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var rfPolicy = FabricFunctions.getRouteFilter(GetRouteFilterArgs.builder()
            .uuid("<uuid_of_route_filter")
            .build());

        ctx.export("id", rfPolicy.applyValue(getRouteFilterResult -> getRouteFilterResult.id()));
        ctx.export("type", rfPolicy.applyValue(getRouteFilterResult -> getRouteFilterResult.type()));
        ctx.export("state", rfPolicy.applyValue(getRouteFilterResult -> getRouteFilterResult.state()));
        ctx.export("notMatchedRulesAction", rfPolicy.applyValue(getRouteFilterResult -> getRouteFilterResult.notMatchedRuleAction()));
        ctx.export("connectionsCount", rfPolicy.applyValue(getRouteFilterResult -> getRouteFilterResult.connectionsCount()));
        ctx.export("rulesCount", rfPolicy.applyValue(getRouteFilterResult -> getRouteFilterResult.rulesCount()));
    }
}

    variables:
  rfPolicy:
    fn::invoke:
      Function: equinix:fabric:getRouteFilter
      Arguments:
        uuid: <uuid_of_route_filter
outputs:
  id: ${rfPolicy.id}
  type: ${rfPolicy.type}
  state: ${rfPolicy.state}
  notMatchedRulesAction: ${rfPolicy.notMatchedRuleAction}
  connectionsCount: ${rfPolicy.connectionsCount}
  rulesCount: ${rfPolicy.rulesCount}

    Using getRouteFilter

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRouteFilter(args: GetRouteFilterArgs, opts?: InvokeOptions): Promise<GetRouteFilterResult>
function getRouteFilterOutput(args: GetRouteFilterOutputArgs, opts?: InvokeOptions): Output<GetRouteFilterResult>
    def get_route_filter(uuid: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRouteFilterResult
def get_route_filter_output(uuid: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRouteFilterResult]
    func LookupRouteFilter(ctx *Context, args *LookupRouteFilterArgs, opts ...InvokeOption) (*LookupRouteFilterResult, error)
func LookupRouteFilterOutput(ctx *Context, args *LookupRouteFilterOutputArgs, opts ...InvokeOption) LookupRouteFilterResultOutput

    > Note: This function is named LookupRouteFilter in the Go SDK.

    public static class GetRouteFilter 
{
    public static Task<GetRouteFilterResult> InvokeAsync(GetRouteFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteFilterResult> Invoke(GetRouteFilterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteFilterResult> getRouteFilter(GetRouteFilterArgs args, InvokeOptions options)
public static Output<GetRouteFilterResult> getRouteFilter(GetRouteFilterArgs args, InvokeOptions options)

    fn::invoke:
  function: equinix:fabric/getRouteFilter:getRouteFilter
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Uuid string
    Equinix Assigned ID for Route Filter
    Uuid string
    Equinix Assigned ID for Route Filter
    uuid String
    Equinix Assigned ID for Route Filter
    uuid string
    Equinix Assigned ID for Route Filter
    uuid str
    Equinix Assigned ID for Route Filter
    uuid String
    Equinix Assigned ID for Route Filter

    getRouteFilter Result

    The following output properties are available:

    ChangeLogs List<GetRouteFilterChangeLog>
    Changes List<GetRouteFilterChange>
    An object with the details of the previous change applied on the Route Filter
    ConnectionsCount int
    The number of Fabric Connections that this Route Filter is attached to
    Description string
    Optional description to add to the Route Filter you will be creating
    Href string
    Route filter URI
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the Route Filter
    NotMatchedRuleAction string
    The action that will be taken on ip ranges that don't match the rules present within the Route Filter
    Projects List<GetRouteFilterProject>
    The Project object that contains project_id and href that is related to the Fabric Project containing connections the Route Filter can be attached to
    RulesCount int
    The number of Route Filter Rules attached to this Route Filter
    State string
    State of the Route Filter in its lifecycle
    Type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    Uuid string
    Equinix Assigned ID for Route Filter
    ChangeLogs []GetRouteFilterChangeLog
    Changes []GetRouteFilterChange
    An object with the details of the previous change applied on the Route Filter
    ConnectionsCount int
    The number of Fabric Connections that this Route Filter is attached to
    Description string
    Optional description to add to the Route Filter you will be creating
    Href string
    Route filter URI
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the Route Filter
    NotMatchedRuleAction string
    The action that will be taken on ip ranges that don't match the rules present within the Route Filter
    Projects []GetRouteFilterProject
    The Project object that contains project_id and href that is related to the Fabric Project containing connections the Route Filter can be attached to
    RulesCount int
    The number of Route Filter Rules attached to this Route Filter
    State string
    State of the Route Filter in its lifecycle
    Type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    Uuid string
    Equinix Assigned ID for Route Filter
    changeLogs List<GetRouteFilterChangeLog>
    changes List<GetRouteFilterChange>
    An object with the details of the previous change applied on the Route Filter
    connectionsCount Integer
    The number of Fabric Connections that this Route Filter is attached to
    description String
    Optional description to add to the Route Filter you will be creating
    href String
    Route filter URI
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the Route Filter
    notMatchedRuleAction String
    The action that will be taken on ip ranges that don't match the rules present within the Route Filter
    projects List<GetRouteFilterProject>
    The Project object that contains project_id and href that is related to the Fabric Project containing connections the Route Filter can be attached to
    rulesCount Integer
    The number of Route Filter Rules attached to this Route Filter
    state String
    State of the Route Filter in its lifecycle
    type String
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid String
    Equinix Assigned ID for Route Filter
    changeLogs GetRouteFilterChangeLog[]
    changes GetRouteFilterChange[]
    An object with the details of the previous change applied on the Route Filter
    connectionsCount number
    The number of Fabric Connections that this Route Filter is attached to
    description string
    Optional description to add to the Route Filter you will be creating
    href string
    Route filter URI
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the Route Filter
    notMatchedRuleAction string
    The action that will be taken on ip ranges that don't match the rules present within the Route Filter
    projects GetRouteFilterProject[]
    The Project object that contains project_id and href that is related to the Fabric Project containing connections the Route Filter can be attached to
    rulesCount number
    The number of Route Filter Rules attached to this Route Filter
    state string
    State of the Route Filter in its lifecycle
    type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid string
    Equinix Assigned ID for Route Filter
    change_logs Sequence[GetRouteFilterChangeLog]
    changes Sequence[GetRouteFilterChange]
    An object with the details of the previous change applied on the Route Filter
    connections_count int
    The number of Fabric Connections that this Route Filter is attached to
    description str
    Optional description to add to the Route Filter you will be creating
    href str
    Route filter URI
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the Route Filter
    not_matched_rule_action str
    The action that will be taken on ip ranges that don't match the rules present within the Route Filter
    projects Sequence[GetRouteFilterProject]
    The Project object that contains project_id and href that is related to the Fabric Project containing connections the Route Filter can be attached to
    rules_count int
    The number of Route Filter Rules attached to this Route Filter
    state str
    State of the Route Filter in its lifecycle
    type str
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid str
    Equinix Assigned ID for Route Filter
    changeLogs List<Property Map>
    changes List<Property Map>
    An object with the details of the previous change applied on the Route Filter
    connectionsCount Number
    The number of Fabric Connections that this Route Filter is attached to
    description String
    Optional description to add to the Route Filter you will be creating
    href String
    Route filter URI
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the Route Filter
    notMatchedRuleAction String
    The action that will be taken on ip ranges that don't match the rules present within the Route Filter
    projects List<Property Map>
    The Project object that contains project_id and href that is related to the Fabric Project containing connections the Route Filter can be attached to
    rulesCount Number
    The number of Route Filter Rules attached to this Route Filter
    state String
    State of the Route Filter in its lifecycle
    type String
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid String
    Equinix Assigned ID for Route Filter

    Supporting Types

    GetRouteFilterChange

    Href string
    The URI of the previous Route Filter Change
    Type string
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_UPDATE","BGP_IPv4_PREFIX_FILTER_CREATION","BGP_IPv4_PREFIX_FILTER_DELETION","BGP_IPv6_PREFIX_FILTER_UPDATE","BGP_IPv6_PREFIX_FILTER_CREATION","BGP_IPv6_PREFIX_FILTER_DELETION" ]
    Uuid string
    Unique identifier for the previous change
    Href string
    The URI of the previous Route Filter Change
    Type string
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_UPDATE","BGP_IPv4_PREFIX_FILTER_CREATION","BGP_IPv4_PREFIX_FILTER_DELETION","BGP_IPv6_PREFIX_FILTER_UPDATE","BGP_IPv6_PREFIX_FILTER_CREATION","BGP_IPv6_PREFIX_FILTER_DELETION" ]
    Uuid string
    Unique identifier for the previous change
    href String
    The URI of the previous Route Filter Change
    type String
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_UPDATE","BGP_IPv4_PREFIX_FILTER_CREATION","BGP_IPv4_PREFIX_FILTER_DELETION","BGP_IPv6_PREFIX_FILTER_UPDATE","BGP_IPv6_PREFIX_FILTER_CREATION","BGP_IPv6_PREFIX_FILTER_DELETION" ]
    uuid String
    Unique identifier for the previous change
    href string
    The URI of the previous Route Filter Change
    type string
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_UPDATE","BGP_IPv4_PREFIX_FILTER_CREATION","BGP_IPv4_PREFIX_FILTER_DELETION","BGP_IPv6_PREFIX_FILTER_UPDATE","BGP_IPv6_PREFIX_FILTER_CREATION","BGP_IPv6_PREFIX_FILTER_DELETION" ]
    uuid string
    Unique identifier for the previous change
    href str
    The URI of the previous Route Filter Change
    type str
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_UPDATE","BGP_IPv4_PREFIX_FILTER_CREATION","BGP_IPv4_PREFIX_FILTER_DELETION","BGP_IPv6_PREFIX_FILTER_UPDATE","BGP_IPv6_PREFIX_FILTER_CREATION","BGP_IPv6_PREFIX_FILTER_DELETION" ]
    uuid str
    Unique identifier for the previous change
    href String
    The URI of the previous Route Filter Change
    type String
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_UPDATE","BGP_IPv4_PREFIX_FILTER_CREATION","BGP_IPv4_PREFIX_FILTER_DELETION","BGP_IPv6_PREFIX_FILTER_UPDATE","BGP_IPv6_PREFIX_FILTER_CREATION","BGP_IPv6_PREFIX_FILTER_DELETION" ]
    uuid String
    Unique identifier for the previous change

    GetRouteFilterChangeLog

    CreatedBy string
    Created by User Key
    CreatedByEmail string
    Created by User Email Address
    CreatedByFullName string
    Created by User Full Name
    CreatedDateTime string
    Created by Date and Time
    DeletedBy string
    Deleted by User Key
    DeletedByEmail string
    Deleted by User Email Address
    DeletedByFullName string
    Deleted by User Full Name
    DeletedDateTime string
    Deleted by Date and Time
    UpdatedBy string
    Updated by User Key
    UpdatedByEmail string
    Updated by User Email Address
    UpdatedByFullName string
    Updated by User Full Name
    UpdatedDateTime string
    Updated by Date and Time
    CreatedBy string
    Created by User Key
    CreatedByEmail string
    Created by User Email Address
    CreatedByFullName string
    Created by User Full Name
    CreatedDateTime string
    Created by Date and Time
    DeletedBy string
    Deleted by User Key
    DeletedByEmail string
    Deleted by User Email Address
    DeletedByFullName string
    Deleted by User Full Name
    DeletedDateTime string
    Deleted by Date and Time
    UpdatedBy string
    Updated by User Key
    UpdatedByEmail string
    Updated by User Email Address
    UpdatedByFullName string
    Updated by User Full Name
    UpdatedDateTime string
    Updated by Date and Time
    createdBy String
    Created by User Key
    createdByEmail String
    Created by User Email Address
    createdByFullName String
    Created by User Full Name
    createdDateTime String
    Created by Date and Time
    deletedBy String
    Deleted by User Key
    deletedByEmail String
    Deleted by User Email Address
    deletedByFullName String
    Deleted by User Full Name
    deletedDateTime String
    Deleted by Date and Time
    updatedBy String
    Updated by User Key
    updatedByEmail String
    Updated by User Email Address
    updatedByFullName String
    Updated by User Full Name
    updatedDateTime String
    Updated by Date and Time
    createdBy string
    Created by User Key
    createdByEmail string
    Created by User Email Address
    createdByFullName string
    Created by User Full Name
    createdDateTime string
    Created by Date and Time
    deletedBy string
    Deleted by User Key
    deletedByEmail string
    Deleted by User Email Address
    deletedByFullName string
    Deleted by User Full Name
    deletedDateTime string
    Deleted by Date and Time
    updatedBy string
    Updated by User Key
    updatedByEmail string
    Updated by User Email Address
    updatedByFullName string
    Updated by User Full Name
    updatedDateTime string
    Updated by Date and Time
    created_by str
    Created by User Key
    created_by_email str
    Created by User Email Address
    created_by_full_name str
    Created by User Full Name
    created_date_time str
    Created by Date and Time
    deleted_by str
    Deleted by User Key
    deleted_by_email str
    Deleted by User Email Address
    deleted_by_full_name str
    Deleted by User Full Name
    deleted_date_time str
    Deleted by Date and Time
    updated_by str
    Updated by User Key
    updated_by_email str
    Updated by User Email Address
    updated_by_full_name str
    Updated by User Full Name
    updated_date_time str
    Updated by Date and Time
    createdBy String
    Created by User Key
    createdByEmail String
    Created by User Email Address
    createdByFullName String
    Created by User Full Name
    createdDateTime String
    Created by Date and Time
    deletedBy String
    Deleted by User Key
    deletedByEmail String
    Deleted by User Email Address
    deletedByFullName String
    Deleted by User Full Name
    deletedDateTime String
    Deleted by Date and Time
    updatedBy String
    Updated by User Key
    updatedByEmail String
    Updated by User Email Address
    updatedByFullName String
    Updated by User Full Name
    updatedDateTime String
    Updated by Date and Time

    GetRouteFilterProject

    Href string
    URI of the Fabric Project
    ProjectId string
    Project id associated with Fabric Project
    Href string
    URI of the Fabric Project
    ProjectId string
    Project id associated with Fabric Project
    href String
    URI of the Fabric Project
    projectId String
    Project id associated with Fabric Project
    href string
    URI of the Fabric Project
    projectId string
    Project id associated with Fabric Project
    href str
    URI of the Fabric Project
    project_id str
    Project id associated with Fabric Project
    href String
    URI of the Fabric Project
    projectId String
    Project id associated with Fabric Project

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
    equinix/pulumi-equinix