Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. Core
  6. getBootVolumeBackups
Viewing docs for Oracle Cloud Infrastructure v5.1.0
published on Friday, Sep 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Core.getBootVolumeBackups

oci logo oci logo
Viewing docs for Oracle Cloud Infrastructure v5.1.0
published on Friday, Sep 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides the list of Boot Volume Backups in Oracle Cloud Infrastructure Core service.

    Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.

    Example Usage

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

const testBootVolumeBackups = oci.core.getBootVolumeBackups({
    compartmentId: compartmentId,
    bootVolumeId: testBootVolume.id,
    displayName: bootVolumeBackupDisplayName,
    sourceBootVolumeBackupId: testBootVolumeBackup.id,
    state: bootVolumeBackupState,
});

    import pulumi
import pulumi_oci as oci

test_boot_volume_backups = oci.core.get_boot_volume_backups(compartment_id=compartment_id,
    boot_volume_id=test_boot_volume["id"],
    display_name=boot_volume_backup_display_name,
    source_boot_volume_backup_id=test_boot_volume_backup["id"],
    state=boot_volume_backup_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetBootVolumeBackups(ctx, &core.GetBootVolumeBackupsArgs{
			CompartmentId:            compartmentId,
			BootVolumeId:             pulumi.StringRef(testBootVolume.Id),
			DisplayName:              pulumi.StringRef(bootVolumeBackupDisplayName),
			SourceBootVolumeBackupId: pulumi.StringRef(testBootVolumeBackup.Id),
			State:                    pulumi.StringRef(bootVolumeBackupState),
		}, 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 testBootVolumeBackups = Oci.Core.GetBootVolumeBackups.Invoke(new()
    {
        CompartmentId = compartmentId,
        BootVolumeId = testBootVolume.Id,
        DisplayName = bootVolumeBackupDisplayName,
        SourceBootVolumeBackupId = testBootVolumeBackup.Id,
        State = bootVolumeBackupState,
    });

});

    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.GetBootVolumeBackupsArgs;
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 testBootVolumeBackups = CoreFunctions.getBootVolumeBackups(GetBootVolumeBackupsArgs.builder()
            .compartmentId(compartmentId)
            .bootVolumeId(testBootVolume.id())
            .displayName(bootVolumeBackupDisplayName)
            .sourceBootVolumeBackupId(testBootVolumeBackup.id())
            .state(bootVolumeBackupState)
            .build());

    }
}

    variables:
  testBootVolumeBackups:
    fn::invoke:
      function: oci:Core:getBootVolumeBackups
      arguments:
        compartmentId: ${compartmentId}
        bootVolumeId: ${testBootVolume.id}
        displayName: ${bootVolumeBackupDisplayName}
        sourceBootVolumeBackupId: ${testBootVolumeBackup.id}
        state: ${bootVolumeBackupState}

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

data "oci_core_getbootvolumebackups" "testBootVolumeBackups" {
  compartment_id               = compartmentId
  boot_volume_id               = testBootVolume.id
  display_name                 = bootVolumeBackupDisplayName
  source_boot_volume_backup_id = testBootVolumeBackup.id
  state                        = bootVolumeBackupState
}

    Using getBootVolumeBackups

    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 getBootVolumeBackups(args: GetBootVolumeBackupsArgs, opts?: InvokeOptions): Promise<GetBootVolumeBackupsResult>
function getBootVolumeBackupsOutput(args: GetBootVolumeBackupsOutputArgs, opts?: InvokeOutputOptions): Output<GetBootVolumeBackupsResult>
    def get_boot_volume_backups(boot_volume_id: Optional[str] = None,
                            compartment_id: Optional[str] = None,
                            display_name: Optional[str] = None,
                            filters: Optional[Sequence[GetBootVolumeBackupsFilter]] = None,
                            source_boot_volume_backup_id: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetBootVolumeBackupsResult
def get_boot_volume_backups_output(boot_volume_id: pulumi.Input[Optional[str]] = None,
                            compartment_id: pulumi.Input[Optional[str]] = None,
                            display_name: pulumi.Input[Optional[str]] = None,
                            filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetBootVolumeBackupsFilterArgs]]]] = None,
                            source_boot_volume_backup_id: pulumi.Input[Optional[str]] = None,
                            state: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetBootVolumeBackupsResult]
    func GetBootVolumeBackups(ctx *Context, args *GetBootVolumeBackupsArgs, opts ...InvokeOption) (*GetBootVolumeBackupsResult, error)
func GetBootVolumeBackupsOutput(ctx *Context, args *GetBootVolumeBackupsOutputArgs, opts ...InvokeOption) GetBootVolumeBackupsResultOutput

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

    public static class GetBootVolumeBackups 
{
    public static Task<GetBootVolumeBackupsResult> InvokeAsync(GetBootVolumeBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetBootVolumeBackupsResult> Invoke(GetBootVolumeBackupsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBootVolumeBackupsResult> Invoke(GetBootVolumeBackupsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBootVolumeBackupsResult> getBootVolumeBackups(GetBootVolumeBackupsArgs args, InvokeOptions options)
public static Output<GetBootVolumeBackupsResult> getBootVolumeBackups(GetBootVolumeBackupsArgs args, InvokeOptions options)
public static Output<GetBootVolumeBackupsResult> getBootVolumeBackups(GetBootVolumeBackupsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: oci:Core/getBootVolumeBackups:getBootVolumeBackups
  arguments:
    # arguments dictionary
    data "oci_core_get_boot_volume_backups" "name" {
    # arguments
}

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    BootVolumeId string
    The OCID of the boot volume.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetBootVolumeBackupsFilter>
    SourceBootVolumeBackupId string
    A filter to return only resources that originated from the given source boot volume backup.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    CompartmentId string
    The OCID of the compartment.
    BootVolumeId string
    The OCID of the boot volume.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetBootVolumeBackupsFilter
    SourceBootVolumeBackupId string
    A filter to return only resources that originated from the given source boot volume backup.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id string
    The OCID of the compartment.
    boot_volume_id string
    The OCID of the boot volume.
    display_name string
    A filter to return only resources that match the given display name exactly.
    filters list(object)
    source_boot_volume_backup_id string
    A filter to return only resources that originated from the given source boot volume backup.
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment.
    bootVolumeId String
    The OCID of the boot volume.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetBootVolumeBackupsFilter>
    sourceBootVolumeBackupId String
    A filter to return only resources that originated from the given source boot volume backup.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId string
    The OCID of the compartment.
    bootVolumeId string
    The OCID of the boot volume.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetBootVolumeBackupsFilter[]
    sourceBootVolumeBackupId string
    A filter to return only resources that originated from the given source boot volume backup.
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id str
    The OCID of the compartment.
    boot_volume_id str
    The OCID of the boot volume.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[GetBootVolumeBackupsFilter]
    source_boot_volume_backup_id str
    A filter to return only resources that originated from the given source boot volume backup.
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment.
    bootVolumeId String
    The OCID of the boot volume.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    sourceBootVolumeBackupId String
    A filter to return only resources that originated from the given source boot volume backup.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    getBootVolumeBackups Result

    The following output properties are available:

    BootVolumeBackups List<GetBootVolumeBackupsBootVolumeBackup>
    The list of boot_volume_backups.
    CompartmentId string
    The OCID of the compartment that contains the boot volume backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    BootVolumeId string
    The OCID of the boot volume.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetBootVolumeBackupsFilter>
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    State string
    The current state of a boot volume backup.
    BootVolumeBackups []GetBootVolumeBackupsBootVolumeBackup
    The list of boot_volume_backups.
    CompartmentId string
    The OCID of the compartment that contains the boot volume backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    BootVolumeId string
    The OCID of the boot volume.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetBootVolumeBackupsFilter
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    State string
    The current state of a boot volume backup.
    boot_volume_backups list(object)
    The list of boot_volume_backups.
    compartment_id string
    The OCID of the compartment that contains the boot volume backup.
    id string
    The provider-assigned unique ID for this managed resource.
    boot_volume_id string
    The OCID of the boot volume.
    display_name string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters list(object)
    source_boot_volume_backup_id string
    The OCID of the source boot volume backup.
    state string
    The current state of a boot volume backup.
    bootVolumeBackups List<GetBootVolumeBackupsBootVolumeBackup>
    The list of boot_volume_backups.
    compartmentId String
    The OCID of the compartment that contains the boot volume backup.
    id String
    The provider-assigned unique ID for this managed resource.
    bootVolumeId String
    The OCID of the boot volume.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetBootVolumeBackupsFilter>
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    state String
    The current state of a boot volume backup.
    bootVolumeBackups GetBootVolumeBackupsBootVolumeBackup[]
    The list of boot_volume_backups.
    compartmentId string
    The OCID of the compartment that contains the boot volume backup.
    id string
    The provider-assigned unique ID for this managed resource.
    bootVolumeId string
    The OCID of the boot volume.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetBootVolumeBackupsFilter[]
    sourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    state string
    The current state of a boot volume backup.
    boot_volume_backups Sequence[GetBootVolumeBackupsBootVolumeBackup]
    The list of boot_volume_backups.
    compartment_id str
    The OCID of the compartment that contains the boot volume backup.
    id str
    The provider-assigned unique ID for this managed resource.
    boot_volume_id str
    The OCID of the boot volume.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters Sequence[GetBootVolumeBackupsFilter]
    source_boot_volume_backup_id str
    The OCID of the source boot volume backup.
    state str
    The current state of a boot volume backup.
    bootVolumeBackups List<Property Map>
    The list of boot_volume_backups.
    compartmentId String
    The OCID of the compartment that contains the boot volume backup.
    id String
    The provider-assigned unique ID for this managed resource.
    bootVolumeId String
    The OCID of the boot volume.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<Property Map>
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    state String
    The current state of a boot volume backup.

    Supporting Types

    GetBootVolumeBackupsBootVolumeBackup

    BootVolumeId string
    The OCID of the boot volume.
    CompartmentId string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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<GetBootVolumeBackupsBootVolumeBackupRetentionPeriod>
    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
    A filter to return only resources that originated from the given source boot volume backup.
    SourceDetails List<GetBootVolumeBackupsBootVolumeBackupSourceDetail>
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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.
    BootVolumeId string
    The OCID of the boot volume.
    CompartmentId string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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 []GetBootVolumeBackupsBootVolumeBackupRetentionPeriod
    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
    A filter to return only resources that originated from the given source boot volume backup.
    SourceDetails []GetBootVolumeBackupsBootVolumeBackupSourceDetail
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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_id string
    The OCID of the boot volume.
    compartment_id string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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
    A filter to return only resources that originated from the given 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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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.
    bootVolumeId String
    The OCID of the boot volume.
    compartmentId String
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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<GetBootVolumeBackupsBootVolumeBackupRetentionPeriod>
    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
    A filter to return only resources that originated from the given source boot volume backup.
    sourceDetails List<GetBootVolumeBackupsBootVolumeBackupSourceDetail>
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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.
    bootVolumeId string
    The OCID of the boot volume.
    compartmentId string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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 GetBootVolumeBackupsBootVolumeBackupRetentionPeriod[]
    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
    A filter to return only resources that originated from the given source boot volume backup.
    sourceDetails GetBootVolumeBackupsBootVolumeBackupSourceDetail[]
    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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_id str
    The OCID of the boot volume.
    compartment_id str
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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[GetBootVolumeBackupsBootVolumeBackupRetentionPeriod]
    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
    A filter to return only resources that originated from the given source boot volume backup.
    source_details Sequence[GetBootVolumeBackupsBootVolumeBackupSourceDetail]
    source_type str
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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.
    bootVolumeId String
    The OCID of the boot volume.
    compartmentId String
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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
    A filter to return only resources that originated from the given source boot volume backup.
    sourceDetails List<Property Map>
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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.

    GetBootVolumeBackupsBootVolumeBackupRetentionPeriod

    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".

    GetBootVolumeBackupsBootVolumeBackupSourceDetail

    BootVolumeBackupId string
    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
    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
    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
    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
    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
    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
    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

    GetBootVolumeBackupsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name string
    values list(string)
    regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    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 v5.1.0
    published on Friday, Sep 25, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial