Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Database.getBackups

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testBackups = oci.Database.getBackups({
    backupDestinationType: backupBackupDestinationType,
    compartmentId: compartmentId,
    databaseId: testDatabase.id,
    shapeFamily: backupShapeFamily,
    state: backupState,
    timeExpiryScheduledGreaterThanOrEqualTo: backupTimeExpiryScheduledGreaterThanOrEqualTo,
    timeExpiryScheduledLessThan: backupTimeExpiryScheduledLessThan,
    type: backupType,
    version: backupVersion,
});

import pulumi
import pulumi_oci as oci

test_backups = oci.Database.get_backups(backup_destination_type=backup_backup_destination_type,
    compartment_id=compartment_id,
    database_id=test_database["id"],
    shape_family=backup_shape_family,
    state=backup_state,
    time_expiry_scheduled_greater_than_or_equal_to=backup_time_expiry_scheduled_greater_than_or_equal_to,
    time_expiry_scheduled_less_than=backup_time_expiry_scheduled_less_than,
    type=backup_type,
    version=backup_version)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.GetBackups(ctx, &database.GetBackupsArgs{
			BackupDestinationType:                   pulumi.StringRef(backupBackupDestinationType),
			CompartmentId:                           pulumi.StringRef(compartmentId),
			DatabaseId:                              pulumi.StringRef(testDatabase.Id),
			ShapeFamily:                             pulumi.StringRef(backupShapeFamily),
			State:                                   pulumi.StringRef(backupState),
			TimeExpiryScheduledGreaterThanOrEqualTo: pulumi.StringRef(backupTimeExpiryScheduledGreaterThanOrEqualTo),
			TimeExpiryScheduledLessThan:             pulumi.StringRef(backupTimeExpiryScheduledLessThan),
			Type:                                    pulumi.StringRef(backupType),
			Version:                                 pulumi.StringRef(backupVersion),
		}, 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 testBackups = Oci.Database.GetBackups.Invoke(new()
    {
        BackupDestinationType = backupBackupDestinationType,
        CompartmentId = compartmentId,
        DatabaseId = testDatabase.Id,
        ShapeFamily = backupShapeFamily,
        State = backupState,
        TimeExpiryScheduledGreaterThanOrEqualTo = backupTimeExpiryScheduledGreaterThanOrEqualTo,
        TimeExpiryScheduledLessThan = backupTimeExpiryScheduledLessThan,
        Type = backupType,
        Version = backupVersion,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetBackupsArgs;
import java.util.List;
import java.util.ArrayList;
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 testBackups = DatabaseFunctions.getBackups(GetBackupsArgs.builder()
            .backupDestinationType(backupBackupDestinationType)
            .compartmentId(compartmentId)
            .databaseId(testDatabase.id())
            .shapeFamily(backupShapeFamily)
            .state(backupState)
            .timeExpiryScheduledGreaterThanOrEqualTo(backupTimeExpiryScheduledGreaterThanOrEqualTo)
            .timeExpiryScheduledLessThan(backupTimeExpiryScheduledLessThan)
            .type(backupType)
            .version(backupVersion)
            .build());

    }
}

variables:
  testBackups:
    fn::invoke:
      function: oci:Database:getBackups
      arguments:
        backupDestinationType: ${backupBackupDestinationType}
        compartmentId: ${compartmentId}
        databaseId: ${testDatabase.id}
        shapeFamily: ${backupShapeFamily}
        state: ${backupState}
        timeExpiryScheduledGreaterThanOrEqualTo: ${backupTimeExpiryScheduledGreaterThanOrEqualTo}
        timeExpiryScheduledLessThan: ${backupTimeExpiryScheduledLessThan}
        type: ${backupType}
        version: ${backupVersion}

Using getBackups

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.

TypeScript
Python
Go
C#
Java
YAML

function getBackups(args: GetBackupsArgs, opts?: InvokeOptions): Promise<GetBackupsResult>
function getBackupsOutput(args: GetBackupsOutputArgs, opts?: InvokeOptions): Output<GetBackupsResult>

def get_backups(backup_destination_type: Optional[str] = None,
                compartment_id: Optional[str] = None,
                database_id: Optional[str] = None,
                filters: Optional[Sequence[_database.GetBackupsFilter]] = None,
                shape_family: Optional[str] = None,
                state: Optional[str] = None,
                time_expiry_scheduled_greater_than_or_equal_to: Optional[str] = None,
                time_expiry_scheduled_less_than: Optional[str] = None,
                type: Optional[str] = None,
                version: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBackupsResult
def get_backups_output(backup_destination_type: Optional[pulumi.Input[str]] = None,
                compartment_id: Optional[pulumi.Input[str]] = None,
                database_id: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetBackupsFilterArgs]]]] = None,
                shape_family: Optional[pulumi.Input[str]] = None,
                state: Optional[pulumi.Input[str]] = None,
                time_expiry_scheduled_greater_than_or_equal_to: Optional[pulumi.Input[str]] = None,
                time_expiry_scheduled_less_than: Optional[pulumi.Input[str]] = None,
                type: Optional[pulumi.Input[str]] = None,
                version: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBackupsResult]

func GetBackups(ctx *Context, args *GetBackupsArgs, opts ...InvokeOption) (*GetBackupsResult, error)
func GetBackupsOutput(ctx *Context, args *GetBackupsOutputArgs, opts ...InvokeOption) GetBackupsResultOutput

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

public static class GetBackups 
{
    public static Task<GetBackupsResult> InvokeAsync(GetBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupsResult> Invoke(GetBackupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBackupsResult> getBackups(GetBackupsArgs args, InvokeOptions options)
public static Output<GetBackupsResult> getBackups(GetBackupsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Database/getBackups:getBackups
  arguments:
    # arguments dictionary

The following arguments are supported:

BackupDestinationType string: A filter to return only resources that match the given backup destination type.
CompartmentId string: The compartment OCID.
DatabaseId string: The OCID of the database.
Filters List<GetBackupsFilter>
ShapeFamily string: If provided, filters the results to the set of database versions which are supported for the given shape family.
State string: A filter to return only resources that match the given lifecycle state exactly.
TimeExpiryScheduledGreaterThanOrEqualTo string: The start of date-time range of expiration for the long term backups to be fetched.
TimeExpiryScheduledLessThan string: The end of date-time range of expiration for the long term backups to be fetched.
Type string: A filter to return only backups that matches with the given type of Backup.
Version string: A filter to return only resources that match the given database version.

BackupDestinationType string: A filter to return only resources that match the given backup destination type.
CompartmentId string: The compartment OCID.
DatabaseId string: The OCID of the database.
Filters []GetBackupsFilter
ShapeFamily string: If provided, filters the results to the set of database versions which are supported for the given shape family.
State string: A filter to return only resources that match the given lifecycle state exactly.
TimeExpiryScheduledGreaterThanOrEqualTo string: The start of date-time range of expiration for the long term backups to be fetched.
TimeExpiryScheduledLessThan string: The end of date-time range of expiration for the long term backups to be fetched.
Type string: A filter to return only backups that matches with the given type of Backup.
Version string: A filter to return only resources that match the given database version.

backupDestinationType String: A filter to return only resources that match the given backup destination type.
compartmentId String: The compartment OCID.
databaseId String: The OCID of the database.
filters List<GetBackupsFilter>
shapeFamily String: If provided, filters the results to the set of database versions which are supported for the given shape family.
state String: A filter to return only resources that match the given lifecycle state exactly.
timeExpiryScheduledGreaterThanOrEqualTo String: The start of date-time range of expiration for the long term backups to be fetched.
timeExpiryScheduledLessThan String: The end of date-time range of expiration for the long term backups to be fetched.
type String: A filter to return only backups that matches with the given type of Backup.
version String: A filter to return only resources that match the given database version.

backupDestinationType string: A filter to return only resources that match the given backup destination type.
compartmentId string: The compartment OCID.
databaseId string: The OCID of the database.
filters GetBackupsFilter[]
shapeFamily string: If provided, filters the results to the set of database versions which are supported for the given shape family.
state string: A filter to return only resources that match the given lifecycle state exactly.
timeExpiryScheduledGreaterThanOrEqualTo string: The start of date-time range of expiration for the long term backups to be fetched.
timeExpiryScheduledLessThan string: The end of date-time range of expiration for the long term backups to be fetched.
type string: A filter to return only backups that matches with the given type of Backup.
version string: A filter to return only resources that match the given database version.

backup_destination_type str: A filter to return only resources that match the given backup destination type.
compartment_id str: The compartment OCID.
database_id str: The OCID of the database.
filters Sequence[database.GetBackupsFilter]
shape_family str: If provided, filters the results to the set of database versions which are supported for the given shape family.
state str: A filter to return only resources that match the given lifecycle state exactly.
time_expiry_scheduled_greater_than_or_equal_to str: The start of date-time range of expiration for the long term backups to be fetched.
time_expiry_scheduled_less_than str: The end of date-time range of expiration for the long term backups to be fetched.
type str: A filter to return only backups that matches with the given type of Backup.
version str: A filter to return only resources that match the given database version.

backupDestinationType String: A filter to return only resources that match the given backup destination type.
compartmentId String: The compartment OCID.
databaseId String: The OCID of the database.
filters List<Property Map>
shapeFamily String: If provided, filters the results to the set of database versions which are supported for the given shape family.
state String: A filter to return only resources that match the given lifecycle state exactly.
timeExpiryScheduledGreaterThanOrEqualTo String: The start of date-time range of expiration for the long term backups to be fetched.
timeExpiryScheduledLessThan String: The end of date-time range of expiration for the long term backups to be fetched.
type String: A filter to return only backups that matches with the given type of Backup.
version String: A filter to return only resources that match the given database version.

getBackups Result

The following output properties are available:

Backups List<GetBackupsBackup>: The list of backups.
Id string: The provider-assigned unique ID for this managed resource.
BackupDestinationType string: Type of the backup destination.
CompartmentId string: The OCID of the compartment.
DatabaseId string: The OCID of the database.
Filters List<GetBackupsFilter>
ShapeFamily string
State string: The current state of the backup.
TimeExpiryScheduledGreaterThanOrEqualTo string
TimeExpiryScheduledLessThan string
Type string: The type of backup.
Version string: Version of the backup's source database

Backups []GetBackupsBackup: The list of backups.
Id string: The provider-assigned unique ID for this managed resource.
BackupDestinationType string: Type of the backup destination.
CompartmentId string: The OCID of the compartment.
DatabaseId string: The OCID of the database.
Filters []GetBackupsFilter
ShapeFamily string
State string: The current state of the backup.
TimeExpiryScheduledGreaterThanOrEqualTo string
TimeExpiryScheduledLessThan string
Type string: The type of backup.
Version string: Version of the backup's source database

backups List<GetBackupsBackup>: The list of backups.
id String: The provider-assigned unique ID for this managed resource.
backupDestinationType String: Type of the backup destination.
compartmentId String: The OCID of the compartment.
databaseId String: The OCID of the database.
filters List<GetBackupsFilter>
shapeFamily String
state String: The current state of the backup.
timeExpiryScheduledGreaterThanOrEqualTo String
timeExpiryScheduledLessThan String
type String: The type of backup.
version String: Version of the backup's source database

backups GetBackupsBackup[]: The list of backups.
id string: The provider-assigned unique ID for this managed resource.
backupDestinationType string: Type of the backup destination.
compartmentId string: The OCID of the compartment.
databaseId string: The OCID of the database.
filters GetBackupsFilter[]
shapeFamily string
state string: The current state of the backup.
timeExpiryScheduledGreaterThanOrEqualTo string
timeExpiryScheduledLessThan string
type string: The type of backup.
version string: Version of the backup's source database

backups Sequence[database.GetBackupsBackup]: The list of backups.
id str: The provider-assigned unique ID for this managed resource.
backup_destination_type str: Type of the backup destination.
compartment_id str: The OCID of the compartment.
database_id str: The OCID of the database.
filters Sequence[database.GetBackupsFilter]
shape_family str
state str: The current state of the backup.
time_expiry_scheduled_greater_than_or_equal_to str
time_expiry_scheduled_less_than str
type str: The type of backup.
version str: Version of the backup's source database

backups List<Property Map>: The list of backups.
id String: The provider-assigned unique ID for this managed resource.
backupDestinationType String: Type of the backup destination.
compartmentId String: The OCID of the compartment.
databaseId String: The OCID of the database.
filters List<Property Map>
shapeFamily String
state String: The current state of the backup.
timeExpiryScheduledGreaterThanOrEqualTo String
timeExpiryScheduledLessThan String
type String: The type of backup.
version String: Version of the backup's source database

Supporting Types

GetBackupsBackup

AvailabilityDomain string: The name of the availability domain where the database backup is stored.
BackupDestinationType string: A filter to return only resources that match the given backup destination type.
CompartmentId string: The compartment OCID.
DatabaseEdition string: The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseId string: The OCID of the database.
DatabaseSizeInGbs double: The size of the database in gigabytes at the time the backup was taken.
DisplayName string: The user-friendly name for the backup. The name does not have to be unique.
EncryptionKeyLocationDetails List<GetBackupsBackupEncryptionKeyLocationDetail>: Types of providers supported for managing database encryption keys
Id string: The OCID of the backup.
IsUsingOracleManagedKeys bool: True if Oracle Managed Keys is required for restore of the backup.
KeyStoreId string: The OCID of the key store of Oracle Vault.
KeyStoreWalletName string: The wallet name for Oracle Key Vault.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LifecycleDetails string: Additional information about the current lifecycle state.
RetentionPeriodInDays int: The retention period of the long term backup in days.
RetentionPeriodInYears int: The retention period of the long term backup in years.
SecondaryKmsKeyIds List<string>: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
Shape string: Shape of the backup's source database.
State string: A filter to return only resources that match the given lifecycle state exactly.
TimeEnded string: The date and time the backup was completed.
TimeExpiryScheduled string: Expiration time of the long term database backup.
TimeStarted string: The date and time the backup started.
Type string: A filter to return only backups that matches with the given type of Backup.
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
Version string: A filter to return only resources that match the given database version.

AvailabilityDomain string: The name of the availability domain where the database backup is stored.
BackupDestinationType string: A filter to return only resources that match the given backup destination type.
CompartmentId string: The compartment OCID.
DatabaseEdition string: The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DatabaseId string: The OCID of the database.
DatabaseSizeInGbs float64: The size of the database in gigabytes at the time the backup was taken.
DisplayName string: The user-friendly name for the backup. The name does not have to be unique.
EncryptionKeyLocationDetails []GetBackupsBackupEncryptionKeyLocationDetail: Types of providers supported for managing database encryption keys
Id string: The OCID of the backup.
IsUsingOracleManagedKeys bool: True if Oracle Managed Keys is required for restore of the backup.
KeyStoreId string: The OCID of the key store of Oracle Vault.
KeyStoreWalletName string: The wallet name for Oracle Key Vault.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
LifecycleDetails string: Additional information about the current lifecycle state.
RetentionPeriodInDays int: The retention period of the long term backup in days.
RetentionPeriodInYears int: The retention period of the long term backup in years.
SecondaryKmsKeyIds []string: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
Shape string: Shape of the backup's source database.
State string: A filter to return only resources that match the given lifecycle state exactly.
TimeEnded string: The date and time the backup was completed.
TimeExpiryScheduled string: Expiration time of the long term database backup.
TimeStarted string: The date and time the backup started.
Type string: A filter to return only backups that matches with the given type of Backup.
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
Version string: A filter to return only resources that match the given database version.

availabilityDomain String: The name of the availability domain where the database backup is stored.
backupDestinationType String: A filter to return only resources that match the given backup destination type.
compartmentId String: The compartment OCID.
databaseEdition String: The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseId String: The OCID of the database.
databaseSizeInGbs Double: The size of the database in gigabytes at the time the backup was taken.
displayName String: The user-friendly name for the backup. The name does not have to be unique.
encryptionKeyLocationDetails List<GetBackupsBackupEncryptionKeyLocationDetail>: Types of providers supported for managing database encryption keys
id String: The OCID of the backup.
isUsingOracleManagedKeys Boolean: True if Oracle Managed Keys is required for restore of the backup.
keyStoreId String: The OCID of the key store of Oracle Vault.
keyStoreWalletName String: The wallet name for Oracle Key Vault.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lifecycleDetails String: Additional information about the current lifecycle state.
retentionPeriodInDays Integer: The retention period of the long term backup in days.
retentionPeriodInYears Integer: The retention period of the long term backup in years.
secondaryKmsKeyIds List<String>: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
shape String: Shape of the backup's source database.
state String: A filter to return only resources that match the given lifecycle state exactly.
timeEnded String: The date and time the backup was completed.
timeExpiryScheduled String: Expiration time of the long term database backup.
timeStarted String: The date and time the backup started.
type String: A filter to return only backups that matches with the given type of Backup.
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
version String: A filter to return only resources that match the given database version.

availabilityDomain string: The name of the availability domain where the database backup is stored.
backupDestinationType string: A filter to return only resources that match the given backup destination type.
compartmentId string: The compartment OCID.
databaseEdition string: The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseId string: The OCID of the database.
databaseSizeInGbs number: The size of the database in gigabytes at the time the backup was taken.
displayName string: The user-friendly name for the backup. The name does not have to be unique.
encryptionKeyLocationDetails GetBackupsBackupEncryptionKeyLocationDetail[]: Types of providers supported for managing database encryption keys
id string: The OCID of the backup.
isUsingOracleManagedKeys boolean: True if Oracle Managed Keys is required for restore of the backup.
keyStoreId string: The OCID of the key store of Oracle Vault.
keyStoreWalletName string: The wallet name for Oracle Key Vault.
kmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lifecycleDetails string: Additional information about the current lifecycle state.
retentionPeriodInDays number: The retention period of the long term backup in days.
retentionPeriodInYears number: The retention period of the long term backup in years.
secondaryKmsKeyIds string[]: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
shape string: Shape of the backup's source database.
state string: A filter to return only resources that match the given lifecycle state exactly.
timeEnded string: The date and time the backup was completed.
timeExpiryScheduled string: Expiration time of the long term database backup.
timeStarted string: The date and time the backup started.
type string: A filter to return only backups that matches with the given type of Backup.
vaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
version string: A filter to return only resources that match the given database version.

availability_domain str: The name of the availability domain where the database backup is stored.
backup_destination_type str: A filter to return only resources that match the given backup destination type.
compartment_id str: The compartment OCID.
database_edition str: The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
database_id str: The OCID of the database.
database_size_in_gbs float: The size of the database in gigabytes at the time the backup was taken.
display_name str: The user-friendly name for the backup. The name does not have to be unique.
encryption_key_location_details Sequence[database.GetBackupsBackupEncryptionKeyLocationDetail]: Types of providers supported for managing database encryption keys
id str: The OCID of the backup.
is_using_oracle_managed_keys bool: True if Oracle Managed Keys is required for restore of the backup.
key_store_id str: The OCID of the key store of Oracle Vault.
key_store_wallet_name str: The wallet name for Oracle Key Vault.
kms_key_id str: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id str: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lifecycle_details str: Additional information about the current lifecycle state.
retention_period_in_days int: The retention period of the long term backup in days.
retention_period_in_years int: The retention period of the long term backup in years.
secondary_kms_key_ids Sequence[str]: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
shape str: Shape of the backup's source database.
state str: A filter to return only resources that match the given lifecycle state exactly.
time_ended str: The date and time the backup was completed.
time_expiry_scheduled str: Expiration time of the long term database backup.
time_started str: The date and time the backup started.
type str: A filter to return only backups that matches with the given type of Backup.
vault_id str: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
version str: A filter to return only resources that match the given database version.

availabilityDomain String: The name of the availability domain where the database backup is stored.
backupDestinationType String: A filter to return only resources that match the given backup destination type.
compartmentId String: The compartment OCID.
databaseEdition String: The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
databaseId String: The OCID of the database.
databaseSizeInGbs Number: The size of the database in gigabytes at the time the backup was taken.
displayName String: The user-friendly name for the backup. The name does not have to be unique.
encryptionKeyLocationDetails List<Property Map>: Types of providers supported for managing database encryption keys
id String: The OCID of the backup.
isUsingOracleManagedKeys Boolean: True if Oracle Managed Keys is required for restore of the backup.
keyStoreId String: The OCID of the key store of Oracle Vault.
keyStoreWalletName String: The wallet name for Oracle Key Vault.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lifecycleDetails String: Additional information about the current lifecycle state.
retentionPeriodInDays Number: The retention period of the long term backup in days.
retentionPeriodInYears Number: The retention period of the long term backup in years.
secondaryKmsKeyIds List<String>: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
shape String: Shape of the backup's source database.
state String: A filter to return only resources that match the given lifecycle state exactly.
timeEnded String: The date and time the backup was completed.
timeExpiryScheduled String: Expiration time of the long term database backup.
timeStarted String: The date and time the backup started.
type String: A filter to return only backups that matches with the given type of Backup.
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
version String: A filter to return only resources that match the given database version.

GetBackupsBackupEncryptionKeyLocationDetail

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
providerType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsm_password str: Provide the HSM password as you would in RDBMS for External HSM.
provider_type str: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

GetBackupsFilter

Name string
Values List<string>
Regex bool

Name string
Values []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.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.getBackups

On this page

On this page

Example Usage

Using getBackups

getBackups Result

Supporting Types

GetBackupsBackup

GetBackupsBackupEncryptionKeyLocationDetail

GetBackupsFilter

Package Details

On this page

On this page