1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getRouteAggregation
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix

equinix.fabric.getRouteAggregation

Explore with Pulumi AI

equinix logo
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix

    Fabric V4 API compatible data resource that allow user to fetch Equinix Fabric Route Aggregation by UUID Additional Documentation:

    • API: https://developer.equinix.com/catalog/fabricv4#tag/Route-Aggregations

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.GetRouteAggregationArgs;
    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 raPolicy = FabricFunctions.getRouteAggregation(GetRouteAggregationArgs.builder()
                .uuid("<uuid_of_route_aggregation>")
                .build());
    
            ctx.export("id", raPolicy.applyValue(getRouteAggregationResult -> getRouteAggregationResult.id()));
            ctx.export("type", raPolicy.applyValue(getRouteAggregationResult -> getRouteAggregationResult.type()));
            ctx.export("state", raPolicy.applyValue(getRouteAggregationResult -> getRouteAggregationResult.state()));
            ctx.export("connectionsCount", raPolicy.applyValue(getRouteAggregationResult -> getRouteAggregationResult.connectionsCount()));
            ctx.export("rulesCount", raPolicy.applyValue(getRouteAggregationResult -> getRouteAggregationResult.rulesCount()));
        }
    }
    
    variables:
      raPolicy:
        fn::invoke:
          function: equinix:fabric:getRouteAggregation
          arguments:
            uuid: <uuid_of_route_aggregation>
    outputs:
      id: ${raPolicy.id}
      type: ${raPolicy.type}
      state: ${raPolicy.state}
      connectionsCount: ${raPolicy.connectionsCount}
      rulesCount: ${raPolicy.rulesCount}
    

    Using getRouteAggregation

    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 getRouteAggregation(args: GetRouteAggregationArgs, opts?: InvokeOptions): Promise<GetRouteAggregationResult>
    function getRouteAggregationOutput(args: GetRouteAggregationOutputArgs, opts?: InvokeOptions): Output<GetRouteAggregationResult>
    def get_route_aggregation(route_aggregation_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetRouteAggregationResult
    def get_route_aggregation_output(route_aggregation_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetRouteAggregationResult]
    func LookupRouteAggregation(ctx *Context, args *LookupRouteAggregationArgs, opts ...InvokeOption) (*LookupRouteAggregationResult, error)
    func LookupRouteAggregationOutput(ctx *Context, args *LookupRouteAggregationOutputArgs, opts ...InvokeOption) LookupRouteAggregationResultOutput

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

    public static class GetRouteAggregation 
    {
        public static Task<GetRouteAggregationResult> InvokeAsync(GetRouteAggregationArgs args, InvokeOptions? opts = null)
        public static Output<GetRouteAggregationResult> Invoke(GetRouteAggregationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRouteAggregationResult> getRouteAggregation(GetRouteAggregationArgs args, InvokeOptions options)
    public static Output<GetRouteAggregationResult> getRouteAggregation(GetRouteAggregationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: equinix:fabric/getRouteAggregation:getRouteAggregation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    routeAggregationId string
    The uuid of the route aggregation this data source should retrieve
    route_aggregation_id str
    The uuid of the route aggregation this data source should retrieve
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve

    getRouteAggregation Result

    The following output properties are available:

    Change GetRouteAggregationChange
    Current state of latest Route Aggregation change
    ChangeLog GetRouteAggregationChangeLog
    Details of the last change on the route aggregation resource
    ConnectionsCount int
    Number of Connections attached to route aggregation
    Description string
    Customer-provided route aggregation description
    Href string
    Equinix auto generated URI to the route aggregation resource
    Id string
    The unique identifier of the resource
    Name string
    Customer provided name of the route aggregation
    Project GetRouteAggregationProject
    Equinix Project attribute object
    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RulesCount int
    Number of Rules attached to route aggregation
    State string
    Value representing provisioning status for the route aggregation resource
    Type string
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    Uuid string
    Equinix-assigned unique id for the route aggregation resource
    Change GetRouteAggregationChange
    Current state of latest Route Aggregation change
    ChangeLog GetRouteAggregationChangeLog
    Details of the last change on the route aggregation resource
    ConnectionsCount int
    Number of Connections attached to route aggregation
    Description string
    Customer-provided route aggregation description
    Href string
    Equinix auto generated URI to the route aggregation resource
    Id string
    The unique identifier of the resource
    Name string
    Customer provided name of the route aggregation
    Project GetRouteAggregationProject
    Equinix Project attribute object
    RouteAggregationId string
    The uuid of the route aggregation this data source should retrieve
    RulesCount int
    Number of Rules attached to route aggregation
    State string
    Value representing provisioning status for the route aggregation resource
    Type string
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    Uuid string
    Equinix-assigned unique id for the route aggregation resource
    change GetRouteAggregationChange
    Current state of latest Route Aggregation change
    changeLog GetRouteAggregationChangeLog
    Details of the last change on the route aggregation resource
    connectionsCount Integer
    Number of Connections attached to route aggregation
    description String
    Customer-provided route aggregation description
    href String
    Equinix auto generated URI to the route aggregation resource
    id String
    The unique identifier of the resource
    name String
    Customer provided name of the route aggregation
    project GetRouteAggregationProject
    Equinix Project attribute object
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    rulesCount Integer
    Number of Rules attached to route aggregation
    state String
    Value representing provisioning status for the route aggregation resource
    type String
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid String
    Equinix-assigned unique id for the route aggregation resource
    change GetRouteAggregationChange
    Current state of latest Route Aggregation change
    changeLog GetRouteAggregationChangeLog
    Details of the last change on the route aggregation resource
    connectionsCount number
    Number of Connections attached to route aggregation
    description string
    Customer-provided route aggregation description
    href string
    Equinix auto generated URI to the route aggregation resource
    id string
    The unique identifier of the resource
    name string
    Customer provided name of the route aggregation
    project GetRouteAggregationProject
    Equinix Project attribute object
    routeAggregationId string
    The uuid of the route aggregation this data source should retrieve
    rulesCount number
    Number of Rules attached to route aggregation
    state string
    Value representing provisioning status for the route aggregation resource
    type string
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid string
    Equinix-assigned unique id for the route aggregation resource
    change GetRouteAggregationChange
    Current state of latest Route Aggregation change
    change_log GetRouteAggregationChangeLog
    Details of the last change on the route aggregation resource
    connections_count int
    Number of Connections attached to route aggregation
    description str
    Customer-provided route aggregation description
    href str
    Equinix auto generated URI to the route aggregation resource
    id str
    The unique identifier of the resource
    name str
    Customer provided name of the route aggregation
    project GetRouteAggregationProject
    Equinix Project attribute object
    route_aggregation_id str
    The uuid of the route aggregation this data source should retrieve
    rules_count int
    Number of Rules attached to route aggregation
    state str
    Value representing provisioning status for the route aggregation resource
    type str
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid str
    Equinix-assigned unique id for the route aggregation resource
    change Property Map
    Current state of latest Route Aggregation change
    changeLog Property Map
    Details of the last change on the route aggregation resource
    connectionsCount Number
    Number of Connections attached to route aggregation
    description String
    Customer-provided route aggregation description
    href String
    Equinix auto generated URI to the route aggregation resource
    id String
    The unique identifier of the resource
    name String
    Customer provided name of the route aggregation
    project Property Map
    Equinix Project attribute object
    routeAggregationId String
    The uuid of the route aggregation this data source should retrieve
    rulesCount Number
    Number of Rules attached to route aggregation
    state String
    Value representing provisioning status for the route aggregation resource
    type String
    Equinix defined Route Aggregation Type; BGPIPv4PREFIXAGGREGATION, BGPIPv6PREFIXAGGREGATION
    uuid String
    Equinix-assigned unique id for the route aggregation resource

    Supporting Types

    GetRouteAggregationChange

    Href string
    Equinix auto generated URI to the route aggregation change
    Type string
    Equinix defined Route Aggregation Change Type
    Uuid string
    Equinix-assigned unique id for a change
    Href string
    Equinix auto generated URI to the route aggregation change
    Type string
    Equinix defined Route Aggregation Change Type
    Uuid string
    Equinix-assigned unique id for a change
    href String
    Equinix auto generated URI to the route aggregation change
    type String
    Equinix defined Route Aggregation Change Type
    uuid String
    Equinix-assigned unique id for a change
    href string
    Equinix auto generated URI to the route aggregation change
    type string
    Equinix defined Route Aggregation Change Type
    uuid string
    Equinix-assigned unique id for a change
    href str
    Equinix auto generated URI to the route aggregation change
    type str
    Equinix defined Route Aggregation Change Type
    uuid str
    Equinix-assigned unique id for a change
    href String
    Equinix auto generated URI to the route aggregation change
    type String
    Equinix defined Route Aggregation Change Type
    uuid String
    Equinix-assigned unique id for a change

    GetRouteAggregationChangeLog

    CreatedBy string
    User name of creator of the route aggregation resource
    CreatedByEmail string
    Email of creator of the route aggregation resource
    CreatedByFullName string
    Legal name of creator of the route aggregation resource
    CreatedDateTime string
    Creation time of the route aggregation resource
    DeletedBy string
    User name of deleter of the route aggregation resource
    DeletedByEmail string
    Email of deleter of the route aggregation resource
    DeletedByFullName string
    Legal name of deleter of the route aggregation resource
    DeletedDateTime string
    Deletion time of the route aggregation resource
    UpdatedBy string
    User name of last updater of the route aggregation resource
    UpdatedByEmail string
    Email of last updater of the route aggregation resource
    UpdatedByFullName string
    Legal name of last updater of the route aggregation resource
    UpdatedDateTime string
    Last update time of the route aggregation resource
    CreatedBy string
    User name of creator of the route aggregation resource
    CreatedByEmail string
    Email of creator of the route aggregation resource
    CreatedByFullName string
    Legal name of creator of the route aggregation resource
    CreatedDateTime string
    Creation time of the route aggregation resource
    DeletedBy string
    User name of deleter of the route aggregation resource
    DeletedByEmail string
    Email of deleter of the route aggregation resource
    DeletedByFullName string
    Legal name of deleter of the route aggregation resource
    DeletedDateTime string
    Deletion time of the route aggregation resource
    UpdatedBy string
    User name of last updater of the route aggregation resource
    UpdatedByEmail string
    Email of last updater of the route aggregation resource
    UpdatedByFullName string
    Legal name of last updater of the route aggregation resource
    UpdatedDateTime string
    Last update time of the route aggregation resource
    createdBy String
    User name of creator of the route aggregation resource
    createdByEmail String
    Email of creator of the route aggregation resource
    createdByFullName String
    Legal name of creator of the route aggregation resource
    createdDateTime String
    Creation time of the route aggregation resource
    deletedBy String
    User name of deleter of the route aggregation resource
    deletedByEmail String
    Email of deleter of the route aggregation resource
    deletedByFullName String
    Legal name of deleter of the route aggregation resource
    deletedDateTime String
    Deletion time of the route aggregation resource
    updatedBy String
    User name of last updater of the route aggregation resource
    updatedByEmail String
    Email of last updater of the route aggregation resource
    updatedByFullName String
    Legal name of last updater of the route aggregation resource
    updatedDateTime String
    Last update time of the route aggregation resource
    createdBy string
    User name of creator of the route aggregation resource
    createdByEmail string
    Email of creator of the route aggregation resource
    createdByFullName string
    Legal name of creator of the route aggregation resource
    createdDateTime string
    Creation time of the route aggregation resource
    deletedBy string
    User name of deleter of the route aggregation resource
    deletedByEmail string
    Email of deleter of the route aggregation resource
    deletedByFullName string
    Legal name of deleter of the route aggregation resource
    deletedDateTime string
    Deletion time of the route aggregation resource
    updatedBy string
    User name of last updater of the route aggregation resource
    updatedByEmail string
    Email of last updater of the route aggregation resource
    updatedByFullName string
    Legal name of last updater of the route aggregation resource
    updatedDateTime string
    Last update time of the route aggregation resource
    created_by str
    User name of creator of the route aggregation resource
    created_by_email str
    Email of creator of the route aggregation resource
    created_by_full_name str
    Legal name of creator of the route aggregation resource
    created_date_time str
    Creation time of the route aggregation resource
    deleted_by str
    User name of deleter of the route aggregation resource
    deleted_by_email str
    Email of deleter of the route aggregation resource
    deleted_by_full_name str
    Legal name of deleter of the route aggregation resource
    deleted_date_time str
    Deletion time of the route aggregation resource
    updated_by str
    User name of last updater of the route aggregation resource
    updated_by_email str
    Email of last updater of the route aggregation resource
    updated_by_full_name str
    Legal name of last updater of the route aggregation resource
    updated_date_time str
    Last update time of the route aggregation resource
    createdBy String
    User name of creator of the route aggregation resource
    createdByEmail String
    Email of creator of the route aggregation resource
    createdByFullName String
    Legal name of creator of the route aggregation resource
    createdDateTime String
    Creation time of the route aggregation resource
    deletedBy String
    User name of deleter of the route aggregation resource
    deletedByEmail String
    Email of deleter of the route aggregation resource
    deletedByFullName String
    Legal name of deleter of the route aggregation resource
    deletedDateTime String
    Deletion time of the route aggregation resource
    updatedBy String
    User name of last updater of the route aggregation resource
    updatedByEmail String
    Email of last updater of the route aggregation resource
    updatedByFullName String
    Legal name of last updater of the route aggregation resource
    updatedDateTime String
    Last update time of the route aggregation resource

    GetRouteAggregationProject

    ProjectId string
    Equinix Subscriber-assigned project ID
    ProjectId string
    Equinix Subscriber-assigned project ID
    projectId String
    Equinix Subscriber-assigned project ID
    projectId string
    Equinix Subscriber-assigned project ID
    project_id str
    Equinix Subscriber-assigned project ID
    projectId String
    Equinix Subscriber-assigned project ID

    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.22.0 published on Wednesday, Apr 23, 2025 by Equinix