equinix.fabric.CloudRouter
Explore with Pulumi AI
Fabric V4 API compatible resource allows creation and management of Equinix Fabric Cloud Router.
Additional documentation:
- Getting Started: https://docs.equinix.com/en-us/Content/Interconnection/FCR/FCR-intro.htm#HowItWorks
- API: https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-cloud-routers
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,
},
Project = new Equinix.Fabric.Inputs.CloudRouterProjectArgs
{
ProjectId = "995072000433550",
},
});
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),
},
Project: &fabric.CloudRouterProjectArgs{
ProjectId: pulumi.String("995072000433550"),
},
})
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())
.project(CloudRouterProjectArgs.builder()
.projectId("995072000433550")
.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,
))
project=equinix.fabric.CloudRouterProjectArgs(
project_id=995072000433550,
))
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,
},
"project": {
"projectId": "995072000433550"
}
});
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
project:
projectId: 995072000433550
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,
package: Optional[CloudRouterPackageArgs] = None,
project: Optional[CloudRouterProjectArgs] = None,
type: Optional[str] = None,
description: Optional[str] = None,
href: Optional[str] = None,
name: Optional[str] = None,
order: Optional[CloudRouterOrderArgs] = 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.
Constructor 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",
},
},
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",
Order = new Equinix.Fabric.Inputs.CloudRouterOrderArgs
{
BillingTier = "string",
OrderId = "string",
OrderNumber = "string",
PurchaseOrderNumber = "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"),
},
},
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"),
Order: &fabric.CloudRouterOrderArgs{
BillingTier: pulumi.String("string"),
OrderId: pulumi.String("string"),
OrderNumber: pulumi.String("string"),
PurchaseOrderNumber: 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())
.package_(CloudRouterPackageArgs.builder()
.code("string")
.build())
.project(CloudRouterProjectArgs.builder()
.href("string")
.projectId("string")
.build())
.type("string")
.description("string")
.href("string")
.name("string")
.order(CloudRouterOrderArgs.builder()
.billingTier("string")
.orderId("string")
.orderNumber("string")
.purchaseOrderNumber("string")
.build())
.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",
)],
package=equinix.fabric.CloudRouterPackageArgs(
code="string",
),
project=equinix.fabric.CloudRouterProjectArgs(
href="string",
project_id="string",
),
type="string",
description="string",
href="string",
name="string",
order=equinix.fabric.CloudRouterOrderArgs(
billing_tier="string",
order_id="string",
order_number="string",
purchase_order_number="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",
}],
"package": {
code: "string",
},
project: {
href: "string",
projectId: "string",
},
type: "string",
description: "string",
href: "string",
name: "string",
order: {
billingTier: "string",
orderId: "string",
orderNumber: "string",
purchaseOrderNumber: "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
Cloud
Router Account - Customer account information that is associated with this Fabric Cloud Router
- Location
Cloud
Router Location - Fabric Cloud Router location
- Notifications
List<Cloud
Router Notification> - Preferences for notifications on Fabric Cloud Router configuration or status changes
- Package
Cloud
Router Package - Fabric Cloud Router Package Type
- Project
Cloud
Router Project - 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
- Defines the FCR type like; XF_ROUTER
- Description string
- Customer-provided Fabric Cloud Router description
- Href string
- Fabric Cloud Router URI information
- Name string
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- Order
Cloud
Router Order - Order information related to this Fabric Cloud Router
- Uuid string
- Equinix-assigned Fabric Cloud Router identifier
- Account
Cloud
Router Account Args - Customer account information that is associated with this Fabric Cloud Router
- Location
Cloud
Router Location Args - Fabric Cloud Router location
- Notifications
[]Cloud
Router Notification Args - Preferences for notifications on Fabric Cloud Router configuration or status changes
- Package
Cloud
Router Package Args - Fabric Cloud Router Package Type
- Project
Cloud
Router Project Args - 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
- Defines the FCR type like; XF_ROUTER
- Description string
- Customer-provided Fabric Cloud Router description
- Href string
- Fabric Cloud Router URI information
- Name string
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- Order
Cloud
Router Order Args - Order information related to this Fabric Cloud Router
- Uuid string
- Equinix-assigned Fabric Cloud Router identifier
- account
Cloud
Router Account - Customer account information that is associated with this Fabric Cloud Router
- location
Cloud
Router Location - Fabric Cloud Router location
- notifications
List<Cloud
Router Notification> - Preferences for notifications on Fabric Cloud Router configuration or status changes
- package_
Cloud
Router Package - Fabric Cloud Router Package Type
- project
Cloud
Router Project - 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
- Defines the FCR type like; XF_ROUTER
- description String
- Customer-provided Fabric Cloud Router description
- href String
- Fabric Cloud Router URI information
- name String
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- order
Cloud
Router Order - Order information related to this Fabric Cloud Router
- uuid String
- Equinix-assigned Fabric Cloud Router identifier
- account
Cloud
Router Account - Customer account information that is associated with this Fabric Cloud Router
- location
Cloud
Router Location - Fabric Cloud Router location
- notifications
Cloud
Router Notification[] - Preferences for notifications on Fabric Cloud Router configuration or status changes
- package
Cloud
Router Package - Fabric Cloud Router Package Type
- project
Cloud
Router Project - 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
- Defines the FCR type like; XF_ROUTER
- description string
- Customer-provided Fabric Cloud Router description
- href string
- Fabric Cloud Router URI information
- name string
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- order
Cloud
Router Order - Order information related to this Fabric Cloud Router
- uuid string
- Equinix-assigned Fabric Cloud Router identifier
- account
Cloud
Router Account Args - Customer account information that is associated with this Fabric Cloud Router
- location
Cloud
Router Location Args - Fabric Cloud Router location
- notifications
Sequence[Cloud
Router Notification Args] - Preferences for notifications on Fabric Cloud Router configuration or status changes
- package
Cloud
Router Package Args - Fabric Cloud Router Package Type
- project
Cloud
Router Project Args - 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
- Defines the FCR type like; XF_ROUTER
- description str
- Customer-provided Fabric Cloud Router description
- href str
- Fabric Cloud Router URI information
- name str
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- order
Cloud
Router Order Args - Order information related to this Fabric Cloud Router
- 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
- 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
- Defines the FCR type like; XF_ROUTER
- description String
- Customer-provided Fabric Cloud Router description
- href String
- Fabric Cloud Router URI information
- name String
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- order Property Map
- Order information related to this Fabric Cloud Router
- 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:
- Bgp
Ipv4Routes intCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- Bgp
Ipv6Routes intCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- Change
Logs List<CloudRouter Change Log> - Captures Fabric Cloud Router lifecycle change information
- Connections
Count int - Number of connections associated with this Fabric Cloud Router instance
- Distinct
Ipv4Prefixes intCount - Number of distinct IPv4 routes
- Distinct
Ipv6Prefixes intCount - Number of distinct IPv6 routes
- Equinix
Asn int - Equinix ASN
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- Fabric Cloud Router overall state
- Bgp
Ipv4Routes intCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- Bgp
Ipv6Routes intCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- Change
Logs []CloudRouter Change Log - Captures Fabric Cloud Router lifecycle change information
- Connections
Count int - Number of connections associated with this Fabric Cloud Router instance
- Distinct
Ipv4Prefixes intCount - Number of distinct IPv4 routes
- Distinct
Ipv6Prefixes intCount - Number of distinct IPv6 routes
- Equinix
Asn int - Equinix ASN
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- Fabric Cloud Router overall state
- bgp
Ipv4Routes IntegerCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp
Ipv6Routes IntegerCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change
Logs List<CloudRouter Change Log> - Captures Fabric Cloud Router lifecycle change information
- connections
Count Integer - Number of connections associated with this Fabric Cloud Router instance
- distinct
Ipv4Prefixes IntegerCount - Number of distinct IPv4 routes
- distinct
Ipv6Prefixes IntegerCount - Number of distinct IPv6 routes
- equinix
Asn Integer - Equinix ASN
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- Fabric Cloud Router overall state
- bgp
Ipv4Routes numberCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp
Ipv6Routes numberCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change
Logs CloudRouter Change Log[] - Captures Fabric Cloud Router lifecycle change information
- connections
Count number - Number of connections associated with this Fabric Cloud Router instance
- distinct
Ipv4Prefixes numberCount - Number of distinct IPv4 routes
- distinct
Ipv6Prefixes numberCount - Number of distinct IPv6 routes
- equinix
Asn number - Equinix ASN
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- Fabric Cloud Router overall state
- bgp_
ipv4_ introutes_ count - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp_
ipv6_ introutes_ count - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change_
logs Sequence[CloudRouter Change Log] - Captures Fabric Cloud Router lifecycle change information
- connections_
count int - Number of connections associated with this Fabric Cloud Router instance
- distinct_
ipv4_ intprefixes_ count - Number of distinct IPv4 routes
- distinct_
ipv6_ intprefixes_ count - 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
- bgp
Ipv4Routes NumberCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp
Ipv6Routes NumberCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change
Logs List<Property Map> - Captures Fabric Cloud Router lifecycle change information
- connections
Count Number - Number of connections associated with this Fabric Cloud Router instance
- distinct
Ipv4Prefixes NumberCount - Number of distinct IPv4 routes
- distinct
Ipv6Prefixes NumberCount - Number of distinct IPv6 routes
- equinix
Asn 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.
- Account
Cloud
Router Account - Customer account information that is associated with this Fabric Cloud Router
- Bgp
Ipv4Routes intCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- Bgp
Ipv6Routes intCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- Change
Logs List<CloudRouter Change Log> - Captures Fabric Cloud Router lifecycle change information
- Connections
Count int - Number of connections associated with this Fabric Cloud Router instance
- Description string
- Customer-provided Fabric Cloud Router description
- Distinct
Ipv4Prefixes intCount - Number of distinct IPv4 routes
- Distinct
Ipv6Prefixes intCount - Number of distinct IPv6 routes
- Equinix
Asn int - Equinix ASN
- Href string
- Fabric Cloud Router URI information
- Location
Cloud
Router Location - 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<Cloud
Router Notification> - Preferences for notifications on Fabric Cloud Router configuration or status changes
- Order
Cloud
Router Order - Order information related to this Fabric Cloud Router
- Package
Cloud
Router Package - Fabric Cloud Router Package Type
- Project
Cloud
Router Project - 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
- Account
Cloud
Router Account Args - Customer account information that is associated with this Fabric Cloud Router
- Bgp
Ipv4Routes intCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- Bgp
Ipv6Routes intCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- Change
Logs []CloudRouter Change Log Args - Captures Fabric Cloud Router lifecycle change information
- Connections
Count int - Number of connections associated with this Fabric Cloud Router instance
- Description string
- Customer-provided Fabric Cloud Router description
- Distinct
Ipv4Prefixes intCount - Number of distinct IPv4 routes
- Distinct
Ipv6Prefixes intCount - Number of distinct IPv6 routes
- Equinix
Asn int - Equinix ASN
- Href string
- Fabric Cloud Router URI information
- Location
Cloud
Router Location Args - Fabric Cloud Router location
- Name string
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- Notifications
[]Cloud
Router Notification Args - Preferences for notifications on Fabric Cloud Router configuration or status changes
- Order
Cloud
Router Order Args - Order information related to this Fabric Cloud Router
- Package
Cloud
Router Package Args - Fabric Cloud Router Package Type
- Project
Cloud
Router Project Args - 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
- account
Cloud
Router Account - Customer account information that is associated with this Fabric Cloud Router
- bgp
Ipv4Routes IntegerCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp
Ipv6Routes IntegerCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change
Logs List<CloudRouter Change Log> - Captures Fabric Cloud Router lifecycle change information
- connections
Count Integer - Number of connections associated with this Fabric Cloud Router instance
- description String
- Customer-provided Fabric Cloud Router description
- distinct
Ipv4Prefixes IntegerCount - Number of distinct IPv4 routes
- distinct
Ipv6Prefixes IntegerCount - Number of distinct IPv6 routes
- equinix
Asn Integer - Equinix ASN
- href String
- Fabric Cloud Router URI information
- location
Cloud
Router Location - 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<Cloud
Router Notification> - Preferences for notifications on Fabric Cloud Router configuration or status changes
- order
Cloud
Router Order - Order information related to this Fabric Cloud Router
- package_
Cloud
Router Package - Fabric Cloud Router Package Type
- project
Cloud
Router Project - 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
- account
Cloud
Router Account - Customer account information that is associated with this Fabric Cloud Router
- bgp
Ipv4Routes numberCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp
Ipv6Routes numberCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change
Logs CloudRouter Change Log[] - Captures Fabric Cloud Router lifecycle change information
- connections
Count number - Number of connections associated with this Fabric Cloud Router instance
- description string
- Customer-provided Fabric Cloud Router description
- distinct
Ipv4Prefixes numberCount - Number of distinct IPv4 routes
- distinct
Ipv6Prefixes numberCount - Number of distinct IPv6 routes
- equinix
Asn number - Equinix ASN
- href string
- Fabric Cloud Router URI information
- location
Cloud
Router Location - Fabric Cloud Router location
- name string
- Fabric Cloud Router name. An alpha-numeric 24 characters string which can include only hyphens and underscores
- notifications
Cloud
Router Notification[] - Preferences for notifications on Fabric Cloud Router configuration or status changes
- order
Cloud
Router Order - Order information related to this Fabric Cloud Router
- package
Cloud
Router Package - Fabric Cloud Router Package Type
- project
Cloud
Router Project - 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
- account
Cloud
Router Account Args - Customer account information that is associated with this Fabric Cloud Router
- bgp_
ipv4_ introutes_ count - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp_
ipv6_ introutes_ count - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change_
logs Sequence[CloudRouter Change Log Args] - 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_ intprefixes_ count - Number of distinct IPv4 routes
- distinct_
ipv6_ intprefixes_ count - Number of distinct IPv6 routes
- equinix_
asn int - Equinix ASN
- href str
- Fabric Cloud Router URI information
- location
Cloud
Router Location Args - 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[Cloud
Router Notification Args] - Preferences for notifications on Fabric Cloud Router configuration or status changes
- order
Cloud
Router Order Args - Order information related to this Fabric Cloud Router
- package
Cloud
Router Package Args - Fabric Cloud Router Package Type
- project
Cloud
Router Project Args - 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
- account Property Map
- Customer account information that is associated with this Fabric Cloud Router
- bgp
Ipv4Routes NumberCount - Number of IPv4 BGP routes in use (including non-distinct prefixes)
- bgp
Ipv6Routes NumberCount - Number of IPv6 BGP routes in use (including non-distinct prefixes)
- change
Logs List<Property Map> - Captures Fabric Cloud Router lifecycle change information
- connections
Count Number - Number of connections associated with this Fabric Cloud Router instance
- description String
- Customer-provided Fabric Cloud Router description
- distinct
Ipv4Prefixes NumberCount - Number of distinct IPv4 routes
- distinct
Ipv6Prefixes NumberCount - Number of distinct IPv6 routes
- equinix
Asn Number - Equinix ASN
- href String
- Fabric Cloud Router URI information
- 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
- Defines the FCR type like; XF_ROUTER
- uuid String
- Equinix-assigned Fabric Cloud Router identifier
Supporting Types
CloudRouterAccount, CloudRouterAccountArgs
- Account
Number int - Account Number
- Account
Number int - Account Number
- account
Number Integer - Account Number
- account
Number number - Account Number
- account_
number int - Account Number
- account
Number Number - Account Number
CloudRouterChangeLog, CloudRouterChangeLogArgs
- Created
By string - Created by User Key
- Created
By stringEmail - Created by User Email Address
- Created
By stringFull Name - Created by User Full Name
- Created
Date stringTime - Created by Date and Time
- Deleted
By string - Deleted by User Key
- Deleted
By stringEmail - Deleted by User Email Address
- Deleted
By stringFull Name - Deleted by User Full Name
- Deleted
Date stringTime - Deleted by Date and Time
- Updated
By string - Updated by User Key
- Updated
By stringEmail - Updated by User Email Address
- Updated
By stringFull Name - Updated by User Full Name
- Updated
Date stringTime - Updated by Date and Time
- Created
By string - Created by User Key
- Created
By stringEmail - Created by User Email Address
- Created
By stringFull Name - Created by User Full Name
- Created
Date stringTime - Created by Date and Time
- Deleted
By string - Deleted by User Key
- Deleted
By stringEmail - Deleted by User Email Address
- Deleted
By stringFull Name - Deleted by User Full Name
- Deleted
Date stringTime - Deleted by Date and Time
- Updated
By string - Updated by User Key
- Updated
By stringEmail - Updated by User Email Address
- Updated
By stringFull Name - Updated by User Full Name
- Updated
Date stringTime - Updated by Date and Time
- created
By String - Created by User Key
- created
By StringEmail - Created by User Email Address
- created
By StringFull Name - Created by User Full Name
- created
Date StringTime - Created by Date and Time
- deleted
By String - Deleted by User Key
- deleted
By StringEmail - Deleted by User Email Address
- deleted
By StringFull Name - Deleted by User Full Name
- deleted
Date StringTime - Deleted by Date and Time
- updated
By String - Updated by User Key
- updated
By StringEmail - Updated by User Email Address
- updated
By StringFull Name - Updated by User Full Name
- updated
Date StringTime - Updated by Date and Time
- created
By string - Created by User Key
- created
By stringEmail - Created by User Email Address
- created
By stringFull Name - Created by User Full Name
- created
Date stringTime - Created by Date and Time
- deleted
By string - Deleted by User Key
- deleted
By stringEmail - Deleted by User Email Address
- deleted
By stringFull Name - Deleted by User Full Name
- deleted
Date stringTime - Deleted by Date and Time
- updated
By string - Updated by User Key
- updated
By stringEmail - Updated by User Email Address
- updated
By stringFull Name - Updated by User Full Name
- updated
Date stringTime - Updated by Date and Time
- created_
by str - Created by User Key
- created_
by_ stremail - Created by User Email Address
- created_
by_ strfull_ name - Created by User Full Name
- created_
date_ strtime - Created by Date and Time
- deleted_
by str - Deleted by User Key
- deleted_
by_ stremail - Deleted by User Email Address
- deleted_
by_ strfull_ name - Deleted by User Full Name
- deleted_
date_ strtime - Deleted by Date and Time
- updated_
by str - Updated by User Key
- updated_
by_ stremail - Updated by User Email Address
- updated_
by_ strfull_ name - Updated by User Full Name
- updated_
date_ strtime - Updated by Date and Time
- created
By String - Created by User Key
- created
By StringEmail - Created by User Email Address
- created
By StringFull Name - Created by User Full Name
- created
Date StringTime - Created by Date and Time
- deleted
By String - Deleted by User Key
- deleted
By StringEmail - Deleted by User Email Address
- deleted
By StringFull Name - Deleted by User Full Name
- deleted
Date StringTime - Deleted by Date and Time
- updated
By String - Updated by User Key
- updated
By StringEmail - Updated by User Email Address
- updated
By StringFull Name - Updated by User Full Name
- updated
Date StringTime - Updated by Date and Time
CloudRouterLocation, CloudRouterLocationArgs
- ibx str
- IBX Code
- metro_
code str - Access point metro code
- metro_
name str - Access point metro name
- region str
- Access point region
CloudRouterNotification, CloudRouterNotificationArgs
- Emails List<string>
- Array of contact emails
- Type string
- Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
- Send
Interval string - Send interval
- Emails []string
- Array of contact emails
- Type string
- Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
- Send
Interval string - Send interval
- emails List<String>
- Array of contact emails
- type String
- Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
- send
Interval String - Send interval
- emails string[]
- Array of contact emails
- type string
- Notification Type - ALL,CONNECTIONAPPROVAL,SALESREP_NOTIFICATIONS, NOTIFICATIONS
- send
Interval 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
- send
Interval String - Send interval
CloudRouterOrder, CloudRouterOrderArgs
- Billing
Tier string - Billing tier for connection bandwidth
- Order
Id string - Order Identification
- Order
Number string - Order Reference Number
- Purchase
Order stringNumber - Purchase order number
- Billing
Tier string - Billing tier for connection bandwidth
- Order
Id string - Order Identification
- Order
Number string - Order Reference Number
- Purchase
Order stringNumber - Purchase order number
- billing
Tier String - Billing tier for connection bandwidth
- order
Id String - Order Identification
- order
Number String - Order Reference Number
- purchase
Order StringNumber - Purchase order number
- billing
Tier string - Billing tier for connection bandwidth
- order
Id string - Order Identification
- order
Number string - Order Reference Number
- purchase
Order stringNumber - Purchase order number
- billing_
tier str - Billing tier for connection bandwidth
- order_
id str - Order Identification
- order_
number str - Order Reference Number
- purchase_
order_ strnumber - Purchase order number
- billing
Tier String - Billing tier for connection bandwidth
- order
Id String - Order Identification
- order
Number String - Order Reference Number
- purchase
Order StringNumber - 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 str
- Unique Resource URL
- project_
id str - Project Id
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.