Docs Packages
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getCloudRouter
Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix
equinix/pulumi-equinix

equinix.fabric.getCloudRouter

Explore with Pulumi AI

equinix logo
Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible data resource that allow user to fetch Fabric Cloud Router for a given UUID

    API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-cloud-routers

    Example Usage

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

const cloudRouterDataName = equinix.fabric.getCloudRouter({
    uuid: "<uuid_of_cloud_router>",
});

    import pulumi
import pulumi_equinix as equinix

cloud_router_data_name = equinix.fabric.get_cloud_router(uuid="<uuid_of_cloud_router>")

    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 {
		_, err := fabric.LookupCloudRouter(ctx, &fabric.LookupCloudRouterArgs{
			Uuid: "<uuid_of_cloud_router>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var cloudRouterDataName = Equinix.Fabric.GetCloudRouter.Invoke(new()
    {
        Uuid = "<uuid_of_cloud_router>",
    });

});

    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.GetCloudRouterArgs;
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 cloudRouterDataName = FabricFunctions.getCloudRouter(GetCloudRouterArgs.builder()
            .uuid("<uuid_of_cloud_router>")
            .build());

    }
}

    variables:
  cloudRouterDataName:
    fn::invoke:
      Function: equinix:fabric:getCloudRouter
      Arguments:
        uuid: <uuid_of_cloud_router>

    Using getCloudRouter

    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 getCloudRouter(args: GetCloudRouterArgs, opts?: InvokeOptions): Promise<GetCloudRouterResult>
function getCloudRouterOutput(args: GetCloudRouterOutputArgs, opts?: InvokeOptions): Output<GetCloudRouterResult>
    def get_cloud_router(uuid: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCloudRouterResult
def get_cloud_router_output(uuid: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCloudRouterResult]
    func LookupCloudRouter(ctx *Context, args *LookupCloudRouterArgs, opts ...InvokeOption) (*LookupCloudRouterResult, error)
func LookupCloudRouterOutput(ctx *Context, args *LookupCloudRouterOutputArgs, opts ...InvokeOption) LookupCloudRouterResultOutput

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

    public static class GetCloudRouter 
{
    public static Task<GetCloudRouterResult> InvokeAsync(GetCloudRouterArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudRouterResult> Invoke(GetCloudRouterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudRouterResult> getCloudRouter(GetCloudRouterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    uuid String
    Equinix-assigned Fabric Cloud Router identifier
    uuid string
    Equinix-assigned Fabric Cloud Router identifier
    uuid str
    Equinix-assigned Fabric Cloud Router identifier
    uuid String
    Equinix-assigned Fabric Cloud Router identifier

    getCloudRouter Result

    The following output properties are available:

    Accounts List<GetCloudRouterAccount>
    Customer account information that is associated with this Fabric Cloud Router
    BgpIpv4RoutesCount int
    Number of IPv4 BGP routes in use (including non-distinct prefixes)
    BgpIpv6RoutesCount int
    Number of IPv6 BGP routes in use (including non-distinct prefixes)
    ChangeLogs List<GetCloudRouterChangeLog>
    Captures Fabric Cloud Router lifecycle change information
    ConnectionsCount int
    Number of connections associated with this Fabric Cloud Router instance
    Description string
    Customer-provided Fabric Cloud Router description
    DistinctIpv4PrefixesCount int
    Number of distinct IPv4 routes
    DistinctIpv6PrefixesCount int
    Number of distinct IPv6 routes
    EquinixAsn int
    Equinix ASN
    Href string
    Fabric Cloud Router URI information
    Id string
    The provider-assigned unique ID for this managed resource.
    Locations List<GetCloudRouterLocation>
    Fabric Cloud Router location
    Name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Notifications List<GetCloudRouterNotification>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    Orders List<GetCloudRouterOrder>
    Order information related to this Fabric Cloud Router
    Packages List<GetCloudRouterPackage>
    Fabric Cloud Router Package Type
    Projects List<GetCloudRouterProject>
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    State string
    Fabric Cloud Router overall state
    Type string
    Defines the FCR type like; XF_ROUTER
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    Accounts []GetCloudRouterAccount
    Customer account information that is associated with this Fabric Cloud Router
    BgpIpv4RoutesCount int
    Number of IPv4 BGP routes in use (including non-distinct prefixes)
    BgpIpv6RoutesCount int
    Number of IPv6 BGP routes in use (including non-distinct prefixes)
    ChangeLogs []GetCloudRouterChangeLog
    Captures Fabric Cloud Router lifecycle change information
    ConnectionsCount int
    Number of connections associated with this Fabric Cloud Router instance
    Description string
    Customer-provided Fabric Cloud Router description
    DistinctIpv4PrefixesCount int
    Number of distinct IPv4 routes
    DistinctIpv6PrefixesCount int
    Number of distinct IPv6 routes
    EquinixAsn int
    Equinix ASN
    Href string
    Fabric Cloud Router URI information
    Id string
    The provider-assigned unique ID for this managed resource.
    Locations []GetCloudRouterLocation
    Fabric Cloud Router location
    Name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Notifications []GetCloudRouterNotification
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    Orders []GetCloudRouterOrder
    Order information related to this Fabric Cloud Router
    Packages []GetCloudRouterPackage
    Fabric Cloud Router Package Type
    Projects []GetCloudRouterProject
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    State string
    Fabric Cloud Router overall state
    Type string
    Defines the FCR type like; XF_ROUTER
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    accounts List<GetCloudRouterAccount>
    Customer account information that is associated with this Fabric Cloud Router
    bgpIpv4RoutesCount Integer
    Number of IPv4 BGP routes in use (including non-distinct prefixes)
    bgpIpv6RoutesCount Integer
    Number of IPv6 BGP routes in use (including non-distinct prefixes)
    changeLogs List<GetCloudRouterChangeLog>
    Captures Fabric Cloud Router lifecycle change information
    connectionsCount Integer
    Number of connections associated with this Fabric Cloud Router instance
    description String
    Customer-provided Fabric Cloud Router description
    distinctIpv4PrefixesCount Integer
    Number of distinct IPv4 routes
    distinctIpv6PrefixesCount Integer
    Number of distinct IPv6 routes
    equinixAsn Integer
    Equinix ASN
    href String
    Fabric Cloud Router URI information
    id String
    The provider-assigned unique ID for this managed resource.
    locations List<GetCloudRouterLocation>
    Fabric Cloud Router location
    name String
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    notifications List<GetCloudRouterNotification>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    orders List<GetCloudRouterOrder>
    Order information related to this Fabric Cloud Router
    packages List<GetCloudRouterPackage>
    Fabric Cloud Router Package Type
    projects List<GetCloudRouterProject>
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    state String
    Fabric Cloud Router overall state
    type String
    Defines the FCR type like; XF_ROUTER
    uuid String
    Equinix-assigned Fabric Cloud Router identifier
    accounts GetCloudRouterAccount[]
    Customer account information that is associated with this Fabric Cloud Router
    bgpIpv4RoutesCount number
    Number of IPv4 BGP routes in use (including non-distinct prefixes)
    bgpIpv6RoutesCount number
    Number of IPv6 BGP routes in use (including non-distinct prefixes)
    changeLogs GetCloudRouterChangeLog[]
    Captures Fabric Cloud Router lifecycle change information
    connectionsCount number
    Number of connections associated with this Fabric Cloud Router instance
    description string
    Customer-provided Fabric Cloud Router description
    distinctIpv4PrefixesCount number
    Number of distinct IPv4 routes
    distinctIpv6PrefixesCount number
    Number of distinct IPv6 routes
    equinixAsn number
    Equinix ASN
    href string
    Fabric Cloud Router URI information
    id string
    The provider-assigned unique ID for this managed resource.
    locations GetCloudRouterLocation[]
    Fabric Cloud Router location
    name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    notifications GetCloudRouterNotification[]
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    orders GetCloudRouterOrder[]
    Order information related to this Fabric Cloud Router
    packages GetCloudRouterPackage[]
    Fabric Cloud Router Package Type
    projects GetCloudRouterProject[]
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    state string
    Fabric Cloud Router overall state
    type string
    Defines the FCR type like; XF_ROUTER
    uuid string
    Equinix-assigned Fabric Cloud Router identifier
    accounts Sequence[GetCloudRouterAccount]
    Customer account information that is associated with this Fabric Cloud Router
    bgp_ipv4_routes_count int
    Number of IPv4 BGP routes in use (including non-distinct prefixes)
    bgp_ipv6_routes_count int
    Number of IPv6 BGP routes in use (including non-distinct prefixes)
    change_logs Sequence[GetCloudRouterChangeLog]
    Captures Fabric Cloud Router lifecycle change information
    connections_count int
    Number of connections associated with this Fabric Cloud Router instance
    description str
    Customer-provided Fabric Cloud Router description
    distinct_ipv4_prefixes_count int
    Number of distinct IPv4 routes
    distinct_ipv6_prefixes_count int
    Number of distinct IPv6 routes
    equinix_asn int
    Equinix ASN
    href str
    Fabric Cloud Router URI information
    id str
    The provider-assigned unique ID for this managed resource.
    locations Sequence[GetCloudRouterLocation]
    Fabric Cloud Router location
    name str
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    notifications Sequence[GetCloudRouterNotification]
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    orders Sequence[GetCloudRouterOrder]
    Order information related to this Fabric Cloud Router
    packages Sequence[GetCloudRouterPackage]
    Fabric Cloud Router Package Type
    projects Sequence[GetCloudRouterProject]
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    state str
    Fabric Cloud Router overall state
    type str
    Defines the FCR type like; XF_ROUTER
    uuid str
    Equinix-assigned Fabric Cloud Router identifier
    accounts List<Property Map>
    Customer account information that is associated with this Fabric Cloud Router
    bgpIpv4RoutesCount Number
    Number of IPv4 BGP routes in use (including non-distinct prefixes)
    bgpIpv6RoutesCount Number
    Number of IPv6 BGP routes in use (including non-distinct prefixes)
    changeLogs List<Property Map>
    Captures Fabric Cloud Router lifecycle change information
    connectionsCount Number
    Number of connections associated with this Fabric Cloud Router instance
    description String
    Customer-provided Fabric Cloud Router description
    distinctIpv4PrefixesCount Number
    Number of distinct IPv4 routes
    distinctIpv6PrefixesCount Number
    Number of distinct IPv6 routes
    equinixAsn Number
    Equinix ASN
    href String
    Fabric Cloud Router URI information
    id String
    The provider-assigned unique ID for this managed resource.
    locations List<Property Map>
    Fabric Cloud Router location
    name String
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    notifications List<Property Map>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    orders List<Property Map>
    Order information related to this Fabric Cloud Router
    packages List<Property Map>
    Fabric Cloud Router Package Type
    projects List<Property Map>
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    state String
    Fabric Cloud Router overall state
    type String
    Defines the FCR type like; XF_ROUTER
    uuid String
    Equinix-assigned Fabric Cloud Router identifier

    Supporting Types

    GetCloudRouterAccount

    AccountNumber int
    Account Number
    AccountNumber int
    Account Number
    accountNumber Integer
    Account Number
    accountNumber number
    Account Number
    account_number int
    Account Number
    accountNumber Number
    Account Number

    GetCloudRouterChangeLog

    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

    GetCloudRouterLocation

    Ibx string
    IBX Code
    MetroCode string
    Access point metro code
    MetroName string
    Access point metro name
    Region string
    Access point region
    Ibx string
    IBX Code
    MetroCode string
    Access point metro code
    MetroName string
    Access point metro name
    Region string
    Access point region
    ibx String
    IBX Code
    metroCode String
    Access point metro code
    metroName String
    Access point metro name
    region String
    Access point region
    ibx string
    IBX Code
    metroCode string
    Access point metro code
    metroName string
    Access point metro name
    region string
    Access point region
    ibx str
    IBX Code
    metro_code str
    Access point metro code
    metro_name str
    Access point metro name
    region str
    Access point region
    ibx String
    IBX Code
    metroCode String
    Access point metro code
    metroName String
    Access point metro name
    region String
    Access point region

    GetCloudRouterNotification

    Emails List<string>
    Array of contact emails
    Type string
    Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
    SendInterval string
    Send interval
    Emails []string
    Array of contact emails
    Type string
    Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
    SendInterval string
    Send interval
    emails List<String>
    Array of contact emails
    type String
    Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
    sendInterval String
    Send interval
    emails string[]
    Array of contact emails
    type string
    Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
    sendInterval string
    Send interval
    emails Sequence[str]
    Array of contact emails
    type str
    Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
    send_interval str
    Send interval
    emails List<String>
    Array of contact emails
    type String
    Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
    sendInterval String
    Send interval

    GetCloudRouterOrder

    BillingTier string
    Billing tier for connection bandwidth
    OrderId string
    Order Identification
    OrderNumber string
    Order Reference Number
    PurchaseOrderNumber string
    Purchase order number
    BillingTier string
    Billing tier for connection bandwidth
    OrderId string
    Order Identification
    OrderNumber string
    Order Reference Number
    PurchaseOrderNumber string
    Purchase order number
    billingTier String
    Billing tier for connection bandwidth
    orderId String
    Order Identification
    orderNumber String
    Order Reference Number
    purchaseOrderNumber String
    Purchase order number
    billingTier string
    Billing tier for connection bandwidth
    orderId string
    Order Identification
    orderNumber string
    Order Reference Number
    purchaseOrderNumber string
    Purchase order number
    billing_tier str
    Billing tier for connection bandwidth
    order_id str
    Order Identification
    order_number str
    Order Reference Number
    purchase_order_number str
    Purchase order number
    billingTier String
    Billing tier for connection bandwidth
    orderId String
    Order Identification
    orderNumber String
    Order Reference Number
    purchaseOrderNumber String
    Purchase order number

    GetCloudRouterPackage

    Code string
    Fabric Cloud Router package code
    Code string
    Fabric Cloud Router package code
    code String
    Fabric Cloud Router package code
    code string
    Fabric Cloud Router package code
    code str
    Fabric Cloud Router package code
    code String
    Fabric Cloud Router package code

    GetCloudRouterProject

    Href string
    Unique Resource URL
    ProjectId string
    Project Id
    Href string
    Unique Resource URL
    ProjectId string
    Project Id
    href String
    Unique Resource URL
    projectId String
    Project Id
    href string
    Unique Resource URL
    projectId string
    Project Id
    href str
    Unique Resource URL
    project_id str
    Project Id
    href String
    Unique Resource URL
    projectId String
    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.8.0 published on Tuesday, Apr 2, 2024 by Equinix
    equinix/pulumi-equinix