1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getCrossConnect
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Core.getCrossConnect

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides details about a specific Cross Connect resource in Oracle Cloud Infrastructure Core service.

Gets the specified cross-connect’s information.

Example Usage

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

const testCrossConnect = oci.Core.getCrossConnect({
    crossConnectId: testCrossConnectOciCoreCrossConnect.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_cross_connect = oci.Core.get_cross_connect(cross_connect_id=test_cross_connect_oci_core_cross_connect["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetCrossConnect(ctx, &core.GetCrossConnectArgs{
			CrossConnectId: testCrossConnectOciCoreCrossConnect.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCrossConnect = Oci.Core.GetCrossConnect.Invoke(new()
    {
        CrossConnectId = testCrossConnectOciCoreCrossConnect.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetCrossConnectArgs;
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 testCrossConnect = CoreFunctions.getCrossConnect(GetCrossConnectArgs.builder()
            .crossConnectId(testCrossConnectOciCoreCrossConnect.id())
            .build());

    }
}
Copy
variables:
  testCrossConnect:
    fn::invoke:
      function: oci:Core:getCrossConnect
      arguments:
        crossConnectId: ${testCrossConnectOciCoreCrossConnect.id}
Copy

Using getCrossConnect

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 getCrossConnect(args: GetCrossConnectArgs, opts?: InvokeOptions): Promise<GetCrossConnectResult>
function getCrossConnectOutput(args: GetCrossConnectOutputArgs, opts?: InvokeOptions): Output<GetCrossConnectResult>
Copy
def get_cross_connect(cross_connect_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCrossConnectResult
def get_cross_connect_output(cross_connect_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCrossConnectResult]
Copy
func GetCrossConnect(ctx *Context, args *GetCrossConnectArgs, opts ...InvokeOption) (*GetCrossConnectResult, error)
func GetCrossConnectOutput(ctx *Context, args *GetCrossConnectOutputArgs, opts ...InvokeOption) GetCrossConnectResultOutput
Copy

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

public static class GetCrossConnect 
{
    public static Task<GetCrossConnectResult> InvokeAsync(GetCrossConnectArgs args, InvokeOptions? opts = null)
    public static Output<GetCrossConnectResult> Invoke(GetCrossConnectInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCrossConnectResult> getCrossConnect(GetCrossConnectArgs args, InvokeOptions options)
public static Output<GetCrossConnectResult> getCrossConnect(GetCrossConnectArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Core/getCrossConnect:getCrossConnect
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CrossConnectId This property is required. string
The OCID of the cross-connect.
CrossConnectId This property is required. string
The OCID of the cross-connect.
crossConnectId This property is required. String
The OCID of the cross-connect.
crossConnectId This property is required. string
The OCID of the cross-connect.
cross_connect_id This property is required. str
The OCID of the cross-connect.
crossConnectId This property is required. String
The OCID of the cross-connect.

getCrossConnect Result

The following output properties are available:

CompartmentId string
The OCID of the compartment containing the cross-connect group.
CrossConnectGroupId string
The OCID of the cross-connect group this cross-connect belongs to (if any).
CrossConnectId string
CustomerReferenceName string
A reference name or identifier for the physical fiber connection that this cross-connect uses.
DefinedTags Dictionary<string, string>
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FarCrossConnectOrCrossConnectGroupId string
FreeformTags Dictionary<string, string>
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"}
Id string
The cross-connect's Oracle ID (OCID).
IsActive bool
LocationName string
The name of the FastConnect location where this cross-connect is installed.
MacsecProperties List<GetCrossConnectMacsecProperty>
Properties used for MACsec (if capable).
NearCrossConnectOrCrossConnectGroupId string
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. 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
The OCID of the compartment containing the cross-connect group.
CrossConnectGroupId string
The OCID of the cross-connect group this cross-connect belongs to (if any).
CrossConnectId string
CustomerReferenceName string
A reference name or identifier for the physical fiber connection that this cross-connect uses.
DefinedTags map[string]string
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FarCrossConnectOrCrossConnectGroupId string
FreeformTags map[string]string
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"}
Id string
The cross-connect's Oracle ID (OCID).
IsActive bool
LocationName string
The name of the FastConnect location where this cross-connect is installed.
MacsecProperties []GetCrossConnectMacsecProperty
Properties used for MACsec (if capable).
NearCrossConnectOrCrossConnectGroupId string
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. 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
The OCID of the compartment containing the cross-connect group.
crossConnectGroupId String
The OCID of the cross-connect group this cross-connect belongs to (if any).
crossConnectId String
customerReferenceName String
A reference name or identifier for the physical fiber connection that this cross-connect uses.
definedTags Map<String,String>
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
farCrossConnectOrCrossConnectGroupId String
freeformTags Map<String,String>
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"}
id String
The cross-connect's Oracle ID (OCID).
isActive Boolean
locationName String
The name of the FastConnect location where this cross-connect is installed.
macsecProperties List<GetCrossConnectMacsecProperty>
Properties used for MACsec (if capable).
nearCrossConnectOrCrossConnectGroupId String
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. 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
The OCID of the compartment containing the cross-connect group.
crossConnectGroupId string
The OCID of the cross-connect group this cross-connect belongs to (if any).
crossConnectId string
customerReferenceName string
A reference name or identifier for the physical fiber connection that this cross-connect uses.
definedTags {[key: string]: string}
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
farCrossConnectOrCrossConnectGroupId string
freeformTags {[key: string]: string}
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"}
id string
The cross-connect's Oracle ID (OCID).
isActive boolean
locationName string
The name of the FastConnect location where this cross-connect is installed.
macsecProperties GetCrossConnectMacsecProperty[]
Properties used for MACsec (if capable).
nearCrossConnectOrCrossConnectGroupId string
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. 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
The OCID of the compartment containing the cross-connect group.
cross_connect_group_id str
The OCID of the cross-connect group this cross-connect belongs to (if any).
cross_connect_id str
customer_reference_name str
A reference name or identifier for the physical fiber connection that this cross-connect uses.
defined_tags Mapping[str, str]
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
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
freeform_tags Mapping[str, str]
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"}
id str
The cross-connect's Oracle ID (OCID).
is_active bool
location_name str
The name of the FastConnect location where this cross-connect is installed.
macsec_properties Sequence[core.GetCrossConnectMacsecProperty]
Properties used for MACsec (if capable).
near_cross_connect_or_cross_connect_group_id str
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. 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
The OCID of the compartment containing the cross-connect group.
crossConnectGroupId String
The OCID of the cross-connect group this cross-connect belongs to (if any).
crossConnectId String
customerReferenceName String
A reference name or identifier for the physical fiber connection that this cross-connect uses.
definedTags Map<String>
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
farCrossConnectOrCrossConnectGroupId String
freeformTags Map<String>
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"}
id String
The cross-connect's Oracle ID (OCID).
isActive Boolean
locationName String
The name of the FastConnect location where this cross-connect is installed.
macsecProperties List<Property Map>
Properties used for MACsec (if capable).
nearCrossConnectOrCrossConnectGroupId String
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. 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

GetCrossConnectMacsecProperty

EncryptionCipher This property is required. string
Type of encryption cipher suite to use for the MACsec connection.
IsUnprotectedTrafficAllowed This property is required. bool
Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
PrimaryKeys This property is required. List<GetCrossConnectMacsecPropertyPrimaryKey>
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
State This property is required. string
The cross-connect's current state.
EncryptionCipher This property is required. string
Type of encryption cipher suite to use for the MACsec connection.
IsUnprotectedTrafficAllowed This property is required. bool
Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
PrimaryKeys This property is required. []GetCrossConnectMacsecPropertyPrimaryKey
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
State This property is required. string
The cross-connect's current state.
encryptionCipher This property is required. String
Type of encryption cipher suite to use for the MACsec connection.
isUnprotectedTrafficAllowed This property is required. Boolean
Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
primaryKeys This property is required. List<GetCrossConnectMacsecPropertyPrimaryKey>
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state This property is required. String
The cross-connect's current state.
encryptionCipher This property is required. string
Type of encryption cipher suite to use for the MACsec connection.
isUnprotectedTrafficAllowed This property is required. boolean
Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
primaryKeys This property is required. GetCrossConnectMacsecPropertyPrimaryKey[]
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state This property is required. string
The cross-connect's current state.
encryption_cipher This property is required. str
Type of encryption cipher suite to use for the MACsec connection.
is_unprotected_traffic_allowed This property is required. bool
Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
primary_keys This property is required. Sequence[core.GetCrossConnectMacsecPropertyPrimaryKey]
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state This property is required. str
The cross-connect's current state.
encryptionCipher This property is required. String
Type of encryption cipher suite to use for the MACsec connection.
isUnprotectedTrafficAllowed This property is required. Boolean
Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
primaryKeys This property is required. List<Property Map>
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state This property is required. String
The cross-connect's current state.

GetCrossConnectMacsecPropertyPrimaryKey

ConnectivityAssociationKeySecretId This property is required. string
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
ConnectivityAssociationKeySecretVersion This property is required. string
The secret version of the connectivityAssociationKey secret in Vault.
ConnectivityAssociationNameSecretId This property is required. string
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
ConnectivityAssociationNameSecretVersion This property is required. string
The secret version of the connectivity association name secret in Vault.
ConnectivityAssociationKeySecretId This property is required. string
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
ConnectivityAssociationKeySecretVersion This property is required. string
The secret version of the connectivityAssociationKey secret in Vault.
ConnectivityAssociationNameSecretId This property is required. string
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
ConnectivityAssociationNameSecretVersion This property is required. string
The secret version of the connectivity association name secret in Vault.
connectivityAssociationKeySecretId This property is required. String
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivityAssociationKeySecretVersion This property is required. String
The secret version of the connectivityAssociationKey secret in Vault.
connectivityAssociationNameSecretId This property is required. String
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivityAssociationNameSecretVersion This property is required. String
The secret version of the connectivity association name secret in Vault.
connectivityAssociationKeySecretId This property is required. string
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivityAssociationKeySecretVersion This property is required. string
The secret version of the connectivityAssociationKey secret in Vault.
connectivityAssociationNameSecretId This property is required. string
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivityAssociationNameSecretVersion This property is required. string
The secret version of the connectivity association name secret in Vault.
connectivity_association_key_secret_id This property is required. str
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivity_association_key_secret_version This property is required. str
The secret version of the connectivityAssociationKey secret in Vault.
connectivity_association_name_secret_id This property is required. str
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivity_association_name_secret_version This property is required. str
The secret version of the connectivity association name secret in Vault.
connectivityAssociationKeySecretId This property is required. String
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivityAssociationKeySecretVersion This property is required. String
The secret version of the connectivityAssociationKey secret in Vault.
connectivityAssociationNameSecretId This property is required. String
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivityAssociationNameSecretVersion This property is required. String
The secret version of the connectivity association name secret in Vault.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi