equinix.metal.Interconnection
Explore with Pulumi AI
Use this resource to request the creation an Interconnection asset to connect with other parties using Equinix Fabric - software-defined interconnections.
Equinix Metal connection with with Service Token A-side / Z-side (service_token_type) is not generally available and may not be enabled yet for your organization.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Equinix = Pulumi.Equinix;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var projectId = config.Require("projectId");
var metro = config.Get("metro") ?? "SV";
var speedInMbps = config.GetNumber("speedInMbps") ?? 200;
var connection = new Equinix.Metal.Interconnection("connection", new()
{
Name = "fabric-port-to-metal",
ProjectId = projectId,
Type = "shared",
Redundancy = "primary",
Metro = metro,
Speed = $"{speedInMbps}Mbps",
ServiceTokenType = "z_side",
});
return new Dictionary<string, object?>
{
["connectionStatus"] = connection.Status,
["connectionTokens"] = connection.ServiceTokens,
};
});
package main
import (
"fmt"
"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
"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, "")
projectId := cfg.Require("projectId")
metro := "SV"
if param := cfg.Get("metro"); param != "" {
metro = param
}
speedInMbps := 200
if param := cfg.GetInt("speedInMbps"); param != 0 {
speedInMbps = param
}
connection, err := metal.NewInterconnection(ctx, "connection", &metal.InterconnectionArgs{
Name: pulumi.String("fabric-port-to-metal"),
ProjectId: pulumi.String(projectId),
Type: pulumi.String("shared"),
Redundancy: pulumi.String("primary"),
Metro: pulumi.String(metro),
Speed: pulumi.String(fmt.Sprintf("%vMbps", speedInMbps)),
ServiceTokenType: pulumi.String("z_side"),
})
if err != nil {
return err
}
ctx.Export("connectionStatus", connection.Status)
ctx.Export("connectionTokens", connection.ServiceTokens)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.equinix.pulumi.metal.Interconnection;
import com.equinix.pulumi.metal.InterconnectionArgs;
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 projectId = config.get("projectId").get();
final var metro = config.get("metro").orElse("SV");
final var speedInMbps = Integer.parseInt(config.get("speedInMbps").orElse("200"));
var connection = new Interconnection("connection", InterconnectionArgs.builder()
.name("fabric-port-to-metal")
.projectId(projectId)
.type("shared")
.redundancy("primary")
.metro(metro)
.speed(String.format("%sMbps", speedInMbps))
.serviceTokenType("z_side")
.build());
ctx.export("connectionStatus", connection.status());
ctx.export("connectionTokens", connection.serviceTokens());
}
}
import pulumi
import pulumi_equinix as equinix
config = pulumi.Config()
project_id = config.require("projectId")
metro = config.get("metro")
if metro is None:
metro = "SV"
speed_in_mbps = config.get_int("speedInMbps")
if speed_in_mbps is None:
speed_in_mbps = 200
connection = equinix.metal.Interconnection("connection",
name="fabric-port-to-metal",
project_id=project_id,
type="shared",
redundancy="primary",
metro=metro,
speed=f"{speed_in_mbps}Mbps",
service_token_type="z_side")
pulumi.export("connectionStatus", connection.status)
pulumi.export("connectionTokens", connection.service_tokens)
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";
const config = new pulumi.Config();
const projectId = config.require("projectId");
const metro = config.get("metro") || "SV";
const speedInMbps = config.getNumber("speedInMbps") || 200;
const connection = new equinix.metal.Interconnection("connection", {
name: "fabric-port-to-metal",
projectId: projectId,
type: "shared",
redundancy: "primary",
metro: metro,
speed: `${speedInMbps}Mbps`,
serviceTokenType: "z_side",
});
export const connectionStatus = connection.status;
export const connectionTokens = connection.serviceTokens;
config:
projectId:
type: string
metro:
type: string
default: SV
speedInMbps:
type: integer
default: 200
resources:
connection:
type: equinix:metal:Interconnection
properties:
name: fabric-port-to-metal
projectId: ${projectId}
type: shared
redundancy: primary
metro: ${metro}
speed: ${speedInMbps}Mbps
serviceTokenType: z_side
outputs:
connectionStatus: ${connection.status}
connectionTokens: ${connection.serviceTokens}
Create Interconnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Interconnection(name: string, args: InterconnectionArgs, opts?: CustomResourceOptions);
@overload
def Interconnection(resource_name: str,
args: InterconnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Interconnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
redundancy: Optional[str] = None,
type: Optional[str] = None,
organization_id: Optional[str] = None,
metro: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
contact_email: Optional[str] = None,
project_id: Optional[str] = None,
facility: Optional[str] = None,
service_token_type: Optional[str] = None,
speed: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
description: Optional[str] = None,
vlans: Optional[Sequence[int]] = None,
vrfs: Optional[Sequence[str]] = None)
func NewInterconnection(ctx *Context, name string, args InterconnectionArgs, opts ...ResourceOption) (*Interconnection, error)
public Interconnection(string name, InterconnectionArgs args, CustomResourceOptions? opts = null)
public Interconnection(String name, InterconnectionArgs args)
public Interconnection(String name, InterconnectionArgs args, CustomResourceOptions options)
type: equinix:metal:Interconnection
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 InterconnectionArgs
- 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 InterconnectionArgs
- 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 InterconnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InterconnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InterconnectionArgs
- 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 interconnectionResource = new Equinix.Metal.Interconnection("interconnectionResource", new()
{
Redundancy = "string",
Type = "string",
OrganizationId = "string",
Metro = "string",
Mode = "string",
Name = "string",
ContactEmail = "string",
ProjectId = "string",
ServiceTokenType = "string",
Speed = "string",
Tags = new[]
{
"string",
},
Description = "string",
Vlans = new[]
{
0,
},
Vrfs = new[]
{
"string",
},
});
example, err := metal.NewInterconnection(ctx, "interconnectionResource", &metal.InterconnectionArgs{
Redundancy: pulumi.String("string"),
Type: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
Metro: pulumi.String("string"),
Mode: pulumi.String("string"),
Name: pulumi.String("string"),
ContactEmail: pulumi.String("string"),
ProjectId: pulumi.String("string"),
ServiceTokenType: pulumi.String("string"),
Speed: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Vlans: pulumi.IntArray{
pulumi.Int(0),
},
Vrfs: pulumi.StringArray{
pulumi.String("string"),
},
})
var interconnectionResource = new Interconnection("interconnectionResource", InterconnectionArgs.builder()
.redundancy("string")
.type("string")
.organizationId("string")
.metro("string")
.mode("string")
.name("string")
.contactEmail("string")
.projectId("string")
.serviceTokenType("string")
.speed("string")
.tags("string")
.description("string")
.vlans(0)
.vrfs("string")
.build());
interconnection_resource = equinix.metal.Interconnection("interconnectionResource",
redundancy="string",
type="string",
organization_id="string",
metro="string",
mode="string",
name="string",
contact_email="string",
project_id="string",
service_token_type="string",
speed="string",
tags=["string"],
description="string",
vlans=[0],
vrfs=["string"])
const interconnectionResource = new equinix.metal.Interconnection("interconnectionResource", {
redundancy: "string",
type: "string",
organizationId: "string",
metro: "string",
mode: "string",
name: "string",
contactEmail: "string",
projectId: "string",
serviceTokenType: "string",
speed: "string",
tags: ["string"],
description: "string",
vlans: [0],
vrfs: ["string"],
});
type: equinix:metal:Interconnection
properties:
contactEmail: string
description: string
metro: string
mode: string
name: string
organizationId: string
projectId: string
redundancy: string
serviceTokenType: string
speed: string
tags:
- string
type: string
vlans:
- 0
vrfs:
- string
Interconnection 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 Interconnection resource accepts the following input properties:
- Redundancy string
- Connection redundancy - redundant or primary.
- Type string
- Connection type - dedicated or shared.
- Contact
Email string - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- Description string
- Description for the connection resource.
- Facility string
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- Metro string
- Metro where the connection will be created.
- Mode string
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- Name string
- Name of the connection resource
- Organization
Id string - ID of the organization where the connection is scoped to.
- Project
Id string - ID of the project where the connection is scoped to, must be set for.
- Service
Token stringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- Speed string
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- List<string>
- String list of tags.
- Vlans List<int>
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- Vrfs List<string>
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- Redundancy string
- Connection redundancy - redundant or primary.
- Type string
- Connection type - dedicated or shared.
- Contact
Email string - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- Description string
- Description for the connection resource.
- Facility string
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- Metro string
- Metro where the connection will be created.
- Mode string
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- Name string
- Name of the connection resource
- Organization
Id string - ID of the organization where the connection is scoped to.
- Project
Id string - ID of the project where the connection is scoped to, must be set for.
- Service
Token stringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- Speed string
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- []string
- String list of tags.
- Vlans []int
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- Vrfs []string
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- redundancy String
- Connection redundancy - redundant or primary.
- type String
- Connection type - dedicated or shared.
- contact
Email String - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description String
- Description for the connection resource.
- facility String
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro String
- Metro where the connection will be created.
- mode String
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name String
- Name of the connection resource
- organization
Id String - ID of the organization where the connection is scoped to.
- project
Id String - ID of the project where the connection is scoped to, must be set for.
- service
Token StringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- speed String
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- List<String>
- String list of tags.
- vlans List<Integer>
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs List<String>
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- redundancy string
- Connection redundancy - redundant or primary.
- type string
- Connection type - dedicated or shared.
- contact
Email string - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description string
- Description for the connection resource.
- facility string
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro string
- Metro where the connection will be created.
- mode string
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name string
- Name of the connection resource
- organization
Id string - ID of the organization where the connection is scoped to.
- project
Id string - ID of the project where the connection is scoped to, must be set for.
- service
Token stringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- speed string
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- string[]
- String list of tags.
- vlans number[]
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs string[]
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- redundancy str
- Connection redundancy - redundant or primary.
- type str
- Connection type - dedicated or shared.
- contact_
email str - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description str
- Description for the connection resource.
- facility str
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro str
- Metro where the connection will be created.
- mode str
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name str
- Name of the connection resource
- organization_
id str - ID of the organization where the connection is scoped to.
- project_
id str - ID of the project where the connection is scoped to, must be set for.
- service_
token_ strtype - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- speed str
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- Sequence[str]
- String list of tags.
- vlans Sequence[int]
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs Sequence[str]
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- redundancy String
- Connection redundancy - redundant or primary.
- type String
- Connection type - dedicated or shared.
- contact
Email String - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description String
- Description for the connection resource.
- facility String
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro String
- Metro where the connection will be created.
- mode String
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name String
- Name of the connection resource
- organization
Id String - ID of the organization where the connection is scoped to.
- project
Id String - ID of the project where the connection is scoped to, must be set for.
- service
Token StringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- speed String
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- List<String>
- String list of tags.
- vlans List<Number>
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs List<String>
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
Outputs
All input properties are implicitly available as output properties. Additionally, the Interconnection resource produces the following output properties:
- string
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ports
List<Interconnection
Port> - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - Service
Tokens List<InterconnectionService Token> - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- Status string
- Status of the connection resource.
- Token string
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead.
- string
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ports
[]Interconnection
Port - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - Service
Tokens []InterconnectionService Token - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- Status string
- Status of the connection resource.
- Token string
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead.
- String
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- id String
- The provider-assigned unique ID for this managed resource.
- ports
List<Interconnection
Port> - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - service
Tokens List<InterconnectionService Token> - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- status String
- Status of the connection resource.
- token String
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead.
- string
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- id string
- The provider-assigned unique ID for this managed resource.
- ports
Interconnection
Port[] - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - service
Tokens InterconnectionService Token[] - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- status string
- Status of the connection resource.
- token string
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead.
- str
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- id str
- The provider-assigned unique ID for this managed resource.
- ports
Sequence[Interconnection
Port] - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - service_
tokens Sequence[InterconnectionService Token] - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- status str
- Status of the connection resource.
- token str
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead.
- String
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- id String
- The provider-assigned unique ID for this managed resource.
- ports List<Property Map>
- List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - service
Tokens List<Property Map> - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- status String
- Status of the connection resource.
- token String
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead.
Look up Existing Interconnection Resource
Get an existing Interconnection 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?: InterconnectionState, opts?: CustomResourceOptions): Interconnection
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authorization_code: Optional[str] = None,
contact_email: Optional[str] = None,
description: Optional[str] = None,
facility: Optional[str] = None,
metro: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None,
ports: Optional[Sequence[InterconnectionPortArgs]] = None,
project_id: Optional[str] = None,
redundancy: Optional[str] = None,
service_token_type: Optional[str] = None,
service_tokens: Optional[Sequence[InterconnectionServiceTokenArgs]] = None,
speed: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
token: Optional[str] = None,
type: Optional[str] = None,
vlans: Optional[Sequence[int]] = None,
vrfs: Optional[Sequence[str]] = None) -> Interconnection
func GetInterconnection(ctx *Context, name string, id IDInput, state *InterconnectionState, opts ...ResourceOption) (*Interconnection, error)
public static Interconnection Get(string name, Input<string> id, InterconnectionState? state, CustomResourceOptions? opts = null)
public static Interconnection get(String name, Output<String> id, InterconnectionState 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.
- string
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- Contact
Email string - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- Description string
- Description for the connection resource.
- Facility string
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- Metro string
- Metro where the connection will be created.
- Mode string
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- Name string
- Name of the connection resource
- Organization
Id string - ID of the organization where the connection is scoped to.
- Ports
List<Interconnection
Port> - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - Project
Id string - ID of the project where the connection is scoped to, must be set for.
- Redundancy string
- Connection redundancy - redundant or primary.
- Service
Token stringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- Service
Tokens List<InterconnectionService Token> - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- Speed string
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- Status string
- Status of the connection resource.
- List<string>
- String list of tags.
- Token string
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead. - Type string
- Connection type - dedicated or shared.
- Vlans List<int>
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- Vrfs List<string>
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- string
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- Contact
Email string - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- Description string
- Description for the connection resource.
- Facility string
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- Metro string
- Metro where the connection will be created.
- Mode string
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- Name string
- Name of the connection resource
- Organization
Id string - ID of the organization where the connection is scoped to.
- Ports
[]Interconnection
Port Args - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - Project
Id string - ID of the project where the connection is scoped to, must be set for.
- Redundancy string
- Connection redundancy - redundant or primary.
- Service
Token stringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- Service
Tokens []InterconnectionService Token Args - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- Speed string
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- Status string
- Status of the connection resource.
- []string
- String list of tags.
- Token string
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead. - Type string
- Connection type - dedicated or shared.
- Vlans []int
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- Vrfs []string
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- String
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- contact
Email String - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description String
- Description for the connection resource.
- facility String
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro String
- Metro where the connection will be created.
- mode String
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name String
- Name of the connection resource
- organization
Id String - ID of the organization where the connection is scoped to.
- ports
List<Interconnection
Port> - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - project
Id String - ID of the project where the connection is scoped to, must be set for.
- redundancy String
- Connection redundancy - redundant or primary.
- service
Token StringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- service
Tokens List<InterconnectionService Token> - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- speed String
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status String
- Status of the connection resource.
- List<String>
- String list of tags.
- token String
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead. - type String
- Connection type - dedicated or shared.
- vlans List<Integer>
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs List<String>
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- string
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- contact
Email string - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description string
- Description for the connection resource.
- facility string
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro string
- Metro where the connection will be created.
- mode string
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name string
- Name of the connection resource
- organization
Id string - ID of the organization where the connection is scoped to.
- ports
Interconnection
Port[] - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - project
Id string - ID of the project where the connection is scoped to, must be set for.
- redundancy string
- Connection redundancy - redundant or primary.
- service
Token stringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- service
Tokens InterconnectionService Token[] - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- speed string
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status string
- Status of the connection resource.
- string[]
- String list of tags.
- token string
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead. - type string
- Connection type - dedicated or shared.
- vlans number[]
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs string[]
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- str
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- contact_
email str - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description str
- Description for the connection resource.
- facility str
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro str
- Metro where the connection will be created.
- mode str
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name str
- Name of the connection resource
- organization_
id str - ID of the organization where the connection is scoped to.
- ports
Sequence[Interconnection
Port Args] - List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - project_
id str - ID of the project where the connection is scoped to, must be set for.
- redundancy str
- Connection redundancy - redundant or primary.
- service_
token_ strtype - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- service_
tokens Sequence[InterconnectionService Token Args] - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- speed str
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status str
- Status of the connection resource.
- Sequence[str]
- String list of tags.
- token str
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead. - type str
- Connection type - dedicated or shared.
- vlans Sequence[int]
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs Sequence[str]
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
- String
- Only used with Fabric Shared connection. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.
- contact
Email String - The preferred email used for communication and notifications about the Equinix Fabric interconnection. Required when using a Project API key. Optional and defaults to the primary user email address when using a User API key.
- description String
- Description for the connection resource.
- facility String
- Facility where the connection will be created. Use metro instead; read the facility to metro migration guide
- metro String
- Metro where the connection will be created.
- mode String
- Mode for connections in IBX facilities with the dedicated type - standard or tunnel. Default is standard.
- name String
- Name of the connection resource
- organization
Id String - ID of the organization where the connection is scoped to.
- ports List<Property Map>
- List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix.metal.Interconnection datasource. - project
Id String - ID of the project where the connection is scoped to, must be set for.
- redundancy String
- Connection redundancy - redundant or primary.
- service
Token StringType - Only used with shared connection. Type of service token to use for the connection, a_side or z_side
- service
Tokens List<Property Map> - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. Scehma of service_token is described in documentation of the equinix.metal.Interconnection datasource.
- speed String
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status String
- Status of the connection resource.
- List<String>
- String list of tags.
- token String
- (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the equinix_ecx_l2_connection resource or from the Equinix Fabric Portal. If your organization already has connection service tokens enabled, use
service_tokens
instead. - type String
- Connection type - dedicated or shared.
- vlans List<Number>
- Only used with shared connection. Vlans to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection.
- vrfs List<String>
- Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection
Supporting Types
InterconnectionPort, InterconnectionPortArgs
- Id string
- Link
Status string - Name string
- Name of the connection resource
- Role string
- Speed int
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- Status string
- Status of the connection resource.
- Virtual
Circuit List<object>Ids
- Id string
- Link
Status string - Name string
- Name of the connection resource
- Role string
- Speed int
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- Status string
- Status of the connection resource.
- Virtual
Circuit []interface{}Ids
- id String
- link
Status String - name String
- Name of the connection resource
- role String
- speed Integer
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status String
- Status of the connection resource.
- virtual
Circuit List<Object>Ids
- id string
- link
Status string - name string
- Name of the connection resource
- role string
- speed number
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status string
- Status of the connection resource.
- virtual
Circuit any[]Ids
- id str
- link_
status str - name str
- Name of the connection resource
- role str
- speed int
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status str
- Status of the connection resource.
- virtual_
circuit_ Sequence[Any]ids
- id String
- link
Status String - name String
- Name of the connection resource
- role String
- speed Number
- Connection speed - Values must be in the format 'Mbps' or 'Gpbs', for example '100Mbps' or '50Gbps'. Actual supported values will depend on the connection type and whether the connection uses VLANs or VRF.
- status String
- Status of the connection resource.
- virtual
Circuit List<Any>Ids
InterconnectionServiceToken, InterconnectionServiceTokenArgs
- expires_
at str - id str
- max_
allowed_ strspeed - role str
- state str
- type str
- Connection type - dedicated or shared.
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.