Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. Backup
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.Database.Backup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Backup resource in Oracle Cloud Infrastructure Database service.

    Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

    Example Usage

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

const testBackup = new oci.database.Backup("test_backup", {
    databaseId: testDatabase.id,
    displayName: backupDisplayName,
});

    import pulumi
import pulumi_oci as oci

test_backup = oci.database.Backup("test_backup",
    database_id=test_database["id"],
    display_name=backup_display_name)

    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.NewBackup(ctx, "test_backup", &database.BackupArgs{
			DatabaseId:  pulumi.Any(testDatabase.Id),
			DisplayName: pulumi.Any(backupDisplayName),
		})
		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 testBackup = new Oci.Database.Backup("test_backup", new()
    {
        DatabaseId = testDatabase.Id,
        DisplayName = backupDisplayName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.Backup;
import com.pulumi.oci.Database.BackupArgs;
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) {
        var testBackup = new Backup("testBackup", BackupArgs.builder()
            .databaseId(testDatabase.id())
            .displayName(backupDisplayName)
            .build());

    }
}

    resources:
  testBackup:
    type: oci:Database:Backup
    name: test_backup
    properties:
      databaseId: ${testDatabase.id}
      displayName: ${backupDisplayName}

    Create Backup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           database_id: Optional[str] = None,
           display_name: Optional[str] = None,
           retention_period_in_days: Optional[int] = None,
           retention_period_in_years: Optional[int] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

    type: oci:Database:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var backupResource = new Oci.Database.Backup("backupResource", new()
{
    DatabaseId = "string",
    DisplayName = "string",
    RetentionPeriodInDays = 0,
    RetentionPeriodInYears = 0,
});

    example, err := database.NewBackup(ctx, "backupResource", &database.BackupArgs{
	DatabaseId:             pulumi.String("string"),
	DisplayName:            pulumi.String("string"),
	RetentionPeriodInDays:  pulumi.Int(0),
	RetentionPeriodInYears: pulumi.Int(0),
})

    var backupResource = new com.pulumi.oci.Database.Backup("backupResource", com.pulumi.oci.Database.BackupArgs.builder()
    .databaseId("string")
    .displayName("string")
    .retentionPeriodInDays(0)
    .retentionPeriodInYears(0)
    .build());

    backup_resource = oci.database.Backup("backupResource",
    database_id="string",
    display_name="string",
    retention_period_in_days=0,
    retention_period_in_years=0)

    const backupResource = new oci.database.Backup("backupResource", {
    databaseId: "string",
    displayName: "string",
    retentionPeriodInDays: 0,
    retentionPeriodInYears: 0,
});

    type: oci:Database:Backup
properties:
    databaseId: string
    displayName: string
    retentionPeriodInDays: 0
    retentionPeriodInYears: 0

    Backup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Backup resource accepts the following input properties:

    DatabaseId string
    The OCID of the database.
    DisplayName string

    The user-friendly name for the backup. The name does not have to be unique.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RetentionPeriodInDays int
    RetentionPeriodInYears int
    DatabaseId string
    The OCID of the database.
    DisplayName string

    The user-friendly name for the backup. The name does not have to be unique.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RetentionPeriodInDays int
    RetentionPeriodInYears int
    databaseId String
    The OCID of the database.
    displayName String

    The user-friendly name for the backup. The name does not have to be unique.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionPeriodInDays Integer
    retentionPeriodInYears Integer
    databaseId string
    The OCID of the database.
    displayName string

    The user-friendly name for the backup. The name does not have to be unique.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionPeriodInDays number
    retentionPeriodInYears number
    database_id str
    The OCID of the database.
    display_name str

    The user-friendly name for the backup. The name does not have to be unique.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retention_period_in_days int
    retention_period_in_years int
    databaseId String
    The OCID of the database.
    displayName String

    The user-friendly name for the backup. The name does not have to be unique.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionPeriodInDays Number
    retentionPeriodInYears Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

    AvailabilityDomain string
    The name of the availability domain where the database backup is stored.
    BackupDestinationType string
    CompartmentId string
    The OCID of the compartment.
    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.
    DatabaseSizeInGbs double
    The size of the database in gigabytes at the time the backup was taken.
    EncryptionKeyLocationDetails List<BackupEncryptionKeyLocationDetail>
    Types of providers supported for managing database encryption keys
    Id string
    The provider-assigned unique ID for this managed resource.
    IsUsingOracleManagedKeys bool
    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.
    SecondaryKmsKeyIds List<string>
    Shape string
    Shape of the backup's source database.
    State string
    The current state of the backup.
    TimeEnded string
    The date and time the backup was completed.
    TimeExpiryScheduled string
    TimeStarted string
    The date and time the backup started.
    Type string
    The 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
    Version of the backup's source database
    AvailabilityDomain string
    The name of the availability domain where the database backup is stored.
    BackupDestinationType string
    CompartmentId string
    The OCID of the compartment.
    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.
    DatabaseSizeInGbs float64
    The size of the database in gigabytes at the time the backup was taken.
    EncryptionKeyLocationDetails []BackupEncryptionKeyLocationDetail
    Types of providers supported for managing database encryption keys
    Id string
    The provider-assigned unique ID for this managed resource.
    IsUsingOracleManagedKeys bool
    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.
    SecondaryKmsKeyIds []string
    Shape string
    Shape of the backup's source database.
    State string
    The current state of the backup.
    TimeEnded string
    The date and time the backup was completed.
    TimeExpiryScheduled string
    TimeStarted string
    The date and time the backup started.
    Type string
    The 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
    Version of the backup's source database
    availabilityDomain String
    The name of the availability domain where the database backup is stored.
    backupDestinationType String
    compartmentId String
    The OCID of the compartment.
    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.
    databaseSizeInGbs Double
    The size of the database in gigabytes at the time the backup was taken.
    encryptionKeyLocationDetails List<BackupEncryptionKeyLocationDetail>
    Types of providers supported for managing database encryption keys
    id String
    The provider-assigned unique ID for this managed resource.
    isUsingOracleManagedKeys Boolean
    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.
    secondaryKmsKeyIds List<String>
    shape String
    Shape of the backup's source database.
    state String
    The current state of the backup.
    timeEnded String
    The date and time the backup was completed.
    timeExpiryScheduled String
    timeStarted String
    The date and time the backup started.
    type String
    The 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
    Version of the backup's source database
    availabilityDomain string
    The name of the availability domain where the database backup is stored.
    backupDestinationType string
    compartmentId string
    The OCID of the compartment.
    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.
    databaseSizeInGbs number
    The size of the database in gigabytes at the time the backup was taken.
    encryptionKeyLocationDetails BackupEncryptionKeyLocationDetail[]
    Types of providers supported for managing database encryption keys
    id string
    The provider-assigned unique ID for this managed resource.
    isUsingOracleManagedKeys boolean
    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.
    secondaryKmsKeyIds string[]
    shape string
    Shape of the backup's source database.
    state string
    The current state of the backup.
    timeEnded string
    The date and time the backup was completed.
    timeExpiryScheduled string
    timeStarted string
    The date and time the backup started.
    type string
    The 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
    Version of the backup's source database
    availability_domain str
    The name of the availability domain where the database backup is stored.
    backup_destination_type str
    compartment_id str
    The OCID of the compartment.
    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_size_in_gbs float
    The size of the database in gigabytes at the time the backup was taken.
    encryption_key_location_details Sequence[BackupEncryptionKeyLocationDetail]
    Types of providers supported for managing database encryption keys
    id str
    The provider-assigned unique ID for this managed resource.
    is_using_oracle_managed_keys bool
    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.
    secondary_kms_key_ids Sequence[str]
    shape str
    Shape of the backup's source database.
    state str
    The current state of the backup.
    time_ended str
    The date and time the backup was completed.
    time_expiry_scheduled str
    time_started str
    The date and time the backup started.
    type str
    The 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
    Version of the backup's source database
    availabilityDomain String
    The name of the availability domain where the database backup is stored.
    backupDestinationType String
    compartmentId String
    The OCID of the compartment.
    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.
    databaseSizeInGbs Number
    The size of the database in gigabytes at the time the backup was taken.
    encryptionKeyLocationDetails List<Property Map>
    Types of providers supported for managing database encryption keys
    id String
    The provider-assigned unique ID for this managed resource.
    isUsingOracleManagedKeys Boolean
    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.
    secondaryKmsKeyIds List<String>
    shape String
    Shape of the backup's source database.
    state String
    The current state of the backup.
    timeEnded String
    The date and time the backup was completed.
    timeExpiryScheduled String
    timeStarted String
    The date and time the backup started.
    type String
    The 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
    Version of the backup's source database

    Look up Existing Backup Resource

    Get an existing Backup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domain: Optional[str] = None,
        backup_destination_type: Optional[str] = None,
        compartment_id: Optional[str] = None,
        database_edition: Optional[str] = None,
        database_id: Optional[str] = None,
        database_size_in_gbs: Optional[float] = None,
        display_name: Optional[str] = None,
        encryption_key_location_details: Optional[Sequence[BackupEncryptionKeyLocationDetailArgs]] = None,
        is_using_oracle_managed_keys: Optional[bool] = None,
        key_store_id: Optional[str] = None,
        key_store_wallet_name: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        kms_key_version_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        retention_period_in_days: Optional[int] = None,
        retention_period_in_years: Optional[int] = None,
        secondary_kms_key_ids: Optional[Sequence[str]] = None,
        shape: Optional[str] = None,
        state: Optional[str] = None,
        time_ended: Optional[str] = None,
        time_expiry_scheduled: Optional[str] = None,
        time_started: Optional[str] = None,
        type: Optional[str] = None,
        vault_id: Optional[str] = None,
        version: Optional[str] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
    resources:  _:    type: oci:Database:Backup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailabilityDomain string
    The name of the availability domain where the database backup is stored.
    BackupDestinationType string
    CompartmentId string
    The OCID of the compartment.
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    EncryptionKeyLocationDetails List<BackupEncryptionKeyLocationDetail>
    Types of providers supported for managing database encryption keys
    IsUsingOracleManagedKeys bool
    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
    RetentionPeriodInYears int
    SecondaryKmsKeyIds List<string>
    Shape string
    Shape of the backup's source database.
    State string
    The current state of the backup.
    TimeEnded string
    The date and time the backup was completed.
    TimeExpiryScheduled string
    TimeStarted string
    The date and time the backup started.
    Type string
    The 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
    Version of the backup's source database
    AvailabilityDomain string
    The name of the availability domain where the database backup is stored.
    BackupDestinationType string
    CompartmentId string
    The OCID of the compartment.
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    EncryptionKeyLocationDetails []BackupEncryptionKeyLocationDetailArgs
    Types of providers supported for managing database encryption keys
    IsUsingOracleManagedKeys bool
    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
    RetentionPeriodInYears int
    SecondaryKmsKeyIds []string
    Shape string
    Shape of the backup's source database.
    State string
    The current state of the backup.
    TimeEnded string
    The date and time the backup was completed.
    TimeExpiryScheduled string
    TimeStarted string
    The date and time the backup started.
    Type string
    The 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
    Version of the backup's source database
    availabilityDomain String
    The name of the availability domain where the database backup is stored.
    backupDestinationType String
    compartmentId String
    The OCID of the compartment.
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryptionKeyLocationDetails List<BackupEncryptionKeyLocationDetail>
    Types of providers supported for managing database encryption keys
    isUsingOracleManagedKeys Boolean
    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
    retentionPeriodInYears Integer
    secondaryKmsKeyIds List<String>
    shape String
    Shape of the backup's source database.
    state String
    The current state of the backup.
    timeEnded String
    The date and time the backup was completed.
    timeExpiryScheduled String
    timeStarted String
    The date and time the backup started.
    type String
    The 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
    Version of the backup's source database
    availabilityDomain string
    The name of the availability domain where the database backup is stored.
    backupDestinationType string
    compartmentId string
    The OCID of the compartment.
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryptionKeyLocationDetails BackupEncryptionKeyLocationDetail[]
    Types of providers supported for managing database encryption keys
    isUsingOracleManagedKeys boolean
    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
    retentionPeriodInYears number
    secondaryKmsKeyIds string[]
    shape string
    Shape of the backup's source database.
    state string
    The current state of the backup.
    timeEnded string
    The date and time the backup was completed.
    timeExpiryScheduled string
    timeStarted string
    The date and time the backup started.
    type string
    The 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
    Version of the backup's source database
    availability_domain str
    The name of the availability domain where the database backup is stored.
    backup_destination_type str
    compartment_id str
    The OCID of the compartment.
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryption_key_location_details Sequence[BackupEncryptionKeyLocationDetailArgs]
    Types of providers supported for managing database encryption keys
    is_using_oracle_managed_keys bool
    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
    retention_period_in_years int
    secondary_kms_key_ids Sequence[str]
    shape str
    Shape of the backup's source database.
    state str
    The current state of the backup.
    time_ended str
    The date and time the backup was completed.
    time_expiry_scheduled str
    time_started str
    The date and time the backup started.
    type str
    The 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
    Version of the backup's source database
    availabilityDomain String
    The name of the availability domain where the database backup is stored.
    backupDestinationType String
    compartmentId String
    The OCID of the compartment.
    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    encryptionKeyLocationDetails List<Property Map>
    Types of providers supported for managing database encryption keys
    isUsingOracleManagedKeys Boolean
    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
    retentionPeriodInYears Number
    secondaryKmsKeyIds List<String>
    shape String
    Shape of the backup's source database.
    state String
    The current state of the backup.
    timeEnded String
    The date and time the backup was completed.
    timeExpiryScheduled String
    timeStarted String
    The date and time the backup started.
    type String
    The 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
    Version of the backup's source database

    Supporting Types

    BackupEncryptionKeyLocationDetail, BackupEncryptionKeyLocationDetailArgs

    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.

    Import

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

    $ pulumi import oci:Database/backup:Backup test_backup "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci