equinix.fabric.RouteFilter
Explore with Pulumi AI
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
Create RouteFilter Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RouteFilter(name: string, args: RouteFilterArgs, opts?: CustomResourceOptions);
@overload
def RouteFilter(resource_name: str,
args: RouteFilterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RouteFilter(resource_name: str,
opts: Optional[ResourceOptions] = None,
project: Optional[RouteFilterProjectArgs] = None,
type: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None)
func NewRouteFilter(ctx *Context, name string, args RouteFilterArgs, opts ...ResourceOption) (*RouteFilter, error)
public RouteFilter(string name, RouteFilterArgs args, CustomResourceOptions? opts = null)
public RouteFilter(String name, RouteFilterArgs args)
public RouteFilter(String name, RouteFilterArgs args, CustomResourceOptions options)
type: equinix:fabric:RouteFilter
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 RouteFilterArgs
- 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 RouteFilterArgs
- 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 RouteFilterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouteFilterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RouteFilterArgs
- 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 routeFilterResource = new Equinix.Fabric.RouteFilter("routeFilterResource", new()
{
Project = new Equinix.Fabric.Inputs.RouteFilterProjectArgs
{
ProjectId = "string",
Href = "string",
},
Type = "string",
Description = "string",
Name = "string",
});
example, err := fabric.NewRouteFilter(ctx, "routeFilterResource", &fabric.RouteFilterArgs{
Project: &fabric.RouteFilterProjectArgs{
ProjectId: pulumi.String("string"),
Href: pulumi.String("string"),
},
Type: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var routeFilterResource = new RouteFilter("routeFilterResource", RouteFilterArgs.builder()
.project(RouteFilterProjectArgs.builder()
.projectId("string")
.href("string")
.build())
.type("string")
.description("string")
.name("string")
.build());
route_filter_resource = equinix.fabric.RouteFilter("routeFilterResource",
project={
"project_id": "string",
"href": "string",
},
type="string",
description="string",
name="string")
const routeFilterResource = new equinix.fabric.RouteFilter("routeFilterResource", {
project: {
projectId: "string",
href: "string",
},
type: "string",
description: "string",
name: "string",
});
type: equinix:fabric:RouteFilter
properties:
description: string
name: string
project:
href: string
projectId: string
type: string
RouteFilter 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 RouteFilter resource accepts the following input properties:
- Project
Route
Filter Project - 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
- Type string
- Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
- Description string
- Optional description to add to the Route Filter you will be creating
- Name string
- Name of the Route Filter
- Project
Route
Filter Project Args - 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
- Type string
- Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
- Description string
- Optional description to add to the Route Filter you will be creating
- Name string
- Name of the Route Filter
- project
Route
Filter Project - 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
- type String
- Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
- description String
- Optional description to add to the Route Filter you will be creating
- name String
- Name of the Route Filter
- project
Route
Filter Project - 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
- type string
- Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
- description string
- Optional description to add to the Route Filter you will be creating
- name string
- Name of the Route Filter
- project
Route
Filter Project Args - 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
- type str
- Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
- description str
- Optional description to add to the Route Filter you will be creating
- name str
- Name of the Route Filter
- project 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
- type String
- Route Filter Type. One of [ "BGPIPv4PREFIXFILTER", "BGPIPv6PREFIXFILTER" ]
- description String
- Optional description to add to the Route Filter you will be creating
- name String
- Name of the Route Filter
Outputs
All input properties are implicitly available as output properties. Additionally, the RouteFilter resource produces the following output properties:
- Change
Logs List<RouteFilter Change Log> - Changes
List<Route
Filter Change> - 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
- Href string
- Route filter URI
- Id string
- The provider-assigned unique ID for this managed resource.
- Not
Matched stringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- Rules
Count int - The number of Route Filter Rules attached to this Route Filter
- State string
- State of the Route Filter in its lifecycle
- Uuid string
- Equinix Assigned ID for Route Filter
- Change
Logs []RouteFilter Change Log - Changes
[]Route
Filter Change - 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
- Href string
- Route filter URI
- Id string
- The provider-assigned unique ID for this managed resource.
- Not
Matched stringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- Rules
Count int - The number of Route Filter Rules attached to this Route Filter
- State string
- State of the Route Filter in its lifecycle
- Uuid string
- Equinix Assigned ID for Route Filter
- change
Logs List<RouteFilter Change Log> - changes
List<Route
Filter Change> - An object with the details of the previous change applied on the Route Filter
- connections
Count Integer - The number of Fabric Connections that this Route Filter is attached to
- href String
- Route filter URI
- id String
- The provider-assigned unique ID for this managed resource.
- not
Matched StringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- rules
Count Integer - The number of Route Filter Rules attached to this Route Filter
- state String
- State of the Route Filter in its lifecycle
- uuid String
- Equinix Assigned ID for Route Filter
- change
Logs RouteFilter Change Log[] - changes
Route
Filter Change[] - An object with the details of the previous change applied on the Route Filter
- connections
Count number - The number of Fabric Connections that this Route Filter is attached to
- href string
- Route filter URI
- id string
- The provider-assigned unique ID for this managed resource.
- not
Matched stringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- rules
Count number - The number of Route Filter Rules attached to this Route Filter
- state string
- State of the Route Filter in its lifecycle
- uuid string
- Equinix Assigned ID for Route Filter
- change_
logs Sequence[RouteFilter Change Log] - changes
Sequence[Route
Filter Change] - 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
- href str
- Route filter URI
- id str
- The provider-assigned unique ID for this managed resource.
- not_
matched_ strrule_ action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- rules_
count int - The number of Route Filter Rules attached to this Route Filter
- state str
- State of the Route Filter in its lifecycle
- uuid str
- Equinix Assigned ID for Route Filter
- change
Logs List<Property Map> - changes List<Property Map>
- An object with the details of the previous change applied on the Route Filter
- connections
Count Number - The number of Fabric Connections that this Route Filter is attached to
- href String
- Route filter URI
- id String
- The provider-assigned unique ID for this managed resource.
- not
Matched StringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- rules
Count Number - The number of Route Filter Rules attached to this Route Filter
- state String
- State of the Route Filter in its lifecycle
- uuid String
- Equinix Assigned ID for Route Filter
Look up Existing RouteFilter Resource
Get an existing RouteFilter 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?: RouteFilterState, opts?: CustomResourceOptions): RouteFilter
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
change_logs: Optional[Sequence[RouteFilterChangeLogArgs]] = None,
changes: Optional[Sequence[RouteFilterChangeArgs]] = None,
connections_count: Optional[int] = None,
description: Optional[str] = None,
href: Optional[str] = None,
name: Optional[str] = None,
not_matched_rule_action: Optional[str] = None,
project: Optional[RouteFilterProjectArgs] = None,
rules_count: Optional[int] = None,
state: Optional[str] = None,
type: Optional[str] = None,
uuid: Optional[str] = None) -> RouteFilter
func GetRouteFilter(ctx *Context, name string, id IDInput, state *RouteFilterState, opts ...ResourceOption) (*RouteFilter, error)
public static RouteFilter Get(string name, Input<string> id, RouteFilterState? state, CustomResourceOptions? opts = null)
public static RouteFilter get(String name, Output<String> id, RouteFilterState 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.
- Change
Logs List<RouteFilter Change Log> - Changes
List<Route
Filter Change> - 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 string
- Optional description to add to the Route Filter you will be creating
- Href string
- Route filter URI
- Name string
- Name of the Route Filter
- Not
Matched stringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- Project
Route
Filter Project - 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 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 []RouteFilter Change Log Args - Changes
[]Route
Filter Change Args - 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 string
- Optional description to add to the Route Filter you will be creating
- Href string
- Route filter URI
- Name string
- Name of the Route Filter
- Not
Matched stringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- Project
Route
Filter Project Args - 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 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 List<RouteFilter Change Log> - changes
List<Route
Filter Change> - An object with the details of the previous change applied on the Route Filter
- connections
Count 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
- name String
- Name of the Route Filter
- not
Matched StringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- project
Route
Filter Project - 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 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
- change
Logs RouteFilter Change Log[] - changes
Route
Filter Change[] - An object with the details of the previous change applied on the Route Filter
- connections
Count 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
- name string
- Name of the Route Filter
- not
Matched stringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- project
Route
Filter Project - 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 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[RouteFilter Change Log Args] - changes
Sequence[Route
Filter Change Args] - 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
- name str
- Name of the Route Filter
- not_
matched_ strrule_ action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- project
Route
Filter Project Args - 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
- change
Logs List<Property Map> - changes List<Property Map>
- An object with the details of the previous change applied on the Route Filter
- connections
Count 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
- name String
- Name of the Route Filter
- not
Matched StringRule Action - The action that will be taken on ip ranges that don't match the rules present within the Route Filter
- project 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
- rules
Count 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
RouteFilterChange, RouteFilterChangeArgs
- 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
RouteFilterChangeLog, RouteFilterChangeLogArgs
- Created
By string - Created by User Key
- Created
By stringEmail - Created by User Email Address
- Created
By stringFull Name - Created by User Full Name
- Created
Date stringTime - Created by Date and Time
- Deleted
By string - Deleted by User Key
- Deleted
By stringEmail - Deleted by User Email Address
- Deleted
By stringFull Name - Deleted by User Full Name
- Deleted
Date stringTime - Deleted by Date and Time
- Updated
By string - Updated by User Key
- Updated
By stringEmail - Updated by User Email Address
- Updated
By stringFull Name - Updated by User Full Name
- Updated
Date stringTime - Updated by Date and Time
- Created
By string - Created by User Key
- Created
By stringEmail - Created by User Email Address
- Created
By stringFull Name - Created by User Full Name
- Created
Date stringTime - Created by Date and Time
- Deleted
By string - Deleted by User Key
- Deleted
By stringEmail - Deleted by User Email Address
- Deleted
By stringFull Name - Deleted by User Full Name
- Deleted
Date stringTime - Deleted by Date and Time
- Updated
By string - Updated by User Key
- Updated
By stringEmail - Updated by User Email Address
- Updated
By stringFull Name - Updated by User Full Name
- Updated
Date stringTime - Updated by Date and Time
- created
By String - Created by User Key
- created
By StringEmail - Created by User Email Address
- created
By StringFull Name - Created by User Full Name
- created
Date StringTime - Created by Date and Time
- deleted
By String - Deleted by User Key
- deleted
By StringEmail - Deleted by User Email Address
- deleted
By StringFull Name - Deleted by User Full Name
- deleted
Date StringTime - Deleted by Date and Time
- updated
By String - Updated by User Key
- updated
By StringEmail - Updated by User Email Address
- updated
By StringFull Name - Updated by User Full Name
- updated
Date StringTime - Updated by Date and Time
- created
By string - Created by User Key
- created
By stringEmail - Created by User Email Address
- created
By stringFull Name - Created by User Full Name
- created
Date stringTime - Created by Date and Time
- deleted
By string - Deleted by User Key
- deleted
By stringEmail - Deleted by User Email Address
- deleted
By stringFull Name - Deleted by User Full Name
- deleted
Date stringTime - Deleted by Date and Time
- updated
By string - Updated by User Key
- updated
By stringEmail - Updated by User Email Address
- updated
By stringFull Name - Updated by User Full Name
- updated
Date stringTime - Updated by Date and Time
- created_
by str - Created by User Key
- created_
by_ stremail - Created by User Email Address
- created_
by_ strfull_ name - Created by User Full Name
- created_
date_ strtime - Created by Date and Time
- deleted_
by str - Deleted by User Key
- deleted_
by_ stremail - Deleted by User Email Address
- deleted_
by_ strfull_ name - Deleted by User Full Name
- deleted_
date_ strtime - Deleted by Date and Time
- updated_
by str - Updated by User Key
- updated_
by_ stremail - Updated by User Email Address
- updated_
by_ strfull_ name - Updated by User Full Name
- updated_
date_ strtime - Updated by Date and Time
- created
By String - Created by User Key
- created
By StringEmail - Created by User Email Address
- created
By StringFull Name - Created by User Full Name
- created
Date StringTime - Created by Date and Time
- deleted
By String - Deleted by User Key
- deleted
By StringEmail - Deleted by User Email Address
- deleted
By StringFull Name - Deleted by User Full Name
- deleted
Date StringTime - Deleted by Date and Time
- updated
By String - Updated by User Key
- updated
By StringEmail - Updated by User Email Address
- updated
By StringFull Name - Updated by User Full Name
- updated
Date StringTime - Updated by Date and Time
RouteFilterProject, RouteFilterProjectArgs
- project_
id str - Project id associated with Fabric Project
- href str
- URI of the Fabric Project
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.