Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. ConnectionRouteFilter
Equinix v0.19.0 published on Thursday, Oct 24, 2024 by Equinix
equinix/pulumi-equinix

equinix.fabric.ConnectionRouteFilter

Explore with Pulumi AI

equinix logo
Equinix v0.19.0 published on Thursday, Oct 24, 2024 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible resource allows attachment of Route Filter Polices to Fabric Connections

    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 "@equinix-labs/pulumi-equinix";

const policyAttachment = new equinix.fabric.ConnectionRouteFilter("policyAttachment", {
    connectionId: "<connection_uuid>",
    routeFilterId: "<route_filter_policy_uuid>",
    direction: "INBOUND",
});
export const connectionRouteFilterId = policyAttachment.id;
export const connectionRouteFilterConnectionId = policyAttachment.connectionId;
export const connectionRouteFilterDirection = policyAttachment.direction;
export const connectionRouteFilterType = policyAttachment.type;
export const connectionRouteFilterAttachmentStatus = policyAttachment.attachmentStatus;

    import pulumi
import pulumi_equinix as equinix

policy_attachment = equinix.fabric.ConnectionRouteFilter("policyAttachment",
    connection_id="<connection_uuid>",
    route_filter_id="<route_filter_policy_uuid>",
    direction="INBOUND")
pulumi.export("connectionRouteFilterId", policy_attachment.id)
pulumi.export("connectionRouteFilterConnectionId", policy_attachment.connection_id)
pulumi.export("connectionRouteFilterDirection", policy_attachment.direction)
pulumi.export("connectionRouteFilterType", policy_attachment.type)
pulumi.export("connectionRouteFilterAttachmentStatus", policy_attachment.attachment_status)

    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 {
		policyAttachment, err := fabric.NewConnectionRouteFilter(ctx, "policyAttachment", &fabric.ConnectionRouteFilterArgs{
			ConnectionId:  pulumi.String("<connection_uuid>"),
			RouteFilterId: pulumi.String("<route_filter_policy_uuid>"),
			Direction:     pulumi.String("INBOUND"),
		})
		if err != nil {
			return err
		}
		ctx.Export("connectionRouteFilterId", policyAttachment.ID())
		ctx.Export("connectionRouteFilterConnectionId", policyAttachment.ConnectionId)
		ctx.Export("connectionRouteFilterDirection", policyAttachment.Direction)
		ctx.Export("connectionRouteFilterType", policyAttachment.Type)
		ctx.Export("connectionRouteFilterAttachmentStatus", policyAttachment.AttachmentStatus)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var policyAttachment = new Equinix.Fabric.ConnectionRouteFilter("policyAttachment", new()
    {
        ConnectionId = "<connection_uuid>",
        RouteFilterId = "<route_filter_policy_uuid>",
        Direction = "INBOUND",
    });

    return new Dictionary<string, object?>
    {
        ["connectionRouteFilterId"] = policyAttachment.Id,
        ["connectionRouteFilterConnectionId"] = policyAttachment.ConnectionId,
        ["connectionRouteFilterDirection"] = policyAttachment.Direction,
        ["connectionRouteFilterType"] = policyAttachment.Type,
        ["connectionRouteFilterAttachmentStatus"] = policyAttachment.AttachmentStatus,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.ConnectionRouteFilter;
import com.pulumi.equinix.fabric.ConnectionRouteFilterArgs;
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) {
        var policyAttachment = new ConnectionRouteFilter("policyAttachment", ConnectionRouteFilterArgs.builder()
            .connectionId("<connection_uuid>")
            .routeFilterId("<route_filter_policy_uuid>")
            .direction("INBOUND")
            .build());

        ctx.export("connectionRouteFilterId", policyAttachment.id());
        ctx.export("connectionRouteFilterConnectionId", policyAttachment.connectionId());
        ctx.export("connectionRouteFilterDirection", policyAttachment.direction());
        ctx.export("connectionRouteFilterType", policyAttachment.type());
        ctx.export("connectionRouteFilterAttachmentStatus", policyAttachment.attachmentStatus());
    }
}

    resources:
  policyAttachment:
    type: equinix:fabric:ConnectionRouteFilter
    properties:
      connectionId: <connection_uuid>
      routeFilterId: <route_filter_policy_uuid>
      direction: INBOUND
outputs:
  connectionRouteFilterId: ${policyAttachment.id}
  connectionRouteFilterConnectionId: ${policyAttachment.connectionId}
  connectionRouteFilterDirection: ${policyAttachment.direction}
  connectionRouteFilterType: ${policyAttachment.type}
  connectionRouteFilterAttachmentStatus: ${policyAttachment.attachmentStatus}

    Create ConnectionRouteFilter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConnectionRouteFilter(name: string, args: ConnectionRouteFilterArgs, opts?: CustomResourceOptions);
    @overload
def ConnectionRouteFilter(resource_name: str,
                          args: ConnectionRouteFilterArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ConnectionRouteFilter(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          connection_id: Optional[str] = None,
                          direction: Optional[str] = None,
                          route_filter_id: Optional[str] = None)
    func NewConnectionRouteFilter(ctx *Context, name string, args ConnectionRouteFilterArgs, opts ...ResourceOption) (*ConnectionRouteFilter, error)
    public ConnectionRouteFilter(string name, ConnectionRouteFilterArgs args, CustomResourceOptions? opts = null)
    public ConnectionRouteFilter(String name, ConnectionRouteFilterArgs args)
public ConnectionRouteFilter(String name, ConnectionRouteFilterArgs args, CustomResourceOptions options)

    type: equinix:fabric:ConnectionRouteFilter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ConnectionRouteFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectionRouteFilterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectionRouteFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionRouteFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionRouteFilterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var connectionRouteFilterResource = new Equinix.Fabric.ConnectionRouteFilter("connectionRouteFilterResource", new()
{
    ConnectionId = "string",
    Direction = "string",
    RouteFilterId = "string",
});

    example, err := fabric.NewConnectionRouteFilter(ctx, "connectionRouteFilterResource", &fabric.ConnectionRouteFilterArgs{
	ConnectionId:  pulumi.String("string"),
	Direction:     pulumi.String("string"),
	RouteFilterId: pulumi.String("string"),
})

    var connectionRouteFilterResource = new ConnectionRouteFilter("connectionRouteFilterResource", ConnectionRouteFilterArgs.builder()
    .connectionId("string")
    .direction("string")
    .routeFilterId("string")
    .build());

    connection_route_filter_resource = equinix.fabric.ConnectionRouteFilter("connectionRouteFilterResource",
    connection_id="string",
    direction="string",
    route_filter_id="string")

    const connectionRouteFilterResource = new equinix.fabric.ConnectionRouteFilter("connectionRouteFilterResource", {
    connectionId: "string",
    direction: "string",
    routeFilterId: "string",
});

    type: equinix:fabric:ConnectionRouteFilter
properties:
    connectionId: string
    direction: string
    routeFilterId: string

    ConnectionRouteFilter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ConnectionRouteFilter resource accepts the following input properties:

    ConnectionId string
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    Direction string
    Direction of the filtering of the attached Route Filter Policy
    RouteFilterId string
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    ConnectionId string
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    Direction string
    Direction of the filtering of the attached Route Filter Policy
    RouteFilterId string
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    connectionId String
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction String
    Direction of the filtering of the attached Route Filter Policy
    routeFilterId String
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    connectionId string
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction string
    Direction of the filtering of the attached Route Filter Policy
    routeFilterId string
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    connection_id str
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction str
    Direction of the filtering of the attached Route Filter Policy
    route_filter_id str
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    connectionId String
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction String
    Direction of the filtering of the attached Route Filter Policy
    routeFilterId String
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConnectionRouteFilter resource produces the following output properties:

    AttachmentStatus string
    Status of the Route Filter Policy attachment lifecycle
    Href string
    URI to the attached Route Filter Policy on the Connection
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    Uuid string
    Equinix Assigned ID for Route Filter Policy
    AttachmentStatus string
    Status of the Route Filter Policy attachment lifecycle
    Href string
    URI to the attached Route Filter Policy on the Connection
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    Uuid string
    Equinix Assigned ID for Route Filter Policy
    attachmentStatus String
    Status of the Route Filter Policy attachment lifecycle
    href String
    URI to the attached Route Filter Policy on the Connection
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid String
    Equinix Assigned ID for Route Filter Policy
    attachmentStatus string
    Status of the Route Filter Policy attachment lifecycle
    href string
    URI to the attached Route Filter Policy on the Connection
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid string
    Equinix Assigned ID for Route Filter Policy
    attachment_status str
    Status of the Route Filter Policy attachment lifecycle
    href str
    URI to the attached Route Filter Policy on the Connection
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid str
    Equinix Assigned ID for Route Filter Policy
    attachmentStatus String
    Status of the Route Filter Policy attachment lifecycle
    href String
    URI to the attached Route Filter Policy on the Connection
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid String
    Equinix Assigned ID for Route Filter Policy

    Look up Existing ConnectionRouteFilter Resource

    Get an existing ConnectionRouteFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConnectionRouteFilterState, opts?: CustomResourceOptions): ConnectionRouteFilter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attachment_status: Optional[str] = None,
        connection_id: Optional[str] = None,
        direction: Optional[str] = None,
        href: Optional[str] = None,
        route_filter_id: Optional[str] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> ConnectionRouteFilter
    func GetConnectionRouteFilter(ctx *Context, name string, id IDInput, state *ConnectionRouteFilterState, opts ...ResourceOption) (*ConnectionRouteFilter, error)
    public static ConnectionRouteFilter Get(string name, Input<string> id, ConnectionRouteFilterState? state, CustomResourceOptions? opts = null)
    public static ConnectionRouteFilter get(String name, Output<String> id, ConnectionRouteFilterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AttachmentStatus string
    Status of the Route Filter Policy attachment lifecycle
    ConnectionId string
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    Direction string
    Direction of the filtering of the attached Route Filter Policy
    Href string
    URI to the attached Route Filter Policy on the Connection
    RouteFilterId string
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    Type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    Uuid string
    Equinix Assigned ID for Route Filter Policy
    AttachmentStatus string
    Status of the Route Filter Policy attachment lifecycle
    ConnectionId string
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    Direction string
    Direction of the filtering of the attached Route Filter Policy
    Href string
    URI to the attached Route Filter Policy on the Connection
    RouteFilterId string
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    Type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    Uuid string
    Equinix Assigned ID for Route Filter Policy
    attachmentStatus String
    Status of the Route Filter Policy attachment lifecycle
    connectionId String
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction String
    Direction of the filtering of the attached Route Filter Policy
    href String
    URI to the attached Route Filter Policy on the Connection
    routeFilterId String
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    type String
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid String
    Equinix Assigned ID for Route Filter Policy
    attachmentStatus string
    Status of the Route Filter Policy attachment lifecycle
    connectionId string
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction string
    Direction of the filtering of the attached Route Filter Policy
    href string
    URI to the attached Route Filter Policy on the Connection
    routeFilterId string
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    type string
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid string
    Equinix Assigned ID for Route Filter Policy
    attachment_status str
    Status of the Route Filter Policy attachment lifecycle
    connection_id str
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction str
    Direction of the filtering of the attached Route Filter Policy
    href str
    URI to the attached Route Filter Policy on the Connection
    route_filter_id str
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    type str
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid str
    Equinix Assigned ID for Route Filter Policy
    attachmentStatus String
    Status of the Route Filter Policy attachment lifecycle
    connectionId String
    Equinix Assigned UUID of the Equinix Connection to attach the Route Filter Policy to
    direction String
    Direction of the filtering of the attached Route Filter Policy
    href String
    URI to the attached Route Filter Policy on the Connection
    routeFilterId String
    Equinix Assigned UUID of the Route Filter Policy to attach to the Equinix Connection
    type String
    Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
    uuid String
    Equinix Assigned ID for Route Filter Policy

    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.19.0 published on Thursday, Oct 24, 2024 by Equinix
    equinix/pulumi-equinix