Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. CrossConnectGroup
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.CrossConnectGroup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

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

    Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. 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 group to reside. If you’re not sure which compartment to use, put the cross-connect group 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 group. It does not have to be unique, and you can change it. Avoid entering confidential information.

    Example Usage

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

const testCrossConnectGroup = new oci.core.CrossConnectGroup("test_cross_connect_group", {
    compartmentId: compartmentId,
    customerReferenceName: crossConnectGroupCustomerReferenceName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: crossConnectGroupDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    macsecProperties: {
        state: crossConnectGroupMacsecPropertiesState,
        encryptionCipher: crossConnectGroupMacsecPropertiesEncryptionCipher,
        isUnprotectedTrafficAllowed: crossConnectGroupMacsecPropertiesIsUnprotectedTrafficAllowed,
        primaryKey: {
            connectivityAssociationKeySecretId: testSecret.id,
            connectivityAssociationNameSecretId: testSecret.id,
        },
    },
});

    import pulumi
import pulumi_oci as oci

test_cross_connect_group = oci.core.CrossConnectGroup("test_cross_connect_group",
    compartment_id=compartment_id,
    customer_reference_name=cross_connect_group_customer_reference_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=cross_connect_group_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    macsec_properties={
        "state": cross_connect_group_macsec_properties_state,
        "encryption_cipher": cross_connect_group_macsec_properties_encryption_cipher,
        "is_unprotected_traffic_allowed": cross_connect_group_macsec_properties_is_unprotected_traffic_allowed,
        "primary_key": {
            "connectivity_association_key_secret_id": test_secret["id"],
            "connectivity_association_name_secret_id": test_secret["id"],
        },
    })

    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.NewCrossConnectGroup(ctx, "test_cross_connect_group", &Core.CrossConnectGroupArgs{
			CompartmentId:         pulumi.Any(compartmentId),
			CustomerReferenceName: pulumi.Any(crossConnectGroupCustomerReferenceName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(crossConnectGroupDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			MacsecProperties: &core.CrossConnectGroupMacsecPropertiesArgs{
				State:                       pulumi.Any(crossConnectGroupMacsecPropertiesState),
				EncryptionCipher:            pulumi.Any(crossConnectGroupMacsecPropertiesEncryptionCipher),
				IsUnprotectedTrafficAllowed: pulumi.Any(crossConnectGroupMacsecPropertiesIsUnprotectedTrafficAllowed),
				PrimaryKey: &core.CrossConnectGroupMacsecPropertiesPrimaryKeyArgs{
					ConnectivityAssociationKeySecretId:  pulumi.Any(testSecret.Id),
					ConnectivityAssociationNameSecretId: pulumi.Any(testSecret.Id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testCrossConnectGroup = new Oci.Core.CrossConnectGroup("test_cross_connect_group", new()
    {
        CompartmentId = compartmentId,
        CustomerReferenceName = crossConnectGroupCustomerReferenceName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = crossConnectGroupDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        MacsecProperties = new Oci.Core.Inputs.CrossConnectGroupMacsecPropertiesArgs
        {
            State = crossConnectGroupMacsecPropertiesState,
            EncryptionCipher = crossConnectGroupMacsecPropertiesEncryptionCipher,
            IsUnprotectedTrafficAllowed = crossConnectGroupMacsecPropertiesIsUnprotectedTrafficAllowed,
            PrimaryKey = new Oci.Core.Inputs.CrossConnectGroupMacsecPropertiesPrimaryKeyArgs
            {
                ConnectivityAssociationKeySecretId = testSecret.Id,
                ConnectivityAssociationNameSecretId = testSecret.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CrossConnectGroup;
import com.pulumi.oci.Core.CrossConnectGroupArgs;
import com.pulumi.oci.Core.inputs.CrossConnectGroupMacsecPropertiesArgs;
import com.pulumi.oci.Core.inputs.CrossConnectGroupMacsecPropertiesPrimaryKeyArgs;
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 testCrossConnectGroup = new CrossConnectGroup("testCrossConnectGroup", CrossConnectGroupArgs.builder()
            .compartmentId(compartmentId)
            .customerReferenceName(crossConnectGroupCustomerReferenceName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(crossConnectGroupDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .macsecProperties(CrossConnectGroupMacsecPropertiesArgs.builder()
                .state(crossConnectGroupMacsecPropertiesState)
                .encryptionCipher(crossConnectGroupMacsecPropertiesEncryptionCipher)
                .isUnprotectedTrafficAllowed(crossConnectGroupMacsecPropertiesIsUnprotectedTrafficAllowed)
                .primaryKey(CrossConnectGroupMacsecPropertiesPrimaryKeyArgs.builder()
                    .connectivityAssociationKeySecretId(testSecret.id())
                    .connectivityAssociationNameSecretId(testSecret.id())
                    .build())
                .build())
            .build());

    }
}

    resources:
  testCrossConnectGroup:
    type: oci:Core:CrossConnectGroup
    name: test_cross_connect_group
    properties:
      compartmentId: ${compartmentId}
      customerReferenceName: ${crossConnectGroupCustomerReferenceName}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${crossConnectGroupDisplayName}
      freeformTags:
        Department: Finance
      macsecProperties:
        state: ${crossConnectGroupMacsecPropertiesState}
        encryptionCipher: ${crossConnectGroupMacsecPropertiesEncryptionCipher}
        isUnprotectedTrafficAllowed: ${crossConnectGroupMacsecPropertiesIsUnprotectedTrafficAllowed}
        primaryKey:
          connectivityAssociationKeySecretId: ${testSecret.id}
          connectivityAssociationNameSecretId: ${testSecret.id}

    Create CrossConnectGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CrossConnectGroup(name: string, args: CrossConnectGroupArgs, opts?: CustomResourceOptions);
    @overload
def CrossConnectGroup(resource_name: str,
                      args: CrossConnectGroupArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def CrossConnectGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      compartment_id: Optional[str] = None,
                      customer_reference_name: Optional[str] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      display_name: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      macsec_properties: Optional[_core.CrossConnectGroupMacsecPropertiesArgs] = None)
    func NewCrossConnectGroup(ctx *Context, name string, args CrossConnectGroupArgs, opts ...ResourceOption) (*CrossConnectGroup, error)
    public CrossConnectGroup(string name, CrossConnectGroupArgs args, CustomResourceOptions? opts = null)
    public CrossConnectGroup(String name, CrossConnectGroupArgs args)
public CrossConnectGroup(String name, CrossConnectGroupArgs args, CustomResourceOptions options)

    type: oci:Core:CrossConnectGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CrossConnectGroupArgs
    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 CrossConnectGroupArgs
    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 CrossConnectGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CrossConnectGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CrossConnectGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var crossConnectGroupResource = new Oci.Core.CrossConnectGroup("crossConnectGroupResource", new()
{
    CompartmentId = "string",
    CustomerReferenceName = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    MacsecProperties = new Oci.Core.Inputs.CrossConnectGroupMacsecPropertiesArgs
    {
        State = "string",
        EncryptionCipher = "string",
        IsUnprotectedTrafficAllowed = false,
        PrimaryKey = new Oci.Core.Inputs.CrossConnectGroupMacsecPropertiesPrimaryKeyArgs
        {
            ConnectivityAssociationKeySecretId = "string",
            ConnectivityAssociationNameSecretId = "string",
            ConnectivityAssociationKeySecretVersion = "string",
            ConnectivityAssociationNameSecretVersion = "string",
        },
    },
});

    example, err := Core.NewCrossConnectGroup(ctx, "crossConnectGroupResource", &Core.CrossConnectGroupArgs{
	CompartmentId:         pulumi.String("string"),
	CustomerReferenceName: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	MacsecProperties: &core.CrossConnectGroupMacsecPropertiesArgs{
		State:                       pulumi.String("string"),
		EncryptionCipher:            pulumi.String("string"),
		IsUnprotectedTrafficAllowed: pulumi.Bool(false),
		PrimaryKey: &core.CrossConnectGroupMacsecPropertiesPrimaryKeyArgs{
			ConnectivityAssociationKeySecretId:       pulumi.String("string"),
			ConnectivityAssociationNameSecretId:      pulumi.String("string"),
			ConnectivityAssociationKeySecretVersion:  pulumi.String("string"),
			ConnectivityAssociationNameSecretVersion: pulumi.String("string"),
		},
	},
})

    var crossConnectGroupResource = new CrossConnectGroup("crossConnectGroupResource", CrossConnectGroupArgs.builder()
    .compartmentId("string")
    .customerReferenceName("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .macsecProperties(CrossConnectGroupMacsecPropertiesArgs.builder()
        .state("string")
        .encryptionCipher("string")
        .isUnprotectedTrafficAllowed(false)
        .primaryKey(CrossConnectGroupMacsecPropertiesPrimaryKeyArgs.builder()
            .connectivityAssociationKeySecretId("string")
            .connectivityAssociationNameSecretId("string")
            .connectivityAssociationKeySecretVersion("string")
            .connectivityAssociationNameSecretVersion("string")
            .build())
        .build())
    .build());

    cross_connect_group_resource = oci.core.CrossConnectGroup("crossConnectGroupResource",
    compartment_id="string",
    customer_reference_name="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    macsec_properties={
        "state": "string",
        "encryption_cipher": "string",
        "is_unprotected_traffic_allowed": False,
        "primary_key": {
            "connectivity_association_key_secret_id": "string",
            "connectivity_association_name_secret_id": "string",
            "connectivity_association_key_secret_version": "string",
            "connectivity_association_name_secret_version": "string",
        },
    })

    const crossConnectGroupResource = new oci.core.CrossConnectGroup("crossConnectGroupResource", {
    compartmentId: "string",
    customerReferenceName: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    macsecProperties: {
        state: "string",
        encryptionCipher: "string",
        isUnprotectedTrafficAllowed: false,
        primaryKey: {
            connectivityAssociationKeySecretId: "string",
            connectivityAssociationNameSecretId: "string",
            connectivityAssociationKeySecretVersion: "string",
            connectivityAssociationNameSecretVersion: "string",
        },
    },
});

    type: oci:Core:CrossConnectGroup
properties:
    compartmentId: string
    customerReferenceName: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    macsecProperties:
        encryptionCipher: string
        isUnprotectedTrafficAllowed: false
        primaryKey:
            connectivityAssociationKeySecretId: string
            connectivityAssociationKeySecretVersion: string
            connectivityAssociationNameSecretId: string
            connectivityAssociationNameSecretVersion: string
        state: string

    CrossConnectGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CrossConnectGroup resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment to contain the cross-connect group.
    CustomerReferenceName string
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    DefinedTags Dictionary<string, string>
    (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.
    FreeformTags Dictionary<string, string>
    (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"}
    MacsecProperties CrossConnectGroupMacsecProperties
    (Updatable) Properties used to configure MACsec (if capable).
    CompartmentId string
    (Updatable) The OCID of the compartment to contain the cross-connect group.
    CustomerReferenceName string
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    DefinedTags map[string]string
    (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.
    FreeformTags map[string]string
    (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"}
    MacsecProperties CrossConnectGroupMacsecPropertiesArgs
    (Updatable) Properties used to configure MACsec (if capable).
    compartmentId String
    (Updatable) The OCID of the compartment to contain the cross-connect group.
    customerReferenceName String
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    definedTags Map<String,String>
    (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.
    freeformTags Map<String,String>
    (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"}
    macsecProperties CrossConnectGroupMacsecProperties
    (Updatable) Properties used to configure MACsec (if capable).
    compartmentId string
    (Updatable) The OCID of the compartment to contain the cross-connect group.
    customerReferenceName string
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    definedTags {[key: string]: string}
    (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.
    freeformTags {[key: string]: string}
    (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"}
    macsecProperties CrossConnectGroupMacsecProperties
    (Updatable) Properties used to configure MACsec (if capable).
    compartment_id str
    (Updatable) The OCID of the compartment to contain the cross-connect group.
    customer_reference_name str
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    defined_tags Mapping[str, str]
    (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.
    freeform_tags Mapping[str, str]
    (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"}
    macsec_properties core.CrossConnectGroupMacsecPropertiesArgs
    (Updatable) Properties used to configure MACsec (if capable).
    compartmentId String
    (Updatable) The OCID of the compartment to contain the cross-connect group.
    customerReferenceName String
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    definedTags Map<String>
    (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.
    freeformTags Map<String>
    (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"}
    macsecProperties Property Map
    (Updatable) Properties used to configure MACsec (if capable).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CrossConnectGroup 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.
    State string
    The cross-connect group's current state.
    TimeCreated string
    The date and time the cross-connect group 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.
    State string
    The cross-connect group's current state.
    TimeCreated string
    The date and time the cross-connect group 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.
    state String
    The cross-connect group's current state.
    timeCreated String
    The date and time the cross-connect group 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.
    state string
    The cross-connect group's current state.
    timeCreated string
    The date and time the cross-connect group 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.
    state str
    The cross-connect group's current state.
    time_created str
    The date and time the cross-connect group 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.
    state String
    The cross-connect group's current state.
    timeCreated String
    The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing CrossConnectGroup Resource

    Get an existing CrossConnectGroup 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?: CrossConnectGroupState, opts?: CustomResourceOptions): CrossConnectGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        customer_reference_name: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        macsec_properties: Optional[_core.CrossConnectGroupMacsecPropertiesArgs] = None,
        oci_logical_device_name: Optional[str] = None,
        oci_physical_device_name: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None) -> CrossConnectGroup
    func GetCrossConnectGroup(ctx *Context, name string, id IDInput, state *CrossConnectGroupState, opts ...ResourceOption) (*CrossConnectGroup, error)
    public static CrossConnectGroup Get(string name, Input<string> id, CrossConnectGroupState? state, CustomResourceOptions? opts = null)
    public static CrossConnectGroup get(String name, Output<String> id, CrossConnectGroupState 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 group.
    CustomerReferenceName string
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    DefinedTags Dictionary<string, string>
    (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.
    FreeformTags Dictionary<string, string>
    (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"}
    MacsecProperties CrossConnectGroupMacsecProperties
    (Updatable) Properties used to configure MACsec (if capable).
    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.
    State string
    The cross-connect group's current state.
    TimeCreated string
    The date and time the cross-connect group 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 group.
    CustomerReferenceName string
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    DefinedTags map[string]string
    (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.
    FreeformTags map[string]string
    (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"}
    MacsecProperties CrossConnectGroupMacsecPropertiesArgs
    (Updatable) Properties used to configure MACsec (if capable).
    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.
    State string
    The cross-connect group's current state.
    TimeCreated string
    The date and time the cross-connect group 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 group.
    customerReferenceName String
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    definedTags Map<String,String>
    (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.
    freeformTags Map<String,String>
    (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"}
    macsecProperties CrossConnectGroupMacsecProperties
    (Updatable) Properties used to configure MACsec (if capable).
    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.
    state String
    The cross-connect group's current state.
    timeCreated String
    The date and time the cross-connect group 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 group.
    customerReferenceName string
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    definedTags {[key: string]: string}
    (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.
    freeformTags {[key: string]: string}
    (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"}
    macsecProperties CrossConnectGroupMacsecProperties
    (Updatable) Properties used to configure MACsec (if capable).
    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.
    state string
    The cross-connect group's current state.
    timeCreated string
    The date and time the cross-connect group 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 group.
    customer_reference_name str
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    defined_tags Mapping[str, str]
    (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.
    freeform_tags Mapping[str, str]
    (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"}
    macsec_properties core.CrossConnectGroupMacsecPropertiesArgs
    (Updatable) Properties used to configure MACsec (if capable).
    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.
    state str
    The cross-connect group's current state.
    time_created str
    The date and time the cross-connect group 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 group.
    customerReferenceName String
    (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group uses.
    definedTags Map<String>
    (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.
    freeformTags Map<String>
    (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"}
    macsecProperties Property Map
    (Updatable) Properties used to configure MACsec (if capable).
    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.
    state String
    The cross-connect group's current state.
    timeCreated String
    The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    CrossConnectGroupMacsecProperties, CrossConnectGroupMacsecPropertiesArgs

    State string

    (Updatable) Indicates whether or not MACsec is enabled.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    EncryptionCipher string
    (Updatable) Type of encryption cipher suite to use for the MACsec connection.
    IsUnprotectedTrafficAllowed bool
    (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
    PrimaryKey CrossConnectGroupMacsecPropertiesPrimaryKey
    (Updatable) Defines the secret OCIDs held in Vault that represent the MACsec key.
    State string

    (Updatable) Indicates whether or not MACsec is enabled.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    EncryptionCipher string
    (Updatable) Type of encryption cipher suite to use for the MACsec connection.
    IsUnprotectedTrafficAllowed bool
    (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
    PrimaryKey CrossConnectGroupMacsecPropertiesPrimaryKey
    (Updatable) Defines the secret OCIDs held in Vault that represent the MACsec key.
    state String

    (Updatable) Indicates whether or not MACsec is enabled.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryptionCipher String
    (Updatable) Type of encryption cipher suite to use for the MACsec connection.
    isUnprotectedTrafficAllowed Boolean
    (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
    primaryKey CrossConnectGroupMacsecPropertiesPrimaryKey
    (Updatable) Defines the secret OCIDs held in Vault that represent the MACsec key.
    state string

    (Updatable) Indicates whether or not MACsec is enabled.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryptionCipher string
    (Updatable) Type of encryption cipher suite to use for the MACsec connection.
    isUnprotectedTrafficAllowed boolean
    (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
    primaryKey CrossConnectGroupMacsecPropertiesPrimaryKey
    (Updatable) Defines the secret OCIDs held in Vault that represent the MACsec key.
    state str

    (Updatable) Indicates whether or not MACsec is enabled.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryption_cipher str
    (Updatable) Type of encryption cipher suite to use for the MACsec connection.
    is_unprotected_traffic_allowed bool
    (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
    primary_key core.CrossConnectGroupMacsecPropertiesPrimaryKey
    (Updatable) Defines the secret OCIDs held in Vault that represent the MACsec key.
    state String

    (Updatable) Indicates whether or not MACsec is enabled.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryptionCipher String
    (Updatable) Type of encryption cipher suite to use for the MACsec connection.
    isUnprotectedTrafficAllowed Boolean
    (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
    primaryKey Property Map
    (Updatable) Defines the secret OCIDs held in Vault that represent the MACsec key.

    CrossConnectGroupMacsecPropertiesPrimaryKey, CrossConnectGroupMacsecPropertiesPrimaryKeyArgs

    ConnectivityAssociationKeySecretId string

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

    NOTE: Only the latest secret version will be used.

    ConnectivityAssociationNameSecretId string

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

    NOTE: Only the latest secret version will be used.

    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

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

    NOTE: Only the latest secret version will be used.

    ConnectivityAssociationNameSecretId string

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

    NOTE: Only the latest secret version will be used.

    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

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

    NOTE: Only the latest secret version will be used.

    connectivityAssociationNameSecretId String

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

    NOTE: Only the latest secret version will be used.

    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

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

    NOTE: Only the latest secret version will be used.

    connectivityAssociationNameSecretId string

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

    NOTE: Only the latest secret version will be used.

    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

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

    NOTE: Only the latest secret version will be used.

    connectivity_association_name_secret_id str

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

    NOTE: Only the latest secret version will be used.

    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

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

    NOTE: Only the latest secret version will be used.

    connectivityAssociationNameSecretId String

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

    NOTE: Only the latest secret version will be used.

    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

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

    $ pulumi import oci:Core/crossConnectGroup:CrossConnectGroup test_cross_connect_group "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci