» oci_core_volume_group

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

Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. A volume group can contain up to 64 volumes. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

For more information, see Volume Groups.

» Example Usage

resource "oci_core_volume_group" "test_volume_group" {
    #Required
    availability_domain = "${var.volume_group_availability_domain}"
    compartment_id = "${var.compartment_id}"
    source_details {
        #Required
        type = "volumeIds"
        volume_ids = ["${var.volume_group_source_id}"]
    }

    #Optional
    defined_tags = {"Operations.CostCenter"= "42"}
    display_name = "${var.volume_group_display_name}"
    freeform_tags = {"Department"= "Finance"}
}

» Argument Reference

The following arguments are supported:

  • availability_domain - (Required) The availability domain of the volume group.
  • compartment_id - (Required) The OCID of the compartment that contains the volume group.
  • defined_tags - (Optional) (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 - (Optional) (Updatable) A user-friendly name for the volume group. Does not have to be unique, and it's changeable.
  • freeform_tags - (Optional) (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"}
  • source_details - (Required) Specifies the volume group source details for a new volume group. The volume source is either another a list of volume ids in the same availability domain, another volume group or a volume group backup.
    • type - (Required) The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeIds
    • volume_group_backup_id - (Required when type=volumeGroupBackupId) The OCID of the volume group backup to restore from.
    • volume_group_id - (Required when type=volumeGroupId) The OCID of the volume group to clone from.
    • volume_ids - (Required when type=volumeIds) OCIDs for the volumes in this volume 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

» Attributes Reference

The following attributes are exported:

  • availability_domain - The availability domain of the volume group.
  • compartment_id - The OCID of the compartment that contains the volume group.
  • defined_tags - 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 - A user-friendly name for the volume group. Does not have to be unique, and it's changeable. Avoid entering confidential information.
  • freeform_tags - 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 - The OCID for the volume group.
  • is_hydrated - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
  • size_in_gbs - The aggregate size of the volume group in GBs.
  • size_in_mbs - The aggregate size of the volume group in MBs.
  • source_details - The volume group source. The source is either another a list of volume IDs in the same availability domain, another volume group, or a volume group backup.
    • type - The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeIds
    • volume_group_backup_id - The OCID of the volume group backup to restore from.
    • volume_group_id - The OCID of the volume group to clone from.
    • volume_ids - OCIDs for the volumes in this volume group.
  • state - The current state of a volume group.
  • time_created - The date and time the volume group was created. Format defined by RFC3339.
  • volume_ids - OCIDs for the volumes in this volume group.

» Import

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

$ terraform import oci_core_volume_group.test_volume_group "id"