1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getAutonomousDatabaseBackup
Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi

oci.Database.getAutonomousDatabaseBackup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi

    This data source provides details about a specific Autonomous Database Backup resource in Oracle Cloud Infrastructure Database service.

    Gets information about the specified Autonomous Database backup.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAutonomousDatabaseBackup = oci.Database.getAutonomousDatabaseBackup({
        autonomousDatabaseBackupId: testAutonomousDatabaseBackupOciDatabaseAutonomousDatabaseBackup.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_autonomous_database_backup = oci.Database.get_autonomous_database_backup(autonomous_database_backup_id=test_autonomous_database_backup_oci_database_autonomous_database_backup["id"])
    
    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.GetAutonomousDatabaseBackup(ctx, &database.GetAutonomousDatabaseBackupArgs{
    			AutonomousDatabaseBackupId: testAutonomousDatabaseBackupOciDatabaseAutonomousDatabaseBackup.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testAutonomousDatabaseBackup = Oci.Database.GetAutonomousDatabaseBackup.Invoke(new()
        {
            AutonomousDatabaseBackupId = testAutonomousDatabaseBackupOciDatabaseAutonomousDatabaseBackup.Id,
        });
    
    });
    
    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.GetAutonomousDatabaseBackupArgs;
    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 testAutonomousDatabaseBackup = DatabaseFunctions.getAutonomousDatabaseBackup(GetAutonomousDatabaseBackupArgs.builder()
                .autonomousDatabaseBackupId(testAutonomousDatabaseBackupOciDatabaseAutonomousDatabaseBackup.id())
                .build());
    
        }
    }
    
    variables:
      testAutonomousDatabaseBackup:
        fn::invoke:
          Function: oci:Database:getAutonomousDatabaseBackup
          Arguments:
            autonomousDatabaseBackupId: ${testAutonomousDatabaseBackupOciDatabaseAutonomousDatabaseBackup.id}
    

    Using getAutonomousDatabaseBackup

    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 getAutonomousDatabaseBackup(args: GetAutonomousDatabaseBackupArgs, opts?: InvokeOptions): Promise<GetAutonomousDatabaseBackupResult>
    function getAutonomousDatabaseBackupOutput(args: GetAutonomousDatabaseBackupOutputArgs, opts?: InvokeOptions): Output<GetAutonomousDatabaseBackupResult>
    def get_autonomous_database_backup(autonomous_database_backup_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetAutonomousDatabaseBackupResult
    def get_autonomous_database_backup_output(autonomous_database_backup_id: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetAutonomousDatabaseBackupResult]
    func GetAutonomousDatabaseBackup(ctx *Context, args *GetAutonomousDatabaseBackupArgs, opts ...InvokeOption) (*GetAutonomousDatabaseBackupResult, error)
    func GetAutonomousDatabaseBackupOutput(ctx *Context, args *GetAutonomousDatabaseBackupOutputArgs, opts ...InvokeOption) GetAutonomousDatabaseBackupResultOutput

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

    public static class GetAutonomousDatabaseBackup 
    {
        public static Task<GetAutonomousDatabaseBackupResult> InvokeAsync(GetAutonomousDatabaseBackupArgs args, InvokeOptions? opts = null)
        public static Output<GetAutonomousDatabaseBackupResult> Invoke(GetAutonomousDatabaseBackupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAutonomousDatabaseBackupResult> getAutonomousDatabaseBackup(GetAutonomousDatabaseBackupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Database/getAutonomousDatabaseBackup:getAutonomousDatabaseBackup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutonomousDatabaseBackupId string
    The OCID of the Autonomous Database backup.
    AutonomousDatabaseBackupId string
    The OCID of the Autonomous Database backup.
    autonomousDatabaseBackupId String
    The OCID of the Autonomous Database backup.
    autonomousDatabaseBackupId string
    The OCID of the Autonomous Database backup.
    autonomous_database_backup_id str
    The OCID of the Autonomous Database backup.
    autonomousDatabaseBackupId String
    The OCID of the Autonomous Database backup.

    getAutonomousDatabaseBackup Result

    The following output properties are available:

    AutonomousDatabaseBackupId string
    AutonomousDatabaseId string
    The OCID of the Autonomous Database.
    BackupDestinationDetails List<GetAutonomousDatabaseBackupBackupDestinationDetail>
    Backup destination details
    CompartmentId string
    The OCID of the compartment.
    DatabaseSizeInTbs double
    The size of the database in terabytes at the time the backup was taken.
    DbVersion string
    A valid Oracle Database version for Autonomous Database.
    DisplayName string
    The user-friendly name for the backup. The name does not have to be unique.
    Id string
    The OCID of the Autonomous Database backup.
    IsAutomatic bool
    Indicates whether the backup is user-initiated or automatic.
    IsLongTermBackup bool
    IsRestorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    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
    Retention period, in days, for long-term backups
    SizeInTbs double
    The backup size in terrabytes (TB).
    State string
    The current state of the backup.
    TimeAvailableTill string
    Timestamp until when the backup will be available
    TimeEnded string
    The date and time the backup completed.
    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.
    AutonomousDatabaseBackupId string
    AutonomousDatabaseId string
    The OCID of the Autonomous Database.
    BackupDestinationDetails []GetAutonomousDatabaseBackupBackupDestinationDetail
    Backup destination details
    CompartmentId string
    The OCID of the compartment.
    DatabaseSizeInTbs float64
    The size of the database in terabytes at the time the backup was taken.
    DbVersion string
    A valid Oracle Database version for Autonomous Database.
    DisplayName string
    The user-friendly name for the backup. The name does not have to be unique.
    Id string
    The OCID of the Autonomous Database backup.
    IsAutomatic bool
    Indicates whether the backup is user-initiated or automatic.
    IsLongTermBackup bool
    IsRestorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    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
    Retention period, in days, for long-term backups
    SizeInTbs float64
    The backup size in terrabytes (TB).
    State string
    The current state of the backup.
    TimeAvailableTill string
    Timestamp until when the backup will be available
    TimeEnded string
    The date and time the backup completed.
    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.
    autonomousDatabaseBackupId String
    autonomousDatabaseId String
    The OCID of the Autonomous Database.
    backupDestinationDetails List<GetAutonomousBackupBackupDestinationDetail>
    Backup destination details
    compartmentId String
    The OCID of the compartment.
    databaseSizeInTbs Double
    The size of the database in terabytes at the time the backup was taken.
    dbVersion String
    A valid Oracle Database version for Autonomous Database.
    displayName String
    The user-friendly name for the backup. The name does not have to be unique.
    id String
    The OCID of the Autonomous Database backup.
    isAutomatic Boolean
    Indicates whether the backup is user-initiated or automatic.
    isLongTermBackup Boolean
    isRestorable Boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    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
    Retention period, in days, for long-term backups
    sizeInTbs Double
    The backup size in terrabytes (TB).
    state String
    The current state of the backup.
    timeAvailableTill String
    Timestamp until when the backup will be available
    timeEnded String
    The date and time the backup completed.
    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.
    autonomousDatabaseBackupId string
    autonomousDatabaseId string
    The OCID of the Autonomous Database.
    backupDestinationDetails GetAutonomousDatabaseBackupBackupDestinationDetail[]
    Backup destination details
    compartmentId string
    The OCID of the compartment.
    databaseSizeInTbs number
    The size of the database in terabytes at the time the backup was taken.
    dbVersion string
    A valid Oracle Database version for Autonomous Database.
    displayName string
    The user-friendly name for the backup. The name does not have to be unique.
    id string
    The OCID of the Autonomous Database backup.
    isAutomatic boolean
    Indicates whether the backup is user-initiated or automatic.
    isLongTermBackup boolean
    isRestorable boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    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
    Retention period, in days, for long-term backups
    sizeInTbs number
    The backup size in terrabytes (TB).
    state string
    The current state of the backup.
    timeAvailableTill string
    Timestamp until when the backup will be available
    timeEnded string
    The date and time the backup completed.
    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.
    autonomous_database_backup_id str
    autonomous_database_id str
    The OCID of the Autonomous Database.
    backup_destination_details Sequence[database.GetAutonomousDatabaseBackupBackupDestinationDetail]
    Backup destination details
    compartment_id str
    The OCID of the compartment.
    database_size_in_tbs float
    The size of the database in terabytes at the time the backup was taken.
    db_version str
    A valid Oracle Database version for Autonomous Database.
    display_name str
    The user-friendly name for the backup. The name does not have to be unique.
    id str
    The OCID of the Autonomous Database backup.
    is_automatic bool
    Indicates whether the backup is user-initiated or automatic.
    is_long_term_backup bool
    is_restorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    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 days, for long-term backups
    size_in_tbs float
    The backup size in terrabytes (TB).
    state str
    The current state of the backup.
    time_available_till str
    Timestamp until when the backup will be available
    time_ended str
    The date and time the backup completed.
    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.
    autonomousDatabaseBackupId String
    autonomousDatabaseId String
    The OCID of the Autonomous Database.
    backupDestinationDetails List<Property Map>
    Backup destination details
    compartmentId String
    The OCID of the compartment.
    databaseSizeInTbs Number
    The size of the database in terabytes at the time the backup was taken.
    dbVersion String
    A valid Oracle Database version for Autonomous Database.
    displayName String
    The user-friendly name for the backup. The name does not have to be unique.
    id String
    The OCID of the Autonomous Database backup.
    isAutomatic Boolean
    Indicates whether the backup is user-initiated or automatic.
    isLongTermBackup Boolean
    isRestorable Boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    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
    Retention period, in days, for long-term backups
    sizeInTbs Number
    The backup size in terrabytes (TB).
    state String
    The current state of the backup.
    timeAvailableTill String
    Timestamp until when the backup will be available
    timeEnded String
    The date and time the backup completed.
    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.

    Supporting Types

    GetAutonomousDatabaseBackupBackupDestinationDetail

    Id string
    The OCID of the Autonomous Database backup.
    InternetProxy string
    Proxy URL to connect to object store.
    Type string
    The type of backup.
    VpcPassword string
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    VpcUser string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    Id string
    The OCID of the Autonomous Database backup.
    InternetProxy string
    Proxy URL to connect to object store.
    Type string
    The type of backup.
    VpcPassword string
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    VpcUser string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    id String
    The OCID of the Autonomous Database backup.
    internetProxy String
    Proxy URL to connect to object store.
    type String
    The type of backup.
    vpcPassword String
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpcUser String
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    id string
    The OCID of the Autonomous Database backup.
    internetProxy string
    Proxy URL to connect to object store.
    type string
    The type of backup.
    vpcPassword string
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpcUser string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    id str
    The OCID of the Autonomous Database backup.
    internet_proxy str
    Proxy URL to connect to object store.
    type str
    The type of backup.
    vpc_password str
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpc_user str
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    id String
    The OCID of the Autonomous Database backup.
    internetProxy String
    Proxy URL to connect to object store.
    type String
    The type of backup.
    vpcPassword String
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpcUser String
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

    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.15.0 published on Thursday, Oct 31, 2024 by Pulumi