oci_core_volume_backup

This resource provides the Volume Backup resource in Oracle Cloud Infrastructure Core service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/iaas/latest/VolumeBackup

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/

Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups

When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Example Usage

resource "oci_core_volume_backup" "test_volume_backup" {
	#Required
	volume_id = oci_core_volume.test_volume.id

	#Optional
	defined_tags = {"Operations.CostCenter"= "42"}
	display_name = var.volume_backup_display_name
	freeform_tags = {"Department"= "Finance"}
	is_indefinite_retention_enabled = var.volume_backup_is_indefinite_retention_enabled
	is_prevent_deletion_enabled = var.volume_backup_is_prevent_deletion_enabled
	is_retention_lock_enabled = var.volume_backup_is_retention_lock_enabled
	kms_key_id = oci_kms_key.test_key.id
	retention_period {
		#Required
		retention_time_amount = var.volume_backup_retention_period_retention_time_amount
		retention_time_unit = var.volume_backup_retention_period_retention_time_unit
	}
	type = var.volume_backup_type
}

Argument Reference

The following arguments are supported:

compartment_id - (Optional) (Updatable) The OCID of the compartment that contains the volume backup.
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. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
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"}
is_indefinite_retention_enabled - (Optional) (Updatable) feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.
is_prevent_deletion_enabled - (Optional) (Updatable) Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.
is_retention_lock_enabled - (Optional) (Updatable) feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.
kms_key_id - (Optional) (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
retention_period - (Optional) (Updatable) This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.
- retention_time_amount - (Required) (Updatable) The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period.
- retention_time_unit - (Required) (Updatable) The value you can assign to the Time Unit property for this Duration may be either “YEARS” or “DAYS”.
type - (Optional) The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are ‘FULL’ or ‘INCREMENTAL’.
volume_id - (Optional) The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.
source_details - (Optional) Details of the volume backup source in the cloud.
- kms_key_id - The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- region - The region of the volume backup source.
- volume_backup_id - The OCID of the source volume backup.

** 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:

compartment_id - The OCID of the compartment that contains the volume backup.
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. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
expiration_time - The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
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 of the volume backup.
is_indefinite_retention_enabled - feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.
is_prevent_deletion_enabled - Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.
is_retention_lock_enabled - feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.
kms_key_id - The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
retention_period - This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.
- retention_time_amount - The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period.
- retention_time_unit - The value you can assign to the Time Unit property for this Duration may be either “YEARS” or “DAYS”.
size_in_gbs - The size of the volume, in GBs.
size_in_mbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
source_type - Specifies whether the backup was created manually, or via scheduled backup policy.
source_volume_backup_id - The OCID of the source volume backup.
state - The current state of a volume backup.
system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
time_created - The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
time_request_received - The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
time_retention_expires_at - The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.
type - The type of a volume backup. Supported values are ‘FULL’ or ‘INCREMENTAL’.
unique_size_in_gbs - The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
unique_size_in_mbs - The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
volume_group_backup_id - The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group.
volume_id - The OCID of the volume.

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Volume Backup * update - (Defaults to 20 minutes), when updating the Volume Backup * delete - (Defaults to 20 minutes), when destroying the Volume Backup

Import

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

$ terraform import oci_core_volume_backup.test_volume_backup "id"