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

oci.Database.getBackupDestination

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

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

    Gets information about the specified backup destination in an Exadata Cloud@Customer system.

    Example Usage

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

const testBackupDestination = oci.Database.getBackupDestination({
    backupDestinationId: testBackupDestinationOciDatabaseBackupDestination.id,
});

    import pulumi
import pulumi_oci as oci

test_backup_destination = oci.Database.get_backup_destination(backup_destination_id=test_backup_destination_oci_database_backup_destination["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.GetBackupDestination(ctx, &database.GetBackupDestinationArgs{
			BackupDestinationId: testBackupDestinationOciDatabaseBackupDestination.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 testBackupDestination = Oci.Database.GetBackupDestination.Invoke(new()
    {
        BackupDestinationId = testBackupDestinationOciDatabaseBackupDestination.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.GetBackupDestinationArgs;
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 testBackupDestination = DatabaseFunctions.getBackupDestination(GetBackupDestinationArgs.builder()
            .backupDestinationId(testBackupDestinationOciDatabaseBackupDestination.id())
            .build());

    }
}

    variables:
  testBackupDestination:
    fn::invoke:
      function: oci:Database:getBackupDestination
      arguments:
        backupDestinationId: ${testBackupDestinationOciDatabaseBackupDestination.id}

    Using getBackupDestination

    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 getBackupDestination(args: GetBackupDestinationArgs, opts?: InvokeOptions): Promise<GetBackupDestinationResult>
function getBackupDestinationOutput(args: GetBackupDestinationOutputArgs, opts?: InvokeOptions): Output<GetBackupDestinationResult>
    def get_backup_destination(backup_destination_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBackupDestinationResult
def get_backup_destination_output(backup_destination_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBackupDestinationResult]
    func GetBackupDestination(ctx *Context, args *GetBackupDestinationArgs, opts ...InvokeOption) (*GetBackupDestinationResult, error)
func GetBackupDestinationOutput(ctx *Context, args *GetBackupDestinationOutputArgs, opts ...InvokeOption) GetBackupDestinationResultOutput

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

    public static class GetBackupDestination 
{
    public static Task<GetBackupDestinationResult> InvokeAsync(GetBackupDestinationArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupDestinationResult> Invoke(GetBackupDestinationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupDestinationResult> getBackupDestination(GetBackupDestinationArgs args, InvokeOptions options)
public static Output<GetBackupDestinationResult> getBackupDestination(GetBackupDestinationArgs args, InvokeOptions options)

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

    The following arguments are supported:

    BackupDestinationId string
    The OCID of the backup destination.
    BackupDestinationId string
    The OCID of the backup destination.
    backupDestinationId String
    The OCID of the backup destination.
    backupDestinationId string
    The OCID of the backup destination.
    backup_destination_id str
    The OCID of the backup destination.
    backupDestinationId String
    The OCID of the backup destination.

    getBackupDestination Result

    The following output properties are available:

    AssociatedDatabases List<GetBackupDestinationAssociatedDatabase>
    List of databases associated with the backup destination.
    BackupDestinationId string
    CompartmentId string
    The OCID of the compartment.
    ConnectionString string
    For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    DisplayName string
    The user-provided name of the backup destination.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the backup destination.
    LifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    LocalMountPointPath string
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

    Deprecated: The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead.

    MountTypeDetails List<GetBackupDestinationMountTypeDetail>
    NfsMountType string
    NFS Mount type for backup destination.
    NfsServerExport string
    Specifies the directory on which to mount the file system
    NfsServers List<string>
    Host names or IP addresses for NFS Auto mount.
    State string
    The current lifecycle state of the backup destination.
    TimeAtWhichStorageDetailsAreUpdated string
    The time when the total storage size and the utilized storage size of the backup destination are updated.
    TimeCreated string
    The date and time the backup destination was created.
    TotalStorageSizeInGbs int
    The total storage size of the backup destination in GBs, rounded to the nearest integer.
    Type string
    Type of the backup destination.
    UtilizedStorageSizeInGbs int
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    VpcUsers List<string>
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.
    AssociatedDatabases []GetBackupDestinationAssociatedDatabase
    List of databases associated with the backup destination.
    BackupDestinationId string
    CompartmentId string
    The OCID of the compartment.
    ConnectionString string
    For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    DisplayName string
    The user-provided name of the backup destination.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the backup destination.
    LifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    LocalMountPointPath string
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

    Deprecated: The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead.

    MountTypeDetails []GetBackupDestinationMountTypeDetail
    NfsMountType string
    NFS Mount type for backup destination.
    NfsServerExport string
    Specifies the directory on which to mount the file system
    NfsServers []string
    Host names or IP addresses for NFS Auto mount.
    State string
    The current lifecycle state of the backup destination.
    TimeAtWhichStorageDetailsAreUpdated string
    The time when the total storage size and the utilized storage size of the backup destination are updated.
    TimeCreated string
    The date and time the backup destination was created.
    TotalStorageSizeInGbs int
    The total storage size of the backup destination in GBs, rounded to the nearest integer.
    Type string
    Type of the backup destination.
    UtilizedStorageSizeInGbs int
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    VpcUsers []string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.
    associatedDatabases List<GetBackupDestinationAssociated>
    List of databases associated with the backup destination.
    backupDestinationId String
    compartmentId String
    The OCID of the compartment.
    connectionString String
    For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName String
    The user-provided name of the backup destination.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the backup destination.
    lifecycleDetails String
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    localMountPointPath String
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

    Deprecated: The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead.

    mountTypeDetails List<GetBackupDestinationMountTypeDetail>
    nfsMountType String
    NFS Mount type for backup destination.
    nfsServerExport String
    Specifies the directory on which to mount the file system
    nfsServers List<String>
    Host names or IP addresses for NFS Auto mount.
    state String
    The current lifecycle state of the backup destination.
    timeAtWhichStorageDetailsAreUpdated String
    The time when the total storage size and the utilized storage size of the backup destination are updated.
    timeCreated String
    The date and time the backup destination was created.
    totalStorageSizeInGbs Integer
    The total storage size of the backup destination in GBs, rounded to the nearest integer.
    type String
    Type of the backup destination.
    utilizedStorageSizeInGbs Integer
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    vpcUsers List<String>
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.
    associatedDatabases GetBackupDestinationAssociatedDatabase[]
    List of databases associated with the backup destination.
    backupDestinationId string
    compartmentId string
    The OCID of the compartment.
    connectionString string
    For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName string
    The user-provided name of the backup destination.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the backup destination.
    lifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    localMountPointPath string
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

    Deprecated: The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead.

    mountTypeDetails GetBackupDestinationMountTypeDetail[]
    nfsMountType string
    NFS Mount type for backup destination.
    nfsServerExport string
    Specifies the directory on which to mount the file system
    nfsServers string[]
    Host names or IP addresses for NFS Auto mount.
    state string
    The current lifecycle state of the backup destination.
    timeAtWhichStorageDetailsAreUpdated string
    The time when the total storage size and the utilized storage size of the backup destination are updated.
    timeCreated string
    The date and time the backup destination was created.
    totalStorageSizeInGbs number
    The total storage size of the backup destination in GBs, rounded to the nearest integer.
    type string
    Type of the backup destination.
    utilizedStorageSizeInGbs number
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    vpcUsers string[]
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.
    associated_databases Sequence[database.GetBackupDestinationAssociatedDatabase]
    List of databases associated with the backup destination.
    backup_destination_id str
    compartment_id str
    The OCID of the compartment.
    connection_string str
    For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    display_name str
    The user-provided name of the backup destination.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the backup destination.
    lifecycle_details str
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    local_mount_point_path str
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

    Deprecated: The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead.

    mount_type_details Sequence[database.GetBackupDestinationMountTypeDetail]
    nfs_mount_type str
    NFS Mount type for backup destination.
    nfs_server_export str
    Specifies the directory on which to mount the file system
    nfs_servers Sequence[str]
    Host names or IP addresses for NFS Auto mount.
    state str
    The current lifecycle state of the backup destination.
    time_at_which_storage_details_are_updated str
    The time when the total storage size and the utilized storage size of the backup destination are updated.
    time_created str
    The date and time the backup destination was created.
    total_storage_size_in_gbs int
    The total storage size of the backup destination in GBs, rounded to the nearest integer.
    type str
    Type of the backup destination.
    utilized_storage_size_in_gbs int
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    vpc_users Sequence[str]
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.
    associatedDatabases List<Property Map>
    List of databases associated with the backup destination.
    backupDestinationId String
    compartmentId String
    The OCID of the compartment.
    connectionString String
    For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName String
    The user-provided name of the backup destination.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the backup destination.
    lifecycleDetails String
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    localMountPointPath String
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

    Deprecated: The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead.

    mountTypeDetails List<Property Map>
    nfsMountType String
    NFS Mount type for backup destination.
    nfsServerExport String
    Specifies the directory on which to mount the file system
    nfsServers List<String>
    Host names or IP addresses for NFS Auto mount.
    state String
    The current lifecycle state of the backup destination.
    timeAtWhichStorageDetailsAreUpdated String
    The time when the total storage size and the utilized storage size of the backup destination are updated.
    timeCreated String
    The date and time the backup destination was created.
    totalStorageSizeInGbs Number
    The total storage size of the backup destination in GBs, rounded to the nearest integer.
    type String
    Type of the backup destination.
    utilizedStorageSizeInGbs Number
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    vpcUsers List<String>
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    Supporting Types

    GetBackupDestinationAssociatedDatabase

    DbName string
    The display name of the database that is associated with the backup destination.
    Id string
    The OCID of the backup destination.
    DbName string
    The display name of the database that is associated with the backup destination.
    Id string
    The OCID of the backup destination.
    dbName String
    The display name of the database that is associated with the backup destination.
    id String
    The OCID of the backup destination.
    dbName string
    The display name of the database that is associated with the backup destination.
    id string
    The OCID of the backup destination.
    db_name str
    The display name of the database that is associated with the backup destination.
    id str
    The OCID of the backup destination.
    dbName String
    The display name of the database that is associated with the backup destination.
    id String
    The OCID of the backup destination.

    GetBackupDestinationMountTypeDetail

    LocalMountPointPath string
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
    MountType string
    NfsServerExport string
    Specifies the directory on which to mount the file system
    NfsServers List<string>
    Host names or IP addresses for NFS Auto mount.
    LocalMountPointPath string
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
    MountType string
    NfsServerExport string
    Specifies the directory on which to mount the file system
    NfsServers []string
    Host names or IP addresses for NFS Auto mount.
    localMountPointPath String
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
    mountType String
    nfsServerExport String
    Specifies the directory on which to mount the file system
    nfsServers List<String>
    Host names or IP addresses for NFS Auto mount.
    localMountPointPath string
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
    mountType string
    nfsServerExport string
    Specifies the directory on which to mount the file system
    nfsServers string[]
    Host names or IP addresses for NFS Auto mount.
    local_mount_point_path str
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
    mount_type str
    nfs_server_export str
    Specifies the directory on which to mount the file system
    nfs_servers Sequence[str]
    Host names or IP addresses for NFS Auto mount.
    localMountPointPath String
    The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
    mountType String
    nfsServerExport String
    Specifies the directory on which to mount the file system
    nfsServers List<String>
    Host names or IP addresses for NFS Auto mount.

    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.28.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-oci