1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. CrossConnect
oci logo
Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.Core.CrossConnect

This resource provides the Cross Connect resource in Oracle Cloud Infrastructure Core service.

Creates a new cross-connect. Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection.

After creating the CrossConnect object, you need to go the FastConnect location and request to have the physical cable installed. For more information, see FastConnect Overview.

For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect to reside. If you’re not sure which compartment to use, put the cross-connect in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the cross-connect. It does not have to be unique, and you can change it. Avoid entering confidential information.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCrossConnect = new Oci.Core.CrossConnect("testCrossConnect", new()
    {
        CompartmentId = @var.Compartment_id,
        LocationName = @var.Cross_connect_location_name,
        PortSpeedShapeName = @var.Cross_connect_port_speed_shape_name,
        CrossConnectGroupId = oci_core_cross_connect_group.Test_cross_connect_group.Id,
        CustomerReferenceName = @var.Cross_connect_customer_reference_name,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Cross_connect_display_name,
        FarCrossConnectOrCrossConnectGroupId = oci_core_cross_connect_group.Test_cross_connect_group.Id,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        NearCrossConnectOrCrossConnectGroupId = oci_core_cross_connect_group.Test_cross_connect_group.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.NewCrossConnect(ctx, "testCrossConnect", &Core.CrossConnectArgs{
			CompartmentId:         pulumi.Any(_var.Compartment_id),
			LocationName:          pulumi.Any(_var.Cross_connect_location_name),
			PortSpeedShapeName:    pulumi.Any(_var.Cross_connect_port_speed_shape_name),
			CrossConnectGroupId:   pulumi.Any(oci_core_cross_connect_group.Test_cross_connect_group.Id),
			CustomerReferenceName: pulumi.Any(_var.Cross_connect_customer_reference_name),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName:                          pulumi.Any(_var.Cross_connect_display_name),
			FarCrossConnectOrCrossConnectGroupId: pulumi.Any(oci_core_cross_connect_group.Test_cross_connect_group.Id),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			NearCrossConnectOrCrossConnectGroupId: pulumi.Any(oci_core_cross_connect_group.Test_cross_connect_group.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CrossConnect;
import com.pulumi.oci.Core.CrossConnectArgs;
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) {
        var testCrossConnect = new CrossConnect("testCrossConnect", CrossConnectArgs.builder()        
            .compartmentId(var_.compartment_id())
            .locationName(var_.cross_connect_location_name())
            .portSpeedShapeName(var_.cross_connect_port_speed_shape_name())
            .crossConnectGroupId(oci_core_cross_connect_group.test_cross_connect_group().id())
            .customerReferenceName(var_.cross_connect_customer_reference_name())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.cross_connect_display_name())
            .farCrossConnectOrCrossConnectGroupId(oci_core_cross_connect_group.test_cross_connect_group().id())
            .freeformTags(Map.of("Department", "Finance"))
            .nearCrossConnectOrCrossConnectGroupId(oci_core_cross_connect_group.test_cross_connect_group().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_cross_connect = oci.core.CrossConnect("testCrossConnect",
    compartment_id=var["compartment_id"],
    location_name=var["cross_connect_location_name"],
    port_speed_shape_name=var["cross_connect_port_speed_shape_name"],
    cross_connect_group_id=oci_core_cross_connect_group["test_cross_connect_group"]["id"],
    customer_reference_name=var["cross_connect_customer_reference_name"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["cross_connect_display_name"],
    far_cross_connect_or_cross_connect_group_id=oci_core_cross_connect_group["test_cross_connect_group"]["id"],
    freeform_tags={
        "Department": "Finance",
    },
    near_cross_connect_or_cross_connect_group_id=oci_core_cross_connect_group["test_cross_connect_group"]["id"])

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCrossConnect = new oci.core.CrossConnect("testCrossConnect", {
    compartmentId: _var.compartment_id,
    locationName: _var.cross_connect_location_name,
    portSpeedShapeName: _var.cross_connect_port_speed_shape_name,
    crossConnectGroupId: oci_core_cross_connect_group.test_cross_connect_group.id,
    customerReferenceName: _var.cross_connect_customer_reference_name,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.cross_connect_display_name,
    farCrossConnectOrCrossConnectGroupId: oci_core_cross_connect_group.test_cross_connect_group.id,
    freeformTags: {
        Department: "Finance",
    },
    nearCrossConnectOrCrossConnectGroupId: oci_core_cross_connect_group.test_cross_connect_group.id,
});

resources:
  testCrossConnect:
    type: oci:Core:CrossConnect
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      locationName: ${var.cross_connect_location_name}
      portSpeedShapeName: ${var.cross_connect_port_speed_shape_name}
      #Optional
      crossConnectGroupId: ${oci_core_cross_connect_group.test_cross_connect_group.id}
      customerReferenceName: ${var.cross_connect_customer_reference_name}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${var.cross_connect_display_name}
      farCrossConnectOrCrossConnectGroupId: ${oci_core_cross_connect_group.test_cross_connect_group.id}
      freeformTags:
        Department: Finance
      nearCrossConnectOrCrossConnectGroupId: ${oci_core_cross_connect_group.test_cross_connect_group.id}

Create CrossConnect Resource

new CrossConnect(name: string, args: CrossConnectArgs, opts?: CustomResourceOptions);
@overload
def CrossConnect(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 cross_connect_group_id: Optional[str] = None,
                 customer_reference_name: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, Any]] = None,
                 display_name: Optional[str] = None,
                 far_cross_connect_or_cross_connect_group_id: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, Any]] = None,
                 is_active: Optional[bool] = None,
                 location_name: Optional[str] = None,
                 macsec_properties: Optional[_core.CrossConnectMacsecPropertiesArgs] = None,
                 near_cross_connect_or_cross_connect_group_id: Optional[str] = None,
                 port_speed_shape_name: Optional[str] = None)
@overload
def CrossConnect(resource_name: str,
                 args: CrossConnectArgs,
                 opts: Optional[ResourceOptions] = None)
func NewCrossConnect(ctx *Context, name string, args CrossConnectArgs, opts ...ResourceOption) (*CrossConnect, error)
public CrossConnect(string name, CrossConnectArgs args, CustomResourceOptions? opts = null)
public CrossConnect(String name, CrossConnectArgs args)
public CrossConnect(String name, CrossConnectArgs args, CustomResourceOptions options)

type: oci:Core:CrossConnect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CrossConnectArgs
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 CrossConnectArgs
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 CrossConnectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CrossConnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CrossConnectArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CrossConnect 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 CrossConnect resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment to contain the cross-connect.

LocationName string

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

PortSpeedShapeName string

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

CrossConnectGroupId string

The OCID of the cross-connect group to put this cross-connect in.

CustomerReferenceName string

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FarCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsActive bool

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

MacsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

NearCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

CompartmentId string

(Updatable) The OCID of the compartment to contain the cross-connect.

LocationName string

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

PortSpeedShapeName string

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

CrossConnectGroupId string

The OCID of the cross-connect group to put this cross-connect in.

CustomerReferenceName string

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FarCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsActive bool

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

MacsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

NearCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

compartmentId String

(Updatable) The OCID of the compartment to contain the cross-connect.

locationName String

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

portSpeedShapeName String

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

crossConnectGroupId String

The OCID of the cross-connect group to put this cross-connect in.

customerReferenceName String

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

farCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

isActive Boolean

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

macsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

nearCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

compartmentId string

(Updatable) The OCID of the compartment to contain the cross-connect.

locationName string

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

portSpeedShapeName string

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

crossConnectGroupId string

The OCID of the cross-connect group to put this cross-connect in.

customerReferenceName string

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

farCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

isActive boolean

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

macsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

nearCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

compartment_id str

(Updatable) The OCID of the compartment to contain the cross-connect.

location_name str

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

port_speed_shape_name str

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

cross_connect_group_id str

The OCID of the cross-connect group to put this cross-connect in.

customer_reference_name str

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

far_cross_connect_or_cross_connect_group_id str

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

is_active bool

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

macsec_properties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

near_cross_connect_or_cross_connect_group_id str

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

compartmentId String

(Updatable) The OCID of the compartment to contain the cross-connect.

locationName String

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

portSpeedShapeName String

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

crossConnectGroupId String

The OCID of the cross-connect group to put this cross-connect in.

customerReferenceName String

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

farCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

isActive Boolean

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

macsecProperties Property Map

Properties used for MACsec (if capable).

nearCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

OciLogicalDeviceName string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

OciPhysicalDeviceName string

The FastConnect device that terminates the physical connection.

PortName string

A string identifying the meet-me room port for this cross-connect.

State string

The cross-connect's current state.

TimeCreated string

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Id string

The provider-assigned unique ID for this managed resource.

OciLogicalDeviceName string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

OciPhysicalDeviceName string

The FastConnect device that terminates the physical connection.

PortName string

A string identifying the meet-me room port for this cross-connect.

State string

The cross-connect's current state.

TimeCreated string

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

ociLogicalDeviceName String

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

ociPhysicalDeviceName String

The FastConnect device that terminates the physical connection.

portName String

A string identifying the meet-me room port for this cross-connect.

state String

The cross-connect's current state.

timeCreated String

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id string

The provider-assigned unique ID for this managed resource.

ociLogicalDeviceName string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

ociPhysicalDeviceName string

The FastConnect device that terminates the physical connection.

portName string

A string identifying the meet-me room port for this cross-connect.

state string

The cross-connect's current state.

timeCreated string

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id str

The provider-assigned unique ID for this managed resource.

oci_logical_device_name str

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

oci_physical_device_name str

The FastConnect device that terminates the physical connection.

port_name str

A string identifying the meet-me room port for this cross-connect.

state str

The cross-connect's current state.

time_created str

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

ociLogicalDeviceName String

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

ociPhysicalDeviceName String

The FastConnect device that terminates the physical connection.

portName String

A string identifying the meet-me room port for this cross-connect.

state String

The cross-connect's current state.

timeCreated String

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing CrossConnect Resource

Get an existing CrossConnect 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?: CrossConnectState, opts?: CustomResourceOptions): CrossConnect
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        cross_connect_group_id: Optional[str] = None,
        customer_reference_name: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        far_cross_connect_or_cross_connect_group_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_active: Optional[bool] = None,
        location_name: Optional[str] = None,
        macsec_properties: Optional[_core.CrossConnectMacsecPropertiesArgs] = None,
        near_cross_connect_or_cross_connect_group_id: Optional[str] = None,
        oci_logical_device_name: Optional[str] = None,
        oci_physical_device_name: Optional[str] = None,
        port_name: Optional[str] = None,
        port_speed_shape_name: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None) -> CrossConnect
func GetCrossConnect(ctx *Context, name string, id IDInput, state *CrossConnectState, opts ...ResourceOption) (*CrossConnect, error)
public static CrossConnect Get(string name, Input<string> id, CrossConnectState? state, CustomResourceOptions? opts = null)
public static CrossConnect get(String name, Output<String> id, CrossConnectState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string

(Updatable) The OCID of the compartment to contain the cross-connect.

CrossConnectGroupId string

The OCID of the cross-connect group to put this cross-connect in.

CustomerReferenceName string

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FarCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsActive bool

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

LocationName string

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

MacsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

NearCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

OciLogicalDeviceName string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

OciPhysicalDeviceName string

The FastConnect device that terminates the physical connection.

PortName string

A string identifying the meet-me room port for this cross-connect.

PortSpeedShapeName string

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

State string

The cross-connect's current state.

TimeCreated string

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CompartmentId string

(Updatable) The OCID of the compartment to contain the cross-connect.

CrossConnectGroupId string

The OCID of the cross-connect group to put this cross-connect in.

CustomerReferenceName string

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FarCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsActive bool

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

LocationName string

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

MacsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

NearCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

OciLogicalDeviceName string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

OciPhysicalDeviceName string

The FastConnect device that terminates the physical connection.

PortName string

A string identifying the meet-me room port for this cross-connect.

PortSpeedShapeName string

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

State string

The cross-connect's current state.

TimeCreated string

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String

(Updatable) The OCID of the compartment to contain the cross-connect.

crossConnectGroupId String

The OCID of the cross-connect group to put this cross-connect in.

customerReferenceName String

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

farCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

isActive Boolean

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

locationName String

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

macsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

nearCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

ociLogicalDeviceName String

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

ociPhysicalDeviceName String

The FastConnect device that terminates the physical connection.

portName String

A string identifying the meet-me room port for this cross-connect.

portSpeedShapeName String

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

state String

The cross-connect's current state.

timeCreated String

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId string

(Updatable) The OCID of the compartment to contain the cross-connect.

crossConnectGroupId string

The OCID of the cross-connect group to put this cross-connect in.

customerReferenceName string

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

farCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

isActive boolean

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

locationName string

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

macsecProperties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

nearCrossConnectOrCrossConnectGroupId string

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

ociLogicalDeviceName string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

ociPhysicalDeviceName string

The FastConnect device that terminates the physical connection.

portName string

A string identifying the meet-me room port for this cross-connect.

portSpeedShapeName string

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

state string

The cross-connect's current state.

timeCreated string

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartment_id str

(Updatable) The OCID of the compartment to contain the cross-connect.

cross_connect_group_id str

The OCID of the cross-connect group to put this cross-connect in.

customer_reference_name str

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

far_cross_connect_or_cross_connect_group_id str

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

is_active bool

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

location_name str

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

macsec_properties CrossConnectMacsecPropertiesArgs

Properties used for MACsec (if capable).

near_cross_connect_or_cross_connect_group_id str

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

oci_logical_device_name str

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

oci_physical_device_name str

The FastConnect device that terminates the physical connection.

port_name str

A string identifying the meet-me room port for this cross-connect.

port_speed_shape_name str

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

state str

The cross-connect's current state.

time_created str

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String

(Updatable) The OCID of the compartment to contain the cross-connect.

crossConnectGroupId String

The OCID of the cross-connect group to put this cross-connect in.

customerReferenceName String

(Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

farCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

isActive Boolean

(Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready.

locationName String

The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see ListCrossConnectLocations. Example: CyrusOne, Chandler, AZ

macsecProperties Property Map

Properties used for MACsec (if capable).

nearCrossConnectOrCrossConnectGroupId String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

ociLogicalDeviceName String

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

ociPhysicalDeviceName String

The FastConnect device that terminates the physical connection.

portName String

A string identifying the meet-me room port for this cross-connect.

portSpeedShapeName String

The port speed for this cross-connect. To get a list of the available port speeds, see ListCrossConnectPortSpeedShapes. Example: 10 Gbps

state String

The cross-connect's current state.

timeCreated String

The date and time the cross-connect was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Supporting Types

CrossConnectMacsecProperties

State string

The cross-connect's current state.

EncryptionCipher string

Type of encryption cipher suite to use for the MACsec connection.

PrimaryKey CrossConnectMacsecPropertiesPrimaryKey

An object defining the Secrets-in-Vault OCIDs representing the MACsec key.

State string

The cross-connect's current state.

EncryptionCipher string

Type of encryption cipher suite to use for the MACsec connection.

PrimaryKey CrossConnectMacsecPropertiesPrimaryKey

An object defining the Secrets-in-Vault OCIDs representing the MACsec key.

state String

The cross-connect's current state.

encryptionCipher String

Type of encryption cipher suite to use for the MACsec connection.

primaryKey CrossConnectMacsecPropertiesPrimaryKey

An object defining the Secrets-in-Vault OCIDs representing the MACsec key.

state string

The cross-connect's current state.

encryptionCipher string

Type of encryption cipher suite to use for the MACsec connection.

primaryKey CrossConnectMacsecPropertiesPrimaryKey

An object defining the Secrets-in-Vault OCIDs representing the MACsec key.

state str

The cross-connect's current state.

encryption_cipher str

Type of encryption cipher suite to use for the MACsec connection.

primary_key CrossConnectMacsecPropertiesPrimaryKey

An object defining the Secrets-in-Vault OCIDs representing the MACsec key.

state String

The cross-connect's current state.

encryptionCipher String

Type of encryption cipher suite to use for the MACsec connection.

primaryKey Property Map

An object defining the Secrets-in-Vault OCIDs representing the MACsec key.

CrossConnectMacsecPropertiesPrimaryKey

ConnectivityAssociationKeySecretId string

Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

ConnectivityAssociationNameSecretId string

Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

ConnectivityAssociationKeySecretVersion string

The secret version of the connectivityAssociationKey secret in Vault.

ConnectivityAssociationNameSecretVersion string

The secret version of the connectivity association name secret in Vault.

ConnectivityAssociationKeySecretId string

Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

ConnectivityAssociationNameSecretId string

Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

ConnectivityAssociationKeySecretVersion string

The secret version of the connectivityAssociationKey secret in Vault.

ConnectivityAssociationNameSecretVersion string

The secret version of the connectivity association name secret in Vault.

connectivityAssociationKeySecretId String

Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

connectivityAssociationNameSecretId String

Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

connectivityAssociationKeySecretVersion String

The secret version of the connectivityAssociationKey secret in Vault.

connectivityAssociationNameSecretVersion String

The secret version of the connectivity association name secret in Vault.

connectivityAssociationKeySecretId string

Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

connectivityAssociationNameSecretId string

Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

connectivityAssociationKeySecretVersion string

The secret version of the connectivityAssociationKey secret in Vault.

connectivityAssociationNameSecretVersion string

The secret version of the connectivity association name secret in Vault.

connectivity_association_key_secret_id str

Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

connectivity_association_name_secret_id str

Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

connectivity_association_key_secret_version str

The secret version of the connectivityAssociationKey secret in Vault.

connectivity_association_name_secret_version str

The secret version of the connectivity association name secret in Vault.

connectivityAssociationKeySecretId String

Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

connectivityAssociationNameSecretId String

Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

connectivityAssociationKeySecretVersion String

The secret version of the connectivityAssociationKey secret in Vault.

connectivityAssociationNameSecretVersion String

The secret version of the connectivity association name secret in Vault.

Import

CrossConnects can be imported using the id, e.g.

 $ pulumi import oci:Core/crossConnect:CrossConnect test_cross_connect "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.