This package is deprecated. We recommend using the new Equinix package.
equinix-metal.Connection
Explore with Pulumi AI
This package is deprecated. We recommend using the new Equinix package.
Use this resource to request of create an Interconnection from Equinix Fabric - software-defined interconnections
Example Usage
using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;
class MyStack : Stack
{
public MyStack()
{
var test = new EquinixMetal.Connection("test", new EquinixMetal.ConnectionArgs
{
OrganizationId = local.My_organization_id,
ProjectId = local.My_project_id,
Metro = "sv",
Redundancy = "redundant",
Type = "shared",
});
}
}
package main
import (
"github.com/pulumi/pulumi-equinix-metal/sdk/v3/go/equinix-metal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := equinix - metal.NewConnection(ctx, "test", &equinix-metal.ConnectionArgs{
OrganizationId: pulumi.Any(local.My_organization_id),
ProjectId: pulumi.Any(local.My_project_id),
Metro: pulumi.String("sv"),
Redundancy: pulumi.String("redundant"),
Type: pulumi.String("shared"),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_equinix_metal as equinix_metal
test = equinix_metal.Connection("test",
organization_id=local["my_organization_id"],
project_id=local["my_project_id"],
metro="sv",
redundancy="redundant",
type="shared")
import * as pulumi from "@pulumi/pulumi";
import * as equinix_metal from "@pulumi/equinix-metal";
const test = new equinix_metal.Connection("test", {
organizationId: local.my_organization_id,
projectId: local.my_project_id,
metro: "sv",
redundancy: "redundant",
type: "shared",
});
Coming soon!
Create Connection Resource
new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
opts: Optional[ResourceOptions] = 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,
project_id: Optional[str] = None,
redundancy: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None)
@overload
def Connection(resource_name: str,
args: ConnectionArgs,
opts: Optional[ResourceOptions] = None)
func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
type: equinix-metal:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionArgs
- 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 ConnectionArgs
- 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 ConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Connection 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 Connection resource accepts the following input properties:
- Organization
Id string ID of the organization responsible for the connection
- Redundancy string
Connection redundancy - redundant or primary
- Type string
Connection type - dedicated or shared
- Description string
Description for the connection resource
- Facility string
Facility where the connection will be created
- Metro string
Metro where the connection will be created
- Mode string
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- Name string
Name of the connection resource
- Project
Id string ID of the project where the connection is scoped to, must be set for shared connection
- List<string>
String list of tags
- Organization
Id string ID of the organization responsible for the connection
- Redundancy string
Connection redundancy - redundant or primary
- Type string
Connection type - dedicated or shared
- Description string
Description for the connection resource
- Facility string
Facility where the connection will be created
- Metro string
Metro where the connection will be created
- Mode string
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- Name string
Name of the connection resource
- Project
Id string ID of the project where the connection is scoped to, must be set for shared connection
- []string
String list of tags
- organization
Id String ID of the organization responsible for the connection
- redundancy String
Connection redundancy - redundant or primary
- type String
Connection type - dedicated or shared
- description String
Description for the connection resource
- facility String
Facility where the connection will be created
- metro String
Metro where the connection will be created
- mode String
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name String
Name of the connection resource
- project
Id String ID of the project where the connection is scoped to, must be set for shared connection
- List<String>
String list of tags
- organization
Id string ID of the organization responsible for the connection
- redundancy string
Connection redundancy - redundant or primary
- type string
Connection type - dedicated or shared
- description string
Description for the connection resource
- facility string
Facility where the connection will be created
- metro string
Metro where the connection will be created
- mode string
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name string
Name of the connection resource
- project
Id string ID of the project where the connection is scoped to, must be set for shared connection
- string[]
String list of tags
- organization_
id str ID of the organization responsible for the connection
- redundancy str
Connection redundancy - redundant or primary
- type str
Connection type - dedicated or shared
- description str
Description for the connection resource
- facility str
Facility where the connection will be created
- metro str
Metro where the connection will be created
- mode str
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name str
Name of the connection resource
- project_
id str ID of the project where the connection is scoped to, must be set for shared connection
- Sequence[str]
String list of tags
- organization
Id String ID of the organization responsible for the connection
- redundancy String
Connection redundancy - redundant or primary
- type String
Connection type - dedicated or shared
- description String
Description for the connection resource
- facility String
Facility where the connection will be created
- metro String
Metro where the connection will be created
- mode String
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name String
Name of the connection resource
- project
Id String ID of the project where the connection is scoped to, must be set for shared connection
- List<String>
String list of tags
Outputs
All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Ports
List<Pulumi.
Equinix Metal. Outputs. Connection Port> List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- Speed int
Port speed in bits per second
- Status string
Status of the connection resource
- Token string
Fabric Token from the Equinix Fabric Portal
- Id string
The provider-assigned unique ID for this managed resource.
- Ports
[]Connection
Port List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- Speed int
Port speed in bits per second
- Status string
Status of the connection resource
- Token string
Fabric Token from the Equinix Fabric Portal
- id String
The provider-assigned unique ID for this managed resource.
- ports
List<Connection
Port> List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- speed Integer
Port speed in bits per second
- status String
Status of the connection resource
- token String
Fabric Token from the Equinix Fabric Portal
- id string
The provider-assigned unique ID for this managed resource.
- ports
Connection
Port[] List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- speed number
Port speed in bits per second
- status string
Status of the connection resource
- token string
Fabric Token from the Equinix Fabric Portal
- id str
The provider-assigned unique ID for this managed resource.
- ports
Sequence[Connection
Port] List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- speed int
Port speed in bits per second
- status str
Status of the connection resource
- token str
Fabric Token from the Equinix Fabric Portal
- 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.Connection datasource.- speed Number
Port speed in bits per second
- status String
Status of the connection resource
- token String
Fabric Token from the Equinix Fabric Portal
Look up Existing Connection Resource
Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = 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[ConnectionPortArgs]] = None,
project_id: Optional[str] = None,
redundancy: Optional[str] = None,
speed: Optional[int] = None,
status: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
token: Optional[str] = None,
type: Optional[str] = None) -> Connection
func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
public static Connection get(String name, Output<String> id, ConnectionState 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.
- Description string
Description for the connection resource
- Facility string
Facility where the connection will be created
- Metro string
Metro where the connection will be created
- Mode string
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- Name string
Name of the connection resource
- Organization
Id string ID of the organization responsible for the connection
- Ports
List<Pulumi.
Equinix Metal. Inputs. Connection Port> List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- Project
Id string ID of the project where the connection is scoped to, must be set for shared connection
- Redundancy string
Connection redundancy - redundant or primary
- Speed int
Port speed in bits per second
- Status string
Status of the connection resource
- List<string>
String list of tags
- Token string
Fabric Token from the Equinix Fabric Portal
- Type string
Connection type - dedicated or shared
- Description string
Description for the connection resource
- Facility string
Facility where the connection will be created
- Metro string
Metro where the connection will be created
- Mode string
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- Name string
Name of the connection resource
- Organization
Id string ID of the organization responsible for the connection
- Ports
[]Connection
Port Args List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- Project
Id string ID of the project where the connection is scoped to, must be set for shared connection
- Redundancy string
Connection redundancy - redundant or primary
- Speed int
Port speed in bits per second
- Status string
Status of the connection resource
- []string
String list of tags
- Token string
Fabric Token from the Equinix Fabric Portal
- Type string
Connection type - dedicated or shared
- description String
Description for the connection resource
- facility String
Facility where the connection will be created
- metro String
Metro where the connection will be created
- mode String
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name String
Name of the connection resource
- organization
Id String ID of the organization responsible for the connection
- ports
List<Connection
Port> List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- project
Id String ID of the project where the connection is scoped to, must be set for shared connection
- redundancy String
Connection redundancy - redundant or primary
- speed Integer
Port speed in bits per second
- status String
Status of the connection resource
- List<String>
String list of tags
- token String
Fabric Token from the Equinix Fabric Portal
- type String
Connection type - dedicated or shared
- description string
Description for the connection resource
- facility string
Facility where the connection will be created
- metro string
Metro where the connection will be created
- mode string
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name string
Name of the connection resource
- organization
Id string ID of the organization responsible for the connection
- ports
Connection
Port[] List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- project
Id string ID of the project where the connection is scoped to, must be set for shared connection
- redundancy string
Connection redundancy - redundant or primary
- speed number
Port speed in bits per second
- status string
Status of the connection resource
- string[]
String list of tags
- token string
Fabric Token from the Equinix Fabric Portal
- type string
Connection type - dedicated or shared
- description str
Description for the connection resource
- facility str
Facility where the connection will be created
- metro str
Metro where the connection will be created
- mode str
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name str
Name of the connection resource
- organization_
id str ID of the organization responsible for the connection
- ports
Sequence[Connection
Port Args] List of connection ports - primary (
ports[0]
) and secondary (ports[1]
). Schema of port is described in documentation of the equinix-metal.Connection datasource.- project_
id str ID of the project where the connection is scoped to, must be set for shared connection
- redundancy str
Connection redundancy - redundant or primary
- speed int
Port speed in bits per second
- status str
Status of the connection resource
- Sequence[str]
String list of tags
- token str
Fabric Token from the Equinix Fabric Portal
- type str
Connection type - dedicated or shared
- description String
Description for the connection resource
- facility String
Facility where the connection will be created
- metro String
Metro where the connection will be created
- mode String
Mode for connections in IBX facilities with the dedicated type - standard or tunnel
- name String
Name of the connection resource
- organization
Id String ID of the organization responsible for the connection
- 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.Connection datasource.- project
Id String ID of the project where the connection is scoped to, must be set for shared connection
- redundancy String
Connection redundancy - redundant or primary
- speed Number
Port speed in bits per second
- status String
Status of the connection resource
- List<String>
String list of tags
- token String
Fabric Token from the Equinix Fabric Portal
- type String
Connection type - dedicated or shared
Supporting Types
ConnectionPort, ConnectionPortArgs
- Id string
- Link
Status string - Name string
Name of the connection resource
- Role string
- Speed int
Port speed in bits per second
- 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
Port speed in bits per second
- 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
Port speed in bits per second
- 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
Port speed in bits per second
- 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
Port speed in bits per second
- 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
Port speed in bits per second
- status String
Status of the connection resource
- virtual
Circuit List<Any>Ids
Package Details
- Repository
- Equinix Metal pulumi/pulumi-equinix-metal
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
metal
Terraform Provider.
This package is deprecated. We recommend using the new Equinix package.