import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Cross Connect resource in Oracle Cloud Infrastructure Core service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/iaas/latest/CrossConnect * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a new cross-connect. Oracle recommends you create each cross-connect in a * [CrossConnectGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation * with the connection. * * After creating the `CrossConnect` object, you need to go the FastConnect location * and request to have the physical cable installed. For more information, see * [FastConnect Overview](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). * * For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the * compartment where you want the cross-connect to reside. If you're * not sure which compartment to use, put the cross-connect in the * same compartment with your VCN. For more information about * compartments and access control, see * [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). * For information about OCIDs, see * [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * You may optionally specify a *display name* for the cross-connect. * It does not have to be unique, and you can change it. Avoid entering confidential information. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testCrossConnect = new oci.core.CrossConnect("test_cross_connect", { * compartmentId: compartmentId, * locationName: crossConnectLocationName, * portSpeedShapeName: crossConnectPortSpeedShapeName, * crossConnectGroupId: testCrossConnectGroup.id, * customerReferenceName: crossConnectCustomerReferenceName, * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: crossConnectDisplayName, * farCrossConnectOrCrossConnectGroupId: testCrossConnectGroup.id, * freeformTags: { * Department: "Finance", * }, * interfaceDownTimerValueInMilliseconds: Number(crossConnectInterfaceDownTimerValueInMilliseconds), * interfaceName: crossConnectInterfaceName, * isInterfaceHoldTimerEnabled: crossConnectIsInterfaceHoldTimerEnabled === "true", * isQosEnabled: crossConnectIsQosEnabled === "true", * macsecProperties: { * state: crossConnectMacsecPropertiesState, * encryptionCipher: crossConnectMacsecPropertiesEncryptionCipher, * isUnprotectedTrafficAllowed: crossConnectMacsecPropertiesIsUnprotectedTrafficAllowed === "true", * primaryKey: { * connectivityAssociationKeySecretId: testSecret.id, * connectivityAssociationNameSecretId: testSecret.id, * }, * }, * nearCrossConnectOrCrossConnectGroupId: testCrossConnectGroup.id, * ociPhysicalDeviceName: crossConnectOciPhysicalDeviceName, * loaProperties: { * authorizedAgent: crossConnectLoaPropertiesAuthorizedAgent, * }, * }); * ``` * * ## Import * * CrossConnects can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Core/crossConnect:CrossConnect test_cross_connect "id" * ``` */ export declare class CrossConnect extends pulumi.CustomResource { /** * Get an existing CrossConnect resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: CrossConnectState, opts?: pulumi.CustomResourceOptions): CrossConnect; /** * Returns true if the given object is an instance of CrossConnect. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is CrossConnect; /** * (Updatable) The OCID of the compartment to contain the cross-connect. */ readonly compartmentId: pulumi.Output; /** * The OCID of the cross-connect group to put this cross-connect in. */ readonly crossConnectGroupId: pulumi.Output; /** * (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses. */ readonly customerReferenceName: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ readonly displayName: pulumi.Output; /** * If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. */ readonly farCrossConnectOrCrossConnectGroupId: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500. */ readonly interfaceDownTimerValueInMilliseconds: pulumi.Output; /** * The name of the FastConnect interface where this cross-connect is installed. Option will be provided only on request for select tenancies. */ readonly interfaceName: pulumi.Output; /** * (Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready. */ readonly isActive: pulumi.Output; /** * (Updatable) The flag to enable or disable the down timer for the interface. */ readonly isInterfaceHoldTimerEnabled: pulumi.Output; /** * When true, restricts placement so cross-connects lands only on QoS-capable devices. When false (default), placement may use any supported device. If no QoS-capable devices are available in the selected location, the request fails. */ readonly isQosEnabled: pulumi.Output; /** * (Updatable) Properties used to manage the Letter of Authority associated with this cross-connect. */ readonly loaProperties: pulumi.Output; /** * The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see [ListCrossConnectLocations](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectLocation/ListCrossConnectLocations). Example: `CyrusOne, Chandler, AZ` */ readonly locationName: pulumi.Output; /** * (Updatable) Properties used to configure MACsec (if capable). */ readonly macsecProperties: pulumi.Output; /** * If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. */ readonly nearCrossConnectOrCrossConnectGroupId: pulumi.Output; /** * The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. */ readonly ociLogicalDeviceName: pulumi.Output; /** * The name of the FastConnect device where this cross-connect is installed. Option will be provided only on request for select tenancies. */ readonly ociPhysicalDeviceName: pulumi.Output; /** * A string identifying the meet-me room port for this cross-connect. */ readonly portName: pulumi.Output; /** * The port speed for this cross-connect. To get a list of the available port speeds, see [ListCrossConnectPortSpeedShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectPortSpeedShape/ListCrossconnectPortSpeedShapes). Example: `10 Gbps` * * ** 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 */ readonly portSpeedShapeName: pulumi.Output; /** * The cross-connect's current state. */ readonly state: pulumi.Output; /** * The date and time the cross-connect was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * Create a CrossConnect resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CrossConnectArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CrossConnect resources. */ export interface CrossConnectState { /** * (Updatable) The OCID of the compartment to contain the cross-connect. */ compartmentId?: pulumi.Input; /** * The OCID of the cross-connect group to put this cross-connect in. */ crossConnectGroupId?: pulumi.Input; /** * (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses. */ customerReferenceName?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. */ farCrossConnectOrCrossConnectGroupId?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500. */ interfaceDownTimerValueInMilliseconds?: pulumi.Input; /** * The name of the FastConnect interface where this cross-connect is installed. Option will be provided only on request for select tenancies. */ interfaceName?: pulumi.Input; /** * (Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready. */ isActive?: pulumi.Input; /** * (Updatable) The flag to enable or disable the down timer for the interface. */ isInterfaceHoldTimerEnabled?: pulumi.Input; /** * When true, restricts placement so cross-connects lands only on QoS-capable devices. When false (default), placement may use any supported device. If no QoS-capable devices are available in the selected location, the request fails. */ isQosEnabled?: pulumi.Input; /** * (Updatable) Properties used to manage the Letter of Authority associated with this cross-connect. */ loaProperties?: pulumi.Input; /** * The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see [ListCrossConnectLocations](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectLocation/ListCrossConnectLocations). Example: `CyrusOne, Chandler, AZ` */ locationName?: pulumi.Input; /** * (Updatable) Properties used to configure MACsec (if capable). */ macsecProperties?: pulumi.Input; /** * If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. */ nearCrossConnectOrCrossConnectGroupId?: pulumi.Input; /** * The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. */ ociLogicalDeviceName?: pulumi.Input; /** * The name of the FastConnect device where this cross-connect is installed. Option will be provided only on request for select tenancies. */ ociPhysicalDeviceName?: pulumi.Input; /** * A string identifying the meet-me room port for this cross-connect. */ portName?: pulumi.Input; /** * The port speed for this cross-connect. To get a list of the available port speeds, see [ListCrossConnectPortSpeedShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectPortSpeedShape/ListCrossconnectPortSpeedShapes). Example: `10 Gbps` * * ** 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 */ portSpeedShapeName?: pulumi.Input; /** * The cross-connect's current state. */ state?: pulumi.Input; /** * The date and time the cross-connect was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated?: pulumi.Input; } /** * The set of arguments for constructing a CrossConnect resource. */ export interface CrossConnectArgs { /** * (Updatable) The OCID of the compartment to contain the cross-connect. */ compartmentId: pulumi.Input; /** * The OCID of the cross-connect group to put this cross-connect in. */ crossConnectGroupId?: pulumi.Input; /** * (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect uses. */ customerReferenceName?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. */ farCrossConnectOrCrossConnectGroupId?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500. */ interfaceDownTimerValueInMilliseconds?: pulumi.Input; /** * The name of the FastConnect interface where this cross-connect is installed. Option will be provided only on request for select tenancies. */ interfaceName?: pulumi.Input; /** * (Updatable) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready. */ isActive?: pulumi.Input; /** * (Updatable) The flag to enable or disable the down timer for the interface. */ isInterfaceHoldTimerEnabled?: pulumi.Input; /** * When true, restricts placement so cross-connects lands only on QoS-capable devices. When false (default), placement may use any supported device. If no QoS-capable devices are available in the selected location, the request fails. */ isQosEnabled?: pulumi.Input; /** * (Updatable) Properties used to manage the Letter of Authority associated with this cross-connect. */ loaProperties?: pulumi.Input; /** * The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see [ListCrossConnectLocations](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectLocation/ListCrossConnectLocations). Example: `CyrusOne, Chandler, AZ` */ locationName: pulumi.Input; /** * (Updatable) Properties used to configure MACsec (if capable). */ macsecProperties?: pulumi.Input; /** * If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. */ nearCrossConnectOrCrossConnectGroupId?: pulumi.Input; /** * The name of the FastConnect device where this cross-connect is installed. Option will be provided only on request for select tenancies. */ ociPhysicalDeviceName?: pulumi.Input; /** * The port speed for this cross-connect. To get a list of the available port speeds, see [ListCrossConnectPortSpeedShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectPortSpeedShape/ListCrossconnectPortSpeedShapes). Example: `10 Gbps` * * ** 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 */ portSpeedShapeName: pulumi.Input; } //# sourceMappingURL=crossConnect.d.ts.map