Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. Core
  6. getBootVolumeBackup
Viewing docs for Oracle Cloud Infrastructure v4.22.0
published on Wednesday, Aug 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Core.getBootVolumeBackup

oci logo oci logo
Viewing docs for Oracle Cloud Infrastructure v4.22.0
published on Wednesday, Aug 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Boot Volume Backup resource in Oracle Cloud Infrastructure Core service.

    Gets information for the specified boot volume backup.

    Example Usage

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

const testBootVolumeBackup = oci.core.getBootVolumeBackup({
    bootVolumeBackupId: testBootVolumeBackupOciCoreBootVolumeBackup.id,
});

    import pulumi
import pulumi_oci as oci

test_boot_volume_backup = oci.core.get_boot_volume_backup(boot_volume_backup_id=test_boot_volume_backup_oci_core_boot_volume_backup["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetBootVolumeBackup(ctx, &core.GetBootVolumeBackupArgs{
			BootVolumeBackupId: testBootVolumeBackupOciCoreBootVolumeBackup.Id,
		}, nil)
		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 testBootVolumeBackup = Oci.Core.GetBootVolumeBackup.Invoke(new()
    {
        BootVolumeBackupId = testBootVolumeBackupOciCoreBootVolumeBackup.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetBootVolumeBackupArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var testBootVolumeBackup = CoreFunctions.getBootVolumeBackup(GetBootVolumeBackupArgs.builder()
            .bootVolumeBackupId(testBootVolumeBackupOciCoreBootVolumeBackup.id())
            .build());

    }
}

    variables:
  testBootVolumeBackup:
    fn::invoke:
      function: oci:Core:getBootVolumeBackup
      arguments:
        bootVolumeBackupId: ${testBootVolumeBackupOciCoreBootVolumeBackup.id}

    pulumi {
  required_providers {
    oci = {
      source = "pulumi/oci"
    }
  }
}

data "oci_core_getbootvolumebackup" "testBootVolumeBackup" {
  boot_volume_backup_id = testBootVolumeBackupOciCoreBootVolumeBackup.id
}

    Using getBootVolumeBackup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBootVolumeBackup(args: GetBootVolumeBackupArgs, opts?: InvokeOptions): Promise<GetBootVolumeBackupResult>
function getBootVolumeBackupOutput(args: GetBootVolumeBackupOutputArgs, opts?: InvokeOutputOptions): Output<GetBootVolumeBackupResult>
    def get_boot_volume_backup(boot_volume_backup_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBootVolumeBackupResult
def get_boot_volume_backup_output(boot_volume_backup_id: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetBootVolumeBackupResult]
    func LookupBootVolumeBackup(ctx *Context, args *LookupBootVolumeBackupArgs, opts ...InvokeOption) (*LookupBootVolumeBackupResult, error)
func LookupBootVolumeBackupOutput(ctx *Context, args *LookupBootVolumeBackupOutputArgs, opts ...InvokeOption) LookupBootVolumeBackupResultOutput

    > Note: This function is named LookupBootVolumeBackup in the Go SDK.

    public static class GetBootVolumeBackup 
{
    public static Task<GetBootVolumeBackupResult> InvokeAsync(GetBootVolumeBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBootVolumeBackupResult> Invoke(GetBootVolumeBackupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBootVolumeBackupResult> Invoke(GetBootVolumeBackupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBootVolumeBackupResult> getBootVolumeBackup(GetBootVolumeBackupArgs args, InvokeOptions options)
public static Output<GetBootVolumeBackupResult> getBootVolumeBackup(GetBootVolumeBackupArgs args, InvokeOptions options)
public static Output<GetBootVolumeBackupResult> getBootVolumeBackup(GetBootVolumeBackupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: oci:Core/getBootVolumeBackup:getBootVolumeBackup
  arguments:
    # arguments dictionary
    data "oci_core_get_boot_volume_backup" "name" {
    # arguments
}

    The following arguments are supported:

    BootVolumeBackupId string
    The OCID of the boot volume backup.
    BootVolumeBackupId string
    The OCID of the boot volume backup.
    boot_volume_backup_id string
    The OCID of the boot volume backup.
    bootVolumeBackupId String
    The OCID of the boot volume backup.
    bootVolumeBackupId string
    The OCID of the boot volume backup.
    boot_volume_backup_id str
    The OCID of the boot volume backup.
    bootVolumeBackupId String
    The OCID of the boot volume backup.

    getBootVolumeBackup Result

    The following output properties are available:

    BootVolumeBackupId string
    BootVolumeId string
    The OCID of the boot volume.
    CompartmentId string
    The OCID of the compartment that contains the boot volume backup.
    DefinedTags Dictionary<string, string>
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExpirationTime string
    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.
    FreeformTags Dictionary<string, string>
    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 string
    The OCID of the boot volume backup.
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    IsIndefiniteRetentionEnabled bool
    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.
    IsPreventDeletionEnabled bool
    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.
    IsRetentionLockEnabled bool
    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.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    RetentionPeriods List<GetBootVolumeBackupRetentionPeriod>
    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.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceDetails List<GetBootVolumeBackupSourceDetail>
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    TimeRetentionExpiresAt string
    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 string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    VolumeGroupBackupId string
    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.
    BootVolumeBackupId string
    BootVolumeId string
    The OCID of the boot volume.
    CompartmentId string
    The OCID of the compartment that contains the boot volume backup.
    DefinedTags map[string]string
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExpirationTime string
    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.
    FreeformTags map[string]string
    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 string
    The OCID of the boot volume backup.
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    IsIndefiniteRetentionEnabled bool
    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.
    IsPreventDeletionEnabled bool
    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.
    IsRetentionLockEnabled bool
    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.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    RetentionPeriods []GetBootVolumeBackupRetentionPeriod
    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.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceDetails []GetBootVolumeBackupSourceDetail
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    TimeRetentionExpiresAt string
    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 string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    VolumeGroupBackupId string
    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.
    boot_volume_backup_id string
    boot_volume_id string
    The OCID of the boot volume.
    compartment_id string
    The OCID of the compartment that contains the boot volume backup.
    defined_tags map(string)
    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 string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expiration_time string
    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 map(string)
    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 string
    The OCID of the boot volume backup.
    image_id string
    The image OCID used to create the boot volume the backup is taken from.
    is_indefinite_retention_enabled bool
    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 bool
    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 bool
    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 string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    retention_periods list(object)
    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.
    size_in_gbs string
    The size of the boot volume, in GBs.
    source_boot_volume_backup_id string
    The OCID of the source boot volume backup.
    source_details list(object)
    source_type string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state string
    The current state of a boot volume backup.
    system_tags map(string)
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created string
    The date and time the boot 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 string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    time_retention_expires_at string
    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 string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    unique_size_in_gbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    volume_group_backup_id string
    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.
    bootVolumeBackupId String
    bootVolumeId String
    The OCID of the boot volume.
    compartmentId String
    The OCID of the compartment that contains the boot volume backup.
    definedTags Map<String,String>
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime String
    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.
    freeformTags Map<String,String>
    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 String
    The OCID of the boot volume backup.
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    isIndefiniteRetentionEnabled Boolean
    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.
    isPreventDeletionEnabled Boolean
    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.
    isRetentionLockEnabled Boolean
    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.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    retentionPeriods List<GetBootVolumeBackupRetentionPeriod>
    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.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceDetails List<GetBootVolumeBackupSourceDetail>
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    timeRetentionExpiresAt String
    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 String
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    volumeGroupBackupId String
    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.
    bootVolumeBackupId string
    bootVolumeId string
    The OCID of the boot volume.
    compartmentId string
    The OCID of the compartment that contains the boot volume backup.
    definedTags {[key: string]: string}
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime string
    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.
    freeformTags {[key: string]: string}
    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 string
    The OCID of the boot volume backup.
    imageId string
    The image OCID used to create the boot volume the backup is taken from.
    isIndefiniteRetentionEnabled boolean
    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.
    isPreventDeletionEnabled boolean
    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.
    isRetentionLockEnabled boolean
    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.
    kmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    retentionPeriods GetBootVolumeBackupRetentionPeriod[]
    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.
    sizeInGbs string
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    sourceDetails GetBootVolumeBackupSourceDetail[]
    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state string
    The current state of a boot volume backup.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    timeRetentionExpiresAt string
    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 string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    volumeGroupBackupId string
    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.
    boot_volume_backup_id str
    boot_volume_id str
    The OCID of the boot volume.
    compartment_id str
    The OCID of the compartment that contains the boot volume backup.
    defined_tags Mapping[str, str]
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expiration_time str
    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 Mapping[str, str]
    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 str
    The OCID of the boot volume backup.
    image_id str
    The image OCID used to create the boot volume the backup is taken from.
    is_indefinite_retention_enabled bool
    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 bool
    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 bool
    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 str
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    retention_periods Sequence[GetBootVolumeBackupRetentionPeriod]
    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.
    size_in_gbs str
    The size of the boot volume, in GBs.
    source_boot_volume_backup_id str
    The OCID of the source boot volume backup.
    source_details Sequence[GetBootVolumeBackupSourceDetail]
    source_type str
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state str
    The current state of a boot volume backup.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the boot 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 str
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    time_retention_expires_at str
    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 str
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    unique_size_in_gbs str
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    volume_group_backup_id str
    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.
    bootVolumeBackupId String
    bootVolumeId String
    The OCID of the boot volume.
    compartmentId String
    The OCID of the compartment that contains the boot volume backup.
    definedTags Map<String>
    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
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime String
    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.
    freeformTags Map<String>
    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 String
    The OCID of the boot volume backup.
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    isIndefiniteRetentionEnabled Boolean
    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.
    isPreventDeletionEnabled Boolean
    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.
    isRetentionLockEnabled Boolean
    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.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    retentionPeriods List<Property Map>
    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.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceDetails List<Property Map>
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    timeRetentionExpiresAt String
    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 String
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    volumeGroupBackupId String
    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.

    Supporting Types

    GetBootVolumeBackupRetentionPeriod

    RetentionTimeAmount int
    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.
    RetentionTimeUnit string
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".
    RetentionTimeAmount int
    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.
    RetentionTimeUnit string
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".
    retention_time_amount number
    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 string
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".
    retentionTimeAmount Integer
    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.
    retentionTimeUnit String
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".
    retentionTimeAmount number
    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.
    retentionTimeUnit string
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".
    retention_time_amount int
    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 str
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".
    retentionTimeAmount Number
    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.
    retentionTimeUnit String
    The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS".

    GetBootVolumeBackupSourceDetail

    BootVolumeBackupId string
    The OCID of the boot volume backup.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    Region string
    BootVolumeBackupId string
    The OCID of the boot volume backup.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    Region string
    boot_volume_backup_id string
    The OCID of the boot volume backup.
    kms_key_id string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region string
    bootVolumeBackupId String
    The OCID of the boot volume backup.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region String
    bootVolumeBackupId string
    The OCID of the boot volume backup.
    kmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region string
    boot_volume_backup_id str
    The OCID of the boot volume backup.
    kms_key_id str
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region str
    bootVolumeBackupId String
    The OCID of the boot volume backup.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region String

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.22.0
    published on Wednesday, Aug 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial