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

equinix.fabric.CloudRouter

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 resource allows creation and management of Equinix Fabric Cloud Router.

    Additional Fabric Cloud Router documentation:

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var metro = config.Get("metro") ?? "FR";
    var accountNum = config.RequireInt32("accountNum");
    var router = new Equinix.Fabric.CloudRouter("router", new()
    {
        Name = "My-Fabric-Cloud-Router",
        Type = "XF_ROUTER",
        Location = new Equinix.Fabric.Inputs.CloudRouterLocationArgs
        {
            MetroCode = metro,
        },
        Package = new Equinix.Fabric.Inputs.CloudRouterPackageArgs
        {
            Code = "BASIC",
        },
        Notifications = new[]
        {
            new Equinix.Fabric.Inputs.CloudRouterNotificationArgs
            {
                Type = "ALL",
                Emails = new[]
                {
                    "example@equinix.com",
                },
            },
        },
        Account = new Equinix.Fabric.Inputs.CloudRouterAccountArgs
        {
            AccountNumber = 272010,
        },
    });

    return new Dictionary<string, object?>
    {
        ["routerId"] = router.Id,
    };
});

    package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/fabric"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		metro := "FR"
		if param := cfg.Get("metro"); param != "" {
			metro = param
		}
		accountNum := cfg.RequireInt("accountNum")
		router, err := fabric.NewCloudRouter(ctx, "router", &fabric.CloudRouterArgs{
			Name: pulumi.String("My-Fabric-Cloud-Router"),
			Type: pulumi.String("XF_ROUTER"),
			Location: &fabric.CloudRouterLocationArgs{
				MetroCode: pulumi.String(metro),
			},
			Package: &fabric.CloudRouterPackageArgs{
				Code: pulumi.String("BASIC"),
			},
			Notifications: fabric.CloudRouterNotificationArray{
				&fabric.CloudRouterNotificationArgs{
					Type: pulumi.String("ALL"),
					Emails: pulumi.StringArray{
						pulumi.String("example@equinix.com"),
					},
				},
			},
			Account: &fabric.CloudRouterAccountArgs{
				AccountNumber: pulumi.Int(272010),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("routerId", router.ID())
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.CloudRouter;
import com.pulumi.equinix.fabric.CloudRouterArgs;
import com.pulumi.equinix.fabric.inputs.CloudRouterLocationArgs;
import com.pulumi.equinix.fabric.inputs.CloudRouterPackageArgs;
import com.pulumi.equinix.fabric.inputs.CloudRouterNotificationArgs;
import com.pulumi.equinix.fabric.inputs.CloudRouterAccountArgs;
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 config = ctx.config();
        final var metro = config.get("metro").orElse("FR");
        final var accountNum = config.get("accountNum");
        var router = new CloudRouter("router", CloudRouterArgs.builder()        
            .name("My-Fabric-Cloud-Router")
            .type("XF_ROUTER")
            .location(CloudRouterLocationArgs.builder()
                .metroCode(metro)
                .build())
            .package_(CloudRouterPackageArgs.builder()
                .code("BASIC")
                .build())
            .notifications(CloudRouterNotificationArgs.builder()
                .type("ALL")
                .emails("example@equinix.com")
                .build())
            .account(CloudRouterAccountArgs.builder()
                .accountNumber(272010)
                .build())
            .build());

        ctx.export("routerId", router.id());
    }
}

    import pulumi
import pulumi_equinix as equinix

config = pulumi.Config()
metro = config.get("metro")
if metro is None:
    metro = "FR"
account_num = config.require_int("accountNum")
router = equinix.fabric.CloudRouter("router",
    name="My-Fabric-Cloud-Router",
    type="XF_ROUTER",
    location=equinix.fabric.CloudRouterLocationArgs(
        metro_code=metro,
    ),
    package=equinix.fabric.CloudRouterPackageArgs(
        code="BASIC",
    ),
    notifications=[equinix.fabric.CloudRouterNotificationArgs(
        type="ALL",
        emails=["example@equinix.com"],
    )],
    account=equinix.fabric.CloudRouterAccountArgs(
        account_number=272010,
    ))
pulumi.export("routerId", router.id)

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

const config = new pulumi.Config();
const metro = config.get("metro") || "FR";
const accountNum = config.requireNumber("accountNum");
const router = new equinix.fabric.CloudRouter("router", {
    name: "My-Fabric-Cloud-Router",
    type: "XF_ROUTER",
    location: {
        metroCode: metro,
    },
    "package": {
        code: "BASIC",
    },
    notifications: [{
        type: "ALL",
        emails: ["example@equinix.com"],
    }],
    account: {
        accountNumber: 272010,
    },
});
export const routerId = router.id;

    config:
  metro:
    type: string
    default: FR
  accountNum:
    type: integer
resources:
  router:
    type: equinix:fabric:CloudRouter
    properties:
      name: My-Fabric-Cloud-Router
      type: XF_ROUTER
      location:
        metroCode: ${metro}
      package:
        code: BASIC
      notifications:
      - type: ALL
        emails:
        - example@equinix.com
      account:
        accountNumber: 272010
outputs:
  routerId: ${router.id}

    Create CloudRouter Resource

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

    Constructor syntax

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

@overload
def CloudRouter(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                account: Optional[CloudRouterAccountArgs] = None,
                location: Optional[CloudRouterLocationArgs] = None,
                notifications: Optional[Sequence[CloudRouterNotificationArgs]] = None,
                order: Optional[CloudRouterOrderArgs] = None,
                package: Optional[CloudRouterPackageArgs] = None,
                project: Optional[CloudRouterProjectArgs] = None,
                type: Optional[str] = None,
                description: Optional[str] = None,
                href: Optional[str] = None,
                name: Optional[str] = None,
                uuid: Optional[str] = None)
    func NewCloudRouter(ctx *Context, name string, args CloudRouterArgs, opts ...ResourceOption) (*CloudRouter, error)
    public CloudRouter(string name, CloudRouterArgs args, CustomResourceOptions? opts = null)
    public CloudRouter(String name, CloudRouterArgs args)
public CloudRouter(String name, CloudRouterArgs args, CustomResourceOptions options)

    type: equinix:fabric:CloudRouter
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 CloudRouterArgs
    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 CloudRouterArgs
    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 CloudRouterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudRouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudRouterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var cloudRouterResource = new Equinix.Fabric.CloudRouter("cloudRouterResource", new()
{
    Account = new Equinix.Fabric.Inputs.CloudRouterAccountArgs
    {
        AccountNumber = 0,
    },
    Location = new Equinix.Fabric.Inputs.CloudRouterLocationArgs
    {
        Ibx = "string",
        MetroCode = "string",
        MetroName = "string",
        Region = "string",
    },
    Notifications = new[]
    {
        new Equinix.Fabric.Inputs.CloudRouterNotificationArgs
        {
            Emails = new[]
            {
                "string",
            },
            Type = "string",
            SendInterval = "string",
        },
    },
    Order = new Equinix.Fabric.Inputs.CloudRouterOrderArgs
    {
        BillingTier = "string",
        OrderId = "string",
        OrderNumber = "string",
        PurchaseOrderNumber = "string",
    },
    Package = new Equinix.Fabric.Inputs.CloudRouterPackageArgs
    {
        Code = "string",
    },
    Project = new Equinix.Fabric.Inputs.CloudRouterProjectArgs
    {
        Href = "string",
        ProjectId = "string",
    },
    Type = "string",
    Description = "string",
    Href = "string",
    Name = "string",
    Uuid = "string",
});

    example, err := fabric.NewCloudRouter(ctx, "cloudRouterResource", &fabric.CloudRouterArgs{
	Account: &fabric.CloudRouterAccountArgs{
		AccountNumber: pulumi.Int(0),
	},
	Location: &fabric.CloudRouterLocationArgs{
		Ibx:       pulumi.String("string"),
		MetroCode: pulumi.String("string"),
		MetroName: pulumi.String("string"),
		Region:    pulumi.String("string"),
	},
	Notifications: fabric.CloudRouterNotificationArray{
		&fabric.CloudRouterNotificationArgs{
			Emails: pulumi.StringArray{
				pulumi.String("string"),
			},
			Type:         pulumi.String("string"),
			SendInterval: pulumi.String("string"),
		},
	},
	Order: &fabric.CloudRouterOrderArgs{
		BillingTier:         pulumi.String("string"),
		OrderId:             pulumi.String("string"),
		OrderNumber:         pulumi.String("string"),
		PurchaseOrderNumber: pulumi.String("string"),
	},
	Package: &fabric.CloudRouterPackageArgs{
		Code: pulumi.String("string"),
	},
	Project: &fabric.CloudRouterProjectArgs{
		Href:      pulumi.String("string"),
		ProjectId: pulumi.String("string"),
	},
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Href:        pulumi.String("string"),
	Name:        pulumi.String("string"),
	Uuid:        pulumi.String("string"),
})

    var cloudRouterResource = new CloudRouter("cloudRouterResource", CloudRouterArgs.builder()        
    .account(CloudRouterAccountArgs.builder()
        .accountNumber(0)
        .build())
    .location(CloudRouterLocationArgs.builder()
        .ibx("string")
        .metroCode("string")
        .metroName("string")
        .region("string")
        .build())
    .notifications(CloudRouterNotificationArgs.builder()
        .emails("string")
        .type("string")
        .sendInterval("string")
        .build())
    .order(CloudRouterOrderArgs.builder()
        .billingTier("string")
        .orderId("string")
        .orderNumber("string")
        .purchaseOrderNumber("string")
        .build())
    .package_(CloudRouterPackageArgs.builder()
        .code("string")
        .build())
    .project(CloudRouterProjectArgs.builder()
        .href("string")
        .projectId("string")
        .build())
    .type("string")
    .description("string")
    .href("string")
    .name("string")
    .uuid("string")
    .build());

    cloud_router_resource = equinix.fabric.CloudRouter("cloudRouterResource",
    account=equinix.fabric.CloudRouterAccountArgs(
        account_number=0,
    ),
    location=equinix.fabric.CloudRouterLocationArgs(
        ibx="string",
        metro_code="string",
        metro_name="string",
        region="string",
    ),
    notifications=[equinix.fabric.CloudRouterNotificationArgs(
        emails=["string"],
        type="string",
        send_interval="string",
    )],
    order=equinix.fabric.CloudRouterOrderArgs(
        billing_tier="string",
        order_id="string",
        order_number="string",
        purchase_order_number="string",
    ),
    package=equinix.fabric.CloudRouterPackageArgs(
        code="string",
    ),
    project=equinix.fabric.CloudRouterProjectArgs(
        href="string",
        project_id="string",
    ),
    type="string",
    description="string",
    href="string",
    name="string",
    uuid="string")

    const cloudRouterResource = new equinix.fabric.CloudRouter("cloudRouterResource", {
    account: {
        accountNumber: 0,
    },
    location: {
        ibx: "string",
        metroCode: "string",
        metroName: "string",
        region: "string",
    },
    notifications: [{
        emails: ["string"],
        type: "string",
        sendInterval: "string",
    }],
    order: {
        billingTier: "string",
        orderId: "string",
        orderNumber: "string",
        purchaseOrderNumber: "string",
    },
    "package": {
        code: "string",
    },
    project: {
        href: "string",
        projectId: "string",
    },
    type: "string",
    description: "string",
    href: "string",
    name: "string",
    uuid: "string",
});

    type: equinix:fabric:CloudRouter
properties:
    account:
        accountNumber: 0
    description: string
    href: string
    location:
        ibx: string
        metroCode: string
        metroName: string
        region: string
    name: string
    notifications:
        - emails:
            - string
          sendInterval: string
          type: string
    order:
        billingTier: string
        orderId: string
        orderNumber: string
        purchaseOrderNumber: string
    package:
        code: string
    project:
        href: string
        projectId: string
    type: string
    uuid: string

    CloudRouter Resource Properties

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

    Inputs

    The CloudRouter resource accepts the following input properties:

    Account CloudRouterAccount
    Customer account information that is associated with this Fabric Cloud Router
    Location CloudRouterLocation
    Fabric Cloud Router location
    Notifications List<CloudRouterNotification>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    Order CloudRouterOrder
    Order information related to this Fabric Cloud Router
    Package CloudRouterPackage
    Fabric Cloud Router Package Type
    Project CloudRouterProject
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    Type string
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    Description string
    Customer-provided Fabric Cloud Router description
    Href string
    Unique Resource URL
    Name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    Account CloudRouterAccountArgs
    Customer account information that is associated with this Fabric Cloud Router
    Location CloudRouterLocationArgs
    Fabric Cloud Router location
    Notifications []CloudRouterNotificationArgs
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    Order CloudRouterOrderArgs
    Order information related to this Fabric Cloud Router
    Package CloudRouterPackageArgs
    Fabric Cloud Router Package Type
    Project CloudRouterProjectArgs
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    Type string
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    Description string
    Customer-provided Fabric Cloud Router description
    Href string
    Unique Resource URL
    Name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    account CloudRouterAccount
    Customer account information that is associated with this Fabric Cloud Router
    location CloudRouterLocation
    Fabric Cloud Router location
    notifications List<CloudRouterNotification>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order CloudRouterOrder
    Order information related to this Fabric Cloud Router
    package_ CloudRouterPackage
    Fabric Cloud Router Package Type
    project CloudRouterProject
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    type String
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    description String
    Customer-provided Fabric Cloud Router description
    href String
    Unique Resource URL
    name String
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    uuid String
    Equinix-assigned Fabric Cloud Router identifier
    account CloudRouterAccount
    Customer account information that is associated with this Fabric Cloud Router
    location CloudRouterLocation
    Fabric Cloud Router location
    notifications CloudRouterNotification[]
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order CloudRouterOrder
    Order information related to this Fabric Cloud Router
    package CloudRouterPackage
    Fabric Cloud Router Package Type
    project CloudRouterProject
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    type string
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    description string
    Customer-provided Fabric Cloud Router description
    href string
    Unique Resource URL
    name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    uuid string
    Equinix-assigned Fabric Cloud Router identifier
    account CloudRouterAccountArgs
    Customer account information that is associated with this Fabric Cloud Router
    location CloudRouterLocationArgs
    Fabric Cloud Router location
    notifications Sequence[CloudRouterNotificationArgs]
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order CloudRouterOrderArgs
    Order information related to this Fabric Cloud Router
    package CloudRouterPackageArgs
    Fabric Cloud Router Package Type
    project CloudRouterProjectArgs
    Customer resource hierarchy project information.Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects
    type str
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    description str
    Customer-provided Fabric Cloud Router description
    href str
    Unique Resource URL
    name str
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    uuid str
    Equinix-assigned Fabric Cloud Router identifier
    account Property Map
    Customer account information that is associated with this Fabric Cloud Router
    location Property Map
    Fabric Cloud Router location
    notifications List<Property Map>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order Property Map
    Order information related to this Fabric Cloud Router
    package Property Map
    Fabric Cloud Router Package Type
    project 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
    type String
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    description String
    Customer-provided Fabric Cloud Router description
    href String
    Unique Resource URL
    name String
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    uuid String
    Equinix-assigned Fabric Cloud Router identifier

    Outputs

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

    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<CloudRouterChangeLog>
    Captures Fabric Cloud Router lifecycle change information
    ConnectionsCount int
    Number of connections associated with this Fabric Cloud Router instance
    DistinctIpv4PrefixesCount int
    Number of distinct IPv4 routes
    DistinctIpv6PrefixesCount int
    Number of distinct IPv6 routes
    EquinixAsn int
    Equinix ASN
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Fabric Cloud Router overall state
    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 []CloudRouterChangeLog
    Captures Fabric Cloud Router lifecycle change information
    ConnectionsCount int
    Number of connections associated with this Fabric Cloud Router instance
    DistinctIpv4PrefixesCount int
    Number of distinct IPv4 routes
    DistinctIpv6PrefixesCount int
    Number of distinct IPv6 routes
    EquinixAsn int
    Equinix ASN
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Fabric Cloud Router overall state
    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<CloudRouterChangeLog>
    Captures Fabric Cloud Router lifecycle change information
    connectionsCount Integer
    Number of connections associated with this Fabric Cloud Router instance
    distinctIpv4PrefixesCount Integer
    Number of distinct IPv4 routes
    distinctIpv6PrefixesCount Integer
    Number of distinct IPv6 routes
    equinixAsn Integer
    Equinix ASN
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Fabric Cloud Router overall state
    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 CloudRouterChangeLog[]
    Captures Fabric Cloud Router lifecycle change information
    connectionsCount number
    Number of connections associated with this Fabric Cloud Router instance
    distinctIpv4PrefixesCount number
    Number of distinct IPv4 routes
    distinctIpv6PrefixesCount number
    Number of distinct IPv6 routes
    equinixAsn number
    Equinix ASN
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Fabric Cloud Router overall state
    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[CloudRouterChangeLog]
    Captures Fabric Cloud Router lifecycle change information
    connections_count int
    Number of connections associated with this Fabric Cloud Router instance
    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
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Fabric Cloud Router overall state
    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
    distinctIpv4PrefixesCount Number
    Number of distinct IPv4 routes
    distinctIpv6PrefixesCount Number
    Number of distinct IPv6 routes
    equinixAsn Number
    Equinix ASN
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Fabric Cloud Router overall state

    Look up Existing CloudRouter Resource

    Get an existing CloudRouter 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?: CloudRouterState, opts?: CustomResourceOptions): CloudRouter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account: Optional[CloudRouterAccountArgs] = None,
        bgp_ipv4_routes_count: Optional[int] = None,
        bgp_ipv6_routes_count: Optional[int] = None,
        change_logs: Optional[Sequence[CloudRouterChangeLogArgs]] = None,
        connections_count: Optional[int] = None,
        description: Optional[str] = None,
        distinct_ipv4_prefixes_count: Optional[int] = None,
        distinct_ipv6_prefixes_count: Optional[int] = None,
        equinix_asn: Optional[int] = None,
        href: Optional[str] = None,
        location: Optional[CloudRouterLocationArgs] = None,
        name: Optional[str] = None,
        notifications: Optional[Sequence[CloudRouterNotificationArgs]] = None,
        order: Optional[CloudRouterOrderArgs] = None,
        package: Optional[CloudRouterPackageArgs] = None,
        project: Optional[CloudRouterProjectArgs] = None,
        state: Optional[str] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> CloudRouter
    func GetCloudRouter(ctx *Context, name string, id IDInput, state *CloudRouterState, opts ...ResourceOption) (*CloudRouter, error)
    public static CloudRouter Get(string name, Input<string> id, CloudRouterState? state, CustomResourceOptions? opts = null)
    public static CloudRouter get(String name, Output<String> id, CloudRouterState 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:
    Account CloudRouterAccount
    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<CloudRouterChangeLog>
    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
    Unique Resource URL
    Location CloudRouterLocation
    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<CloudRouterNotification>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    Order CloudRouterOrder
    Order information related to this Fabric Cloud Router
    Package CloudRouterPackage
    Fabric Cloud Router Package Type
    Project CloudRouterProject
    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
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    Account CloudRouterAccountArgs
    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 []CloudRouterChangeLogArgs
    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
    Unique Resource URL
    Location CloudRouterLocationArgs
    Fabric Cloud Router location
    Name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Notifications []CloudRouterNotificationArgs
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    Order CloudRouterOrderArgs
    Order information related to this Fabric Cloud Router
    Package CloudRouterPackageArgs
    Fabric Cloud Router Package Type
    Project CloudRouterProjectArgs
    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
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    Uuid string
    Equinix-assigned Fabric Cloud Router identifier
    account CloudRouterAccount
    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<CloudRouterChangeLog>
    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
    Unique Resource URL
    location CloudRouterLocation
    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<CloudRouterNotification>
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order CloudRouterOrder
    Order information related to this Fabric Cloud Router
    package_ CloudRouterPackage
    Fabric Cloud Router Package Type
    project CloudRouterProject
    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
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    uuid String
    Equinix-assigned Fabric Cloud Router identifier
    account CloudRouterAccount
    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 CloudRouterChangeLog[]
    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
    Unique Resource URL
    location CloudRouterLocation
    Fabric Cloud Router location
    name string
    Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    notifications CloudRouterNotification[]
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order CloudRouterOrder
    Order information related to this Fabric Cloud Router
    package CloudRouterPackage
    Fabric Cloud Router Package Type
    project CloudRouterProject
    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
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    uuid string
    Equinix-assigned Fabric Cloud Router identifier
    account CloudRouterAccountArgs
    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[CloudRouterChangeLogArgs]
    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
    Unique Resource URL
    location CloudRouterLocationArgs
    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[CloudRouterNotificationArgs]
    Preferences for notifications on Fabric Cloud Router configuration or status changes
    order CloudRouterOrderArgs
    Order information related to this Fabric Cloud Router
    package CloudRouterPackageArgs
    Fabric Cloud Router Package Type
    project CloudRouterProjectArgs
    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
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    uuid str
    Equinix-assigned Fabric Cloud Router identifier
    account 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
    Unique Resource URL
    location 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
    order Property Map
    Order information related to this Fabric Cloud Router
    package Property Map
    Fabric Cloud Router Package Type
    project 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
    Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
    uuid String
    Equinix-assigned Fabric Cloud Router identifier

    Supporting Types

    CloudRouterAccount, CloudRouterAccountArgs

    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

    CloudRouterChangeLog, CloudRouterChangeLogArgs

    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

    CloudRouterLocation, CloudRouterLocationArgs

    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

    CloudRouterNotification, CloudRouterNotificationArgs

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

    CloudRouterOrder, CloudRouterOrderArgs

    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

    CloudRouterPackage, CloudRouterPackageArgs

    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

    CloudRouterProject, CloudRouterProjectArgs

    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