Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getCrossConnects

This data source provides the list of Cross Connects in Oracle Cloud Infrastructure Core service.

Lists the cross-connects in the specified compartment. You can filter the list by specifying the OCID of a cross-connect group.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testCrossConnects = Output.Create(Oci.Core.GetCrossConnects.InvokeAsync(new Oci.Core.GetCrossConnectsArgs
        {
            CompartmentId = @var.Compartment_id,
            CrossConnectGroupId = oci_core_cross_connect_group.Test_cross_connect_group.Id,
            DisplayName = @var.Cross_connect_display_name,
            State = @var.Cross_connect_state,
        }));
    }

}
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.GetCrossConnects(ctx, &core.GetCrossConnectsArgs{
			CompartmentId:       _var.Compartment_id,
			CrossConnectGroupId: pulumi.StringRef(oci_core_cross_connect_group.Test_cross_connect_group.Id),
			DisplayName:         pulumi.StringRef(_var.Cross_connect_display_name),
			State:               pulumi.StringRef(_var.Cross_connect_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_cross_connects = oci.Core.get_cross_connects(compartment_id=var["compartment_id"],
    cross_connect_group_id=oci_core_cross_connect_group["test_cross_connect_group"]["id"],
    display_name=var["cross_connect_display_name"],
    state=var["cross_connect_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCrossConnects = oci.Core.getCrossConnects({
    compartmentId: _var.compartment_id,
    crossConnectGroupId: oci_core_cross_connect_group.test_cross_connect_group.id,
    displayName: _var.cross_connect_display_name,
    state: _var.cross_connect_state,
});

Coming soon!

Using getCrossConnects

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 getCrossConnects(args: GetCrossConnectsArgs, opts?: InvokeOptions): Promise<GetCrossConnectsResult>
function getCrossConnectsOutput(args: GetCrossConnectsOutputArgs, opts?: InvokeOptions): Output<GetCrossConnectsResult>
def get_cross_connects(compartment_id: Optional[str] = None,
                       cross_connect_group_id: Optional[str] = None,
                       display_name: Optional[str] = None,
                       filters: Optional[Sequence[_core.GetCrossConnectsFilter]] = None,
                       state: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCrossConnectsResult
def get_cross_connects_output(compartment_id: Optional[pulumi.Input[str]] = None,
                       cross_connect_group_id: Optional[pulumi.Input[str]] = None,
                       display_name: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetCrossConnectsFilterArgs]]]] = None,
                       state: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCrossConnectsResult]
func GetCrossConnects(ctx *Context, args *GetCrossConnectsArgs, opts ...InvokeOption) (*GetCrossConnectsResult, error)
func GetCrossConnectsOutput(ctx *Context, args *GetCrossConnectsOutputArgs, opts ...InvokeOption) GetCrossConnectsResultOutput

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

public static class GetCrossConnects 
{
    public static Task<GetCrossConnectsResult> InvokeAsync(GetCrossConnectsArgs args, InvokeOptions? opts = null)
    public static Output<GetCrossConnectsResult> Invoke(GetCrossConnectsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCrossConnectsResult> getCrossConnects(GetCrossConnectsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Core/getCrossConnects:getCrossConnects
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment.

CrossConnectGroupId string

The OCID of the cross-connect group.

DisplayName string

A filter to return only resources that match the given display name exactly.

Filters List<GetCrossConnectsFilter>
State string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

CompartmentId string

The OCID of the compartment.

CrossConnectGroupId string

The OCID of the cross-connect group.

DisplayName string

A filter to return only resources that match the given display name exactly.

Filters []GetCrossConnectsFilter
State string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String

The OCID of the compartment.

crossConnectGroupId String

The OCID of the cross-connect group.

displayName String

A filter to return only resources that match the given display name exactly.

filters List<GetCrossConnectsFilter>
state String

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId string

The OCID of the compartment.

crossConnectGroupId string

The OCID of the cross-connect group.

displayName string

A filter to return only resources that match the given display name exactly.

filters GetCrossConnectsFilter[]
state string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartment_id str

The OCID of the compartment.

cross_connect_group_id str

The OCID of the cross-connect group.

display_name str

A filter to return only resources that match the given display name exactly.

filters GetCrossConnectsFilter]
state str

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String

The OCID of the compartment.

crossConnectGroupId String

The OCID of the cross-connect group.

displayName String

A filter to return only resources that match the given display name exactly.

filters List<Property Map>
state String

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getCrossConnects Result

The following output properties are available:

CompartmentId string

The OCID of the compartment containing the cross-connect group.

CrossConnects List<GetCrossConnectsCrossConnect>

The list of cross_connects.

Id string

The provider-assigned unique ID for this managed resource.

CrossConnectGroupId string

The OCID of the cross-connect group this cross-connect belongs to (if any).

DisplayName string

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

Filters List<GetCrossConnectsFilter>
State string

The cross-connect's current state.

CompartmentId string

The OCID of the compartment containing the cross-connect group.

CrossConnects []GetCrossConnectsCrossConnect

The list of cross_connects.

Id string

The provider-assigned unique ID for this managed resource.

CrossConnectGroupId string

The OCID of the cross-connect group this cross-connect belongs to (if any).

DisplayName string

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

Filters []GetCrossConnectsFilter
State string

The cross-connect's current state.

compartmentId String

The OCID of the compartment containing the cross-connect group.

crossConnects List<GetCrossConnectsCrossConnect>

The list of cross_connects.

id String

The provider-assigned unique ID for this managed resource.

crossConnectGroupId String

The OCID of the cross-connect group this cross-connect belongs to (if any).

displayName String

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

filters List<GetCrossConnectsFilter>
state String

The cross-connect's current state.

compartmentId string

The OCID of the compartment containing the cross-connect group.

crossConnects GetCrossConnectsCrossConnect[]

The list of cross_connects.

id string

The provider-assigned unique ID for this managed resource.

crossConnectGroupId string

The OCID of the cross-connect group this cross-connect belongs to (if any).

displayName string

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

filters GetCrossConnectsFilter[]
state string

The cross-connect's current state.

compartment_id str

The OCID of the compartment containing the cross-connect group.

cross_connects GetCrossConnectsCrossConnect]

The list of cross_connects.

id str

The provider-assigned unique ID for this managed resource.

cross_connect_group_id str

The OCID of the cross-connect group this cross-connect belongs to (if any).

display_name str

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

filters GetCrossConnectsFilter]
state str

The cross-connect's current state.

compartmentId String

The OCID of the compartment containing the cross-connect group.

crossConnects List<Property Map>

The list of cross_connects.

id String

The provider-assigned unique ID for this managed resource.

crossConnectGroupId String

The OCID of the cross-connect group this cross-connect belongs to (if any).

displayName String

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

filters List<Property Map>
state String

The cross-connect's current state.

Supporting Types

GetCrossConnectsCrossConnect

CompartmentId string

The OCID of the compartment.

CrossConnectGroupId string

The OCID of the cross-connect group.

CustomerReferenceName string

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

DefinedTags Dictionary<string, object>

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 filter to return only resources that match the given display name exactly.

FarCrossConnectOrCrossConnectGroupId string
FreeformTags Dictionary<string, object>

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<GetCrossConnectsCrossConnectMacsecProperty>

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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.

CrossConnectGroupId string

The OCID of the cross-connect group.

CustomerReferenceName string

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

DefinedTags map[string]interface{}

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 filter to return only resources that match the given display name exactly.

FarCrossConnectOrCrossConnectGroupId string
FreeformTags map[string]interface{}

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 []GetCrossConnectsCrossConnectMacsecProperty

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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.

crossConnectGroupId String

The OCID of the cross-connect group.

customerReferenceName String

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

definedTags Map<String,Object>

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 filter to return only resources that match the given display name exactly.

farCrossConnectOrCrossConnectGroupId String
freeformTags Map<String,Object>

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<GetCrossConnectsCrossConnectMacsecProperty>

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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.

crossConnectGroupId string

The OCID of the cross-connect group.

customerReferenceName string

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

definedTags {[key: string]: any}

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 filter to return only resources that match the given display name exactly.

farCrossConnectOrCrossConnectGroupId string
freeformTags {[key: string]: any}

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 GetCrossConnectsCrossConnectMacsecProperty[]

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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.

cross_connect_group_id str

The OCID of the cross-connect group.

customer_reference_name str

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

defined_tags Mapping[str, Any]

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 filter to return only resources that match the given display name exactly.

far_cross_connect_or_cross_connect_group_id str
freeform_tags Mapping[str, Any]

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 GetCrossConnectsCrossConnectMacsecProperty]

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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.

crossConnectGroupId String

The OCID of the cross-connect group.

customerReferenceName String

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

definedTags Map<Any>

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 filter to return only resources that match the given display name exactly.

farCrossConnectOrCrossConnectGroupId String
freeformTags Map<Any>

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

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

timeCreated String

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

GetCrossConnectsCrossConnectMacsecProperty

EncryptionCipher string

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

PrimaryKeys List<GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey>

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

State string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

EncryptionCipher string

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

PrimaryKeys []GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey

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

State string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryptionCipher String

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

primaryKeys List<GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey>

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

state String

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryptionCipher string

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

primaryKeys GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey[]

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

state string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryption_cipher str

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

primary_keys GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey]

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

state str

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryptionCipher String

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

primaryKeys List<Property Map>

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

state String

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey

ConnectivityAssociationKeySecretId string

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

ConnectivityAssociationKeySecretVersion string

The secret version of the connectivityAssociationKey secret in Vault.

ConnectivityAssociationNameSecretId string

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

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.

ConnectivityAssociationKeySecretVersion string

The secret version of the connectivityAssociationKey secret in Vault.

ConnectivityAssociationNameSecretId string

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

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.

connectivityAssociationKeySecretVersion String

The secret version of the connectivityAssociationKey secret in Vault.

connectivityAssociationNameSecretId String

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

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.

connectivityAssociationKeySecretVersion string

The secret version of the connectivityAssociationKey secret in Vault.

connectivityAssociationNameSecretId string

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

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_key_secret_version str

The secret version of the connectivityAssociationKey secret in Vault.

connectivity_association_name_secret_id str

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

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.

connectivityAssociationKeySecretVersion String

The secret version of the connectivityAssociationKey secret in Vault.

connectivityAssociationNameSecretId String

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

connectivityAssociationNameSecretVersion String

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

GetCrossConnectsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

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

This Pulumi package is based on the oci Terraform Provider.