Equinix Metal

v3.2.1 published on Thursday, Dec 30, 2021 by Pulumi

getConnection

Use this data source to retrieve a connection resource from Equinix Fabric - software-defined interconnections

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(EquinixMetal.GetConnection.InvokeAsync(new EquinixMetal.GetConnectionArgs
        {
            ConnectionId = "4347e805-eb46-4699-9eb9-5c116e6a017d",
        }));
    }

}
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.LookupConnection(ctx, &GetConnectionArgs{
			ConnectionId: "4347e805-eb46-4699-9eb9-5c116e6a017d",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_equinix_metal as equinix_metal

example = equinix_metal.get_connection(connection_id="4347e805-eb46-4699-9eb9-5c116e6a017d")
import * as pulumi from "@pulumi/pulumi";
import * as metal from "@pulumi/metal";

const example = pulumi.output(metal.getConnection({
    connectionId: "4347e805-eb46-4699-9eb9-5c116e6a017d",
}));

Coming soon!

Using getConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
def get_connection(connection_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

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

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: equinix-metal:index/getConnection:getConnection
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ConnectionId string

ID of the connection resource

ConnectionId string

ID of the connection resource

connectionId String

ID of the connection resource

connectionId string

ID of the connection resource

connection_id str

ID of the connection resource

connectionId String

ID of the connection resource

getConnection Result

The following output properties are available:

ConnectionId string
Description string

Description of the connection resource

Facility string

Slug of a facility to which the connection belongs

Id string

The provider-assigned unique ID for this managed resource.

Metro string

Slug of a metro to which the connection belongs

Mode string

Mode for connections in IBX facilities with the dedicated type - standard or tunnel

Name string

Port name

OrganizationId string

ID of organization to which the connection belongs

Ports List<Pulumi.EquinixMetal.Outputs.GetConnectionPort>

List of connection ports - primary (ports[0]) and secondary (ports[1])

ProjectId string

ID of project to which the connection belongs

Redundancy string

Connection redundancy, reduntant or primary

Speed int

Port speed in bits per second

Status string

Port status

Tags List<string>

String list of tags

Token string

Fabric Token for the Equinix Fabric Portal

Type string

Connection type, dedicated or shared

ConnectionId string
Description string

Description of the connection resource

Facility string

Slug of a facility to which the connection belongs

Id string

The provider-assigned unique ID for this managed resource.

Metro string

Slug of a metro to which the connection belongs

Mode string

Mode for connections in IBX facilities with the dedicated type - standard or tunnel

Name string

Port name

OrganizationId string

ID of organization to which the connection belongs

Ports []GetConnectionPort

List of connection ports - primary (ports[0]) and secondary (ports[1])

ProjectId string

ID of project to which the connection belongs

Redundancy string

Connection redundancy, reduntant or primary

Speed int

Port speed in bits per second

Status string

Port status

Tags []string

String list of tags

Token string

Fabric Token for the Equinix Fabric Portal

Type string

Connection type, dedicated or shared

connectionId String
description String

Description of the connection resource

facility String

Slug of a facility to which the connection belongs

id String

The provider-assigned unique ID for this managed resource.

metro String

Slug of a metro to which the connection belongs

mode String

Mode for connections in IBX facilities with the dedicated type - standard or tunnel

name String

Port name

organizationId String

ID of organization to which the connection belongs

ports List<GetConnectionPort>

List of connection ports - primary (ports[0]) and secondary (ports[1])

projectId String

ID of project to which the connection belongs

redundancy String

Connection redundancy, reduntant or primary

speed Integer

Port speed in bits per second

status String

Port status

tags List<String>

String list of tags

token String

Fabric Token for the Equinix Fabric Portal

type String

Connection type, dedicated or shared

connectionId string
description string

Description of the connection resource

facility string

Slug of a facility to which the connection belongs

id string

The provider-assigned unique ID for this managed resource.

metro string

Slug of a metro to which the connection belongs

mode string

Mode for connections in IBX facilities with the dedicated type - standard or tunnel

name string

Port name

organizationId string

ID of organization to which the connection belongs

ports GetConnectionPort[]

List of connection ports - primary (ports[0]) and secondary (ports[1])

projectId string

ID of project to which the connection belongs

redundancy string

Connection redundancy, reduntant or primary

speed number

Port speed in bits per second

status string

Port status

tags string[]

String list of tags

token string

Fabric Token for the Equinix Fabric Portal

type string

Connection type, dedicated or shared

connection_id str
description str

Description of the connection resource

facility str

Slug of a facility to which the connection belongs

id str

The provider-assigned unique ID for this managed resource.

metro str

Slug of a metro to which the connection belongs

mode str

Mode for connections in IBX facilities with the dedicated type - standard or tunnel

name str

Port name

organization_id str

ID of organization to which the connection belongs

ports Sequence[GetConnectionPort]

List of connection ports - primary (ports[0]) and secondary (ports[1])

project_id str

ID of project to which the connection belongs

redundancy str

Connection redundancy, reduntant or primary

speed int

Port speed in bits per second

status str

Port status

tags Sequence[str]

String list of tags

token str

Fabric Token for the Equinix Fabric Portal

type str

Connection type, dedicated or shared

connectionId String
description String

Description of the connection resource

facility String

Slug of a facility to which the connection belongs

id String

The provider-assigned unique ID for this managed resource.

metro String

Slug of a metro to which the connection belongs

mode String

Mode for connections in IBX facilities with the dedicated type - standard or tunnel

name String

Port name

organizationId String

ID of organization to which the connection belongs

ports List<Property Map>

List of connection ports - primary (ports[0]) and secondary (ports[1])

projectId String

ID of project to which the connection belongs

redundancy String

Connection redundancy, reduntant or primary

speed Number

Port speed in bits per second

status String

Port status

tags List<String>

String list of tags

token String

Fabric Token for the Equinix Fabric Portal

type String

Connection type, dedicated or shared

Supporting Types

GetConnectionPort

Id string

Port UUID

LinkStatus string

Port link status

Name string

Port name

Role string

Port role - primary or secondary

Speed int

Port speed in bits per second

Status string

Port status

VirtualCircuitIds List<object>

List of IDs of virtual cicruits attached to this port

Id string

Port UUID

LinkStatus string

Port link status

Name string

Port name

Role string

Port role - primary or secondary

Speed int

Port speed in bits per second

Status string

Port status

VirtualCircuitIds []interface{}

List of IDs of virtual cicruits attached to this port

id String

Port UUID

linkStatus String

Port link status

name String

Port name

role String

Port role - primary or secondary

speed Integer

Port speed in bits per second

status String

Port status

virtualCircuitIds List<Object>

List of IDs of virtual cicruits attached to this port

id string

Port UUID

linkStatus string

Port link status

name string

Port name

role string

Port role - primary or secondary

speed number

Port speed in bits per second

status string

Port status

virtualCircuitIds any[]

List of IDs of virtual cicruits attached to this port

id str

Port UUID

link_status str

Port link status

name str

Port name

role str

Port role - primary or secondary

speed int

Port speed in bits per second

status str

Port status

virtual_circuit_ids Sequence[Any]

List of IDs of virtual cicruits attached to this port

id String

Port UUID

linkStatus String

Port link status

name String

Port name

role String

Port role - primary or secondary

speed Number

Port speed in bits per second

status String

Port status

virtualCircuitIds List<Any>

List of IDs of virtual cicruits attached to this port

Package Details

Repository
https://github.com/pulumi/pulumi-equinix-metal
License
Apache-2.0
Notes

This Pulumi package is based on the metal Terraform Provider.