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

equinix.fabric.getRouteFilterRule

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-filter-rules

    Example Usage

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

const rfRule = equinix.fabric.getRouteFilterRule({
    routeFilterId: "<route_filter_policy_id>",
    uuid: "<route_filter_rule_uuid>",
});
export const routeFilterRuleName = rfRule.then(rfRule => rfRule.name);
export const routeFilterRuleDescription = rfRule.then(rfRule => rfRule.description);
export const routeFilterRulePrefix = rfRule.then(rfRule => rfRule.prefix);
export const routeFilterRulePrefixMatch = rfRule.then(rfRule => rfRule.prefixMatch);

    import pulumi
import pulumi_equinix as equinix

rf_rule = equinix.fabric.get_route_filter_rule(route_filter_id="<route_filter_policy_id>",
    uuid="<route_filter_rule_uuid>")
pulumi.export("routeFilterRuleName", rf_rule.name)
pulumi.export("routeFilterRuleDescription", rf_rule.description)
pulumi.export("routeFilterRulePrefix", rf_rule.prefix)
pulumi.export("routeFilterRulePrefixMatch", rf_rule.prefix_match)

    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 {
		rfRule, err := fabric.LookupRouteFilterRule(ctx, &fabric.LookupRouteFilterRuleArgs{
			RouteFilterId: "<route_filter_policy_id>",
			Uuid:          "<route_filter_rule_uuid>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("routeFilterRuleName", rfRule.Name)
		ctx.Export("routeFilterRuleDescription", rfRule.Description)
		ctx.Export("routeFilterRulePrefix", rfRule.Prefix)
		ctx.Export("routeFilterRulePrefixMatch", rfRule.PrefixMatch)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var rfRule = Equinix.Fabric.GetRouteFilterRule.Invoke(new()
    {
        RouteFilterId = "<route_filter_policy_id>",
        Uuid = "<route_filter_rule_uuid>",
    });

    return new Dictionary<string, object?>
    {
        ["routeFilterRuleName"] = rfRule.Apply(getRouteFilterRuleResult => getRouteFilterRuleResult.Name),
        ["routeFilterRuleDescription"] = rfRule.Apply(getRouteFilterRuleResult => getRouteFilterRuleResult.Description),
        ["routeFilterRulePrefix"] = rfRule.Apply(getRouteFilterRuleResult => getRouteFilterRuleResult.Prefix),
        ["routeFilterRulePrefixMatch"] = rfRule.Apply(getRouteFilterRuleResult => getRouteFilterRuleResult.PrefixMatch),
    };
});

    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.GetRouteFilterRuleArgs;
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 rfRule = FabricFunctions.getRouteFilterRule(GetRouteFilterRuleArgs.builder()
            .routeFilterId("<route_filter_policy_id>")
            .uuid("<route_filter_rule_uuid>")
            .build());

        ctx.export("routeFilterRuleName", rfRule.applyValue(getRouteFilterRuleResult -> getRouteFilterRuleResult.name()));
        ctx.export("routeFilterRuleDescription", rfRule.applyValue(getRouteFilterRuleResult -> getRouteFilterRuleResult.description()));
        ctx.export("routeFilterRulePrefix", rfRule.applyValue(getRouteFilterRuleResult -> getRouteFilterRuleResult.prefix()));
        ctx.export("routeFilterRulePrefixMatch", rfRule.applyValue(getRouteFilterRuleResult -> getRouteFilterRuleResult.prefixMatch()));
    }
}

    variables:
  rfRule:
    fn::invoke:
      Function: equinix:fabric:getRouteFilterRule
      Arguments:
        routeFilterId: <route_filter_policy_id>
        uuid: <route_filter_rule_uuid>
outputs:
  routeFilterRuleName: ${rfRule.name}
  routeFilterRuleDescription: ${rfRule.description}
  routeFilterRulePrefix: ${rfRule.prefix}
  routeFilterRulePrefixMatch: ${rfRule.prefixMatch}

    Using getRouteFilterRule

    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 getRouteFilterRule(args: GetRouteFilterRuleArgs, opts?: InvokeOptions): Promise<GetRouteFilterRuleResult>
function getRouteFilterRuleOutput(args: GetRouteFilterRuleOutputArgs, opts?: InvokeOptions): Output<GetRouteFilterRuleResult>
    def get_route_filter_rule(route_filter_id: Optional[str] = None,
                          uuid: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRouteFilterRuleResult
def get_route_filter_rule_output(route_filter_id: Optional[pulumi.Input[str]] = None,
                          uuid: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRouteFilterRuleResult]
    func LookupRouteFilterRule(ctx *Context, args *LookupRouteFilterRuleArgs, opts ...InvokeOption) (*LookupRouteFilterRuleResult, error)
func LookupRouteFilterRuleOutput(ctx *Context, args *LookupRouteFilterRuleOutputArgs, opts ...InvokeOption) LookupRouteFilterRuleResultOutput

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

    public static class GetRouteFilterRule 
{
    public static Task<GetRouteFilterRuleResult> InvokeAsync(GetRouteFilterRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteFilterRuleResult> Invoke(GetRouteFilterRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteFilterRuleResult> getRouteFilterRule(GetRouteFilterRuleArgs args, InvokeOptions options)
public static Output<GetRouteFilterRuleResult> getRouteFilterRule(GetRouteFilterRuleArgs args, InvokeOptions options)

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

    The following arguments are supported:

    RouteFilterId string
    UUID of the Route Filter Policy the rule is attached to
    Uuid string
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    RouteFilterId string
    UUID of the Route Filter Policy the rule is attached to
    Uuid string
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    routeFilterId String
    UUID of the Route Filter Policy the rule is attached to
    uuid String
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    routeFilterId string
    UUID of the Route Filter Policy the rule is attached to
    uuid string
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    route_filter_id str
    UUID of the Route Filter Policy the rule is attached to
    uuid str
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    routeFilterId String
    UUID of the Route Filter Policy the rule is attached to
    uuid String
    Equinix Assigned ID for Route Filter Rule to retrieve data for

    getRouteFilterRule Result

    The following output properties are available:

    Action string
    Action that will be taken on IP Addresses matching the rule
    ChangeLogs List<GetRouteFilterRuleChangeLog>
    Changes List<GetRouteFilterRuleChange>
    An object with the details of the previous change applied on the Route Filter
    Description string
    Optional description to add to the Route Filter you will be creating
    Href string
    Route filter rules URI
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the Route Filter
    Prefix string
    IP Address Prefix to Filter on
    PrefixMatch string
    Prefix matching operator. One of [ orlonger, exact ] Default: "orlonger"
    RouteFilterId string
    UUID of the Route Filter Policy the rule is attached to
    State string
    State of the Route Filter Rule in its lifecycle
    Type string
    Route Filter Type. One of [ BGPIPv4PREFIXFILTERRULE, BGPIPv6PREFIXFILTERRULE ]
    Uuid string
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    Action string
    Action that will be taken on IP Addresses matching the rule
    ChangeLogs []GetRouteFilterRuleChangeLog
    Changes []GetRouteFilterRuleChange
    An object with the details of the previous change applied on the Route Filter
    Description string
    Optional description to add to the Route Filter you will be creating
    Href string
    Route filter rules URI
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the Route Filter
    Prefix string
    IP Address Prefix to Filter on
    PrefixMatch string
    Prefix matching operator. One of [ orlonger, exact ] Default: "orlonger"
    RouteFilterId string
    UUID of the Route Filter Policy the rule is attached to
    State string
    State of the Route Filter Rule in its lifecycle
    Type string
    Route Filter Type. One of [ BGPIPv4PREFIXFILTERRULE, BGPIPv6PREFIXFILTERRULE ]
    Uuid string
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    action String
    Action that will be taken on IP Addresses matching the rule
    changeLogs List<GetRouteFilterRuleChangeLog>
    changes List<GetRouteFilterRuleChange>
    An object with the details of the previous change applied on the Route Filter
    description String
    Optional description to add to the Route Filter you will be creating
    href String
    Route filter rules URI
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the Route Filter
    prefix String
    IP Address Prefix to Filter on
    prefixMatch String
    Prefix matching operator. One of [ orlonger, exact ] Default: "orlonger"
    routeFilterId String
    UUID of the Route Filter Policy the rule is attached to
    state String
    State of the Route Filter Rule in its lifecycle
    type String
    Route Filter Type. One of [ BGPIPv4PREFIXFILTERRULE, BGPIPv6PREFIXFILTERRULE ]
    uuid String
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    action string
    Action that will be taken on IP Addresses matching the rule
    changeLogs GetRouteFilterRuleChangeLog[]
    changes GetRouteFilterRuleChange[]
    An object with the details of the previous change applied on the Route Filter
    description string
    Optional description to add to the Route Filter you will be creating
    href string
    Route filter rules URI
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the Route Filter
    prefix string
    IP Address Prefix to Filter on
    prefixMatch string
    Prefix matching operator. One of [ orlonger, exact ] Default: "orlonger"
    routeFilterId string
    UUID of the Route Filter Policy the rule is attached to
    state string
    State of the Route Filter Rule in its lifecycle
    type string
    Route Filter Type. One of [ BGPIPv4PREFIXFILTERRULE, BGPIPv6PREFIXFILTERRULE ]
    uuid string
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    action str
    Action that will be taken on IP Addresses matching the rule
    change_logs Sequence[GetRouteFilterRuleChangeLog]
    changes Sequence[GetRouteFilterRuleChange]
    An object with the details of the previous change applied on the Route Filter
    description str
    Optional description to add to the Route Filter you will be creating
    href str
    Route filter rules URI
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the Route Filter
    prefix str
    IP Address Prefix to Filter on
    prefix_match str
    Prefix matching operator. One of [ orlonger, exact ] Default: "orlonger"
    route_filter_id str
    UUID of the Route Filter Policy the rule is attached to
    state str
    State of the Route Filter Rule in its lifecycle
    type str
    Route Filter Type. One of [ BGPIPv4PREFIXFILTERRULE, BGPIPv6PREFIXFILTERRULE ]
    uuid str
    Equinix Assigned ID for Route Filter Rule to retrieve data for
    action String
    Action that will be taken on IP Addresses matching the rule
    changeLogs List<Property Map>
    changes List<Property Map>
    An object with the details of the previous change applied on the Route Filter
    description String
    Optional description to add to the Route Filter you will be creating
    href String
    Route filter rules URI
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the Route Filter
    prefix String
    IP Address Prefix to Filter on
    prefixMatch String
    Prefix matching operator. One of [ orlonger, exact ] Default: "orlonger"
    routeFilterId String
    UUID of the Route Filter Policy the rule is attached to
    state String
    State of the Route Filter Rule in its lifecycle
    type String
    Route Filter Type. One of [ BGPIPv4PREFIXFILTERRULE, BGPIPv6PREFIXFILTERRULE ]
    uuid String
    Equinix Assigned ID for Route Filter Rule to retrieve data for

    Supporting Types

    GetRouteFilterRuleChange

    Href string
    The URI of the previous Route Filter Rule Change
    Type string
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE","BGP_IPv4_PREFIX_FILTER_RULE_CREATION","BGP_IPv4_PREFIX_FILTER_RULE_DELETION","BGP_IPv6_PREFIX_FILTER_RULE_UPDATE","BGP_IPv6_PREFIX_FILTER_RULE_CREATION","BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ]
    Uuid string
    Unique identifier for the previous change
    Href string
    The URI of the previous Route Filter Rule Change
    Type string
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE","BGP_IPv4_PREFIX_FILTER_RULE_CREATION","BGP_IPv4_PREFIX_FILTER_RULE_DELETION","BGP_IPv6_PREFIX_FILTER_RULE_UPDATE","BGP_IPv6_PREFIX_FILTER_RULE_CREATION","BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ]
    Uuid string
    Unique identifier for the previous change
    href String
    The URI of the previous Route Filter Rule Change
    type String
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE","BGP_IPv4_PREFIX_FILTER_RULE_CREATION","BGP_IPv4_PREFIX_FILTER_RULE_DELETION","BGP_IPv6_PREFIX_FILTER_RULE_UPDATE","BGP_IPv6_PREFIX_FILTER_RULE_CREATION","BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ]
    uuid String
    Unique identifier for the previous change
    href string
    The URI of the previous Route Filter Rule Change
    type string
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE","BGP_IPv4_PREFIX_FILTER_RULE_CREATION","BGP_IPv4_PREFIX_FILTER_RULE_DELETION","BGP_IPv6_PREFIX_FILTER_RULE_UPDATE","BGP_IPv6_PREFIX_FILTER_RULE_CREATION","BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ]
    uuid string
    Unique identifier for the previous change
    href str
    The URI of the previous Route Filter Rule Change
    type str
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE","BGP_IPv4_PREFIX_FILTER_RULE_CREATION","BGP_IPv4_PREFIX_FILTER_RULE_DELETION","BGP_IPv6_PREFIX_FILTER_RULE_UPDATE","BGP_IPv6_PREFIX_FILTER_RULE_CREATION","BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ]
    uuid str
    Unique identifier for the previous change
    href String
    The URI of the previous Route Filter Rule Change
    type String
    Type of change. One of [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE","BGP_IPv4_PREFIX_FILTER_RULE_CREATION","BGP_IPv4_PREFIX_FILTER_RULE_DELETION","BGP_IPv6_PREFIX_FILTER_RULE_UPDATE","BGP_IPv6_PREFIX_FILTER_RULE_CREATION","BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ]
    uuid String
    Unique identifier for the previous change

    GetRouteFilterRuleChangeLog

    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

    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