import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Cross Connect Group resource in Oracle Cloud Infrastructure Core service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/iaas/latest/CrossConnectGroup * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a new cross-connect group to use with Oracle Cloud Infrastructure * FastConnect. 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 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](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 group. * 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 testCrossConnectGroup = new oci.core.CrossConnectGroup("test_cross_connect_group", { * compartmentId: compartmentId, * customerReferenceName: crossConnectGroupCustomerReferenceName, * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: crossConnectGroupDisplayName, * freeformTags: { * Department: "Finance", * }, * interfaceDownTimerValueInMilliseconds: Number(crossConnectGroupInterfaceDownTimerValueInMilliseconds), * isInterfaceHoldTimerEnabled: crossConnectGroupIsInterfaceHoldTimerEnabled === "true", * isQosEnabled: crossConnectGroupIsQosEnabled === "true", * macsecProperties: { * state: crossConnectGroupMacsecPropertiesState, * encryptionCipher: crossConnectGroupMacsecPropertiesEncryptionCipher, * isUnprotectedTrafficAllowed: crossConnectGroupMacsecPropertiesIsUnprotectedTrafficAllowed === "true", * primaryKey: { * connectivityAssociationKeySecretId: testSecret.id, * connectivityAssociationNameSecretId: testSecret.id, * }, * }, * minimumLinks: Number(crossConnectGroupMinimumLinks), * }); * ``` * * ## Import * * CrossConnectGroups can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Core/crossConnectGroup:CrossConnectGroup test_cross_connect_group "id" * ``` */ export declare class CrossConnectGroup extends pulumi.CustomResource { /** * Get an existing CrossConnectGroup 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?: CrossConnectGroupState, opts?: pulumi.CustomResourceOptions): CrossConnectGroup; /** * Returns true if the given object is an instance of CrossConnectGroup. 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 CrossConnectGroup; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group. */ readonly compartmentId: pulumi.Output; /** * (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group 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; /** * (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; /** * (Updatable) The flag to enable or disable the down timer for the interface. */ readonly isInterfaceHoldTimerEnabled: pulumi.Output; /** * (Optional) 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 configure MACsec (if capable). */ readonly macsecProperties: pulumi.Output; /** * (Updatable) (Optional) Minimum number of active cross-connects required for the cross-connect group to be considered operational. During create cross-connect-group operation this value can only be set to 1 (If not specified, this value defaults to 1) and can be edited using the update cross-connect group operation. Value must not exceed the total number of cross-connects in the cross-connect group. * * ** 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 minimumLinks: 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 FastConnect device that terminates the physical connection. */ readonly ociPhysicalDeviceName: pulumi.Output; /** * The cross-connect group's current state. */ readonly state: pulumi.Output; /** * The date and time the cross-connect group 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 CrossConnectGroup 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: CrossConnectGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CrossConnectGroup resources. */ export interface CrossConnectGroupState { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group. */ compartmentId?: pulumi.Input; /** * (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group 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; /** * (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; /** * (Updatable) The flag to enable or disable the down timer for the interface. */ isInterfaceHoldTimerEnabled?: pulumi.Input; /** * (Optional) 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 configure MACsec (if capable). */ macsecProperties?: pulumi.Input; /** * (Updatable) (Optional) Minimum number of active cross-connects required for the cross-connect group to be considered operational. During create cross-connect-group operation this value can only be set to 1 (If not specified, this value defaults to 1) and can be edited using the update cross-connect group operation. Value must not exceed the total number of cross-connects in the cross-connect group. * * ** 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 */ minimumLinks?: 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 FastConnect device that terminates the physical connection. */ ociPhysicalDeviceName?: pulumi.Input; /** * The cross-connect group's current state. */ state?: pulumi.Input; /** * The date and time the cross-connect group 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 CrossConnectGroup resource. */ export interface CrossConnectGroupArgs { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group. */ compartmentId: pulumi.Input; /** * (Updatable) A reference name or identifier for the physical fiber connection that this cross-connect group 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; /** * (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; /** * (Updatable) The flag to enable or disable the down timer for the interface. */ isInterfaceHoldTimerEnabled?: pulumi.Input; /** * (Optional) 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 configure MACsec (if capable). */ macsecProperties?: pulumi.Input; /** * (Updatable) (Optional) Minimum number of active cross-connects required for the cross-connect group to be considered operational. During create cross-connect-group operation this value can only be set to 1 (If not specified, this value defaults to 1) and can be edited using the update cross-connect group operation. Value must not exceed the total number of cross-connects in the cross-connect group. * * ** 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 */ minimumLinks?: pulumi.Input; } //# sourceMappingURL=crossConnectGroup.d.ts.map