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

oci.Database.getBackupDestinations

Explore with Pulumi AI

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

    This data source provides the list of Backup Destinations in Oracle Cloud Infrastructure Database service.

    Gets a list of backup destinations in the specified compartment.

    Example Usage

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

const testBackupDestinations = oci.Database.getBackupDestinations({
    compartmentId: compartmentId,
    type: backupDestinationType,
});

    import pulumi
import pulumi_oci as oci

test_backup_destinations = oci.Database.get_backup_destinations(compartment_id=compartment_id,
    type=backup_destination_type)

    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.GetBackupDestinations(ctx, &database.GetBackupDestinationsArgs{
			CompartmentId: compartmentId,
			Type:          pulumi.StringRef(backupDestinationType),
		}, 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 testBackupDestinations = Oci.Database.GetBackupDestinations.Invoke(new()
    {
        CompartmentId = compartmentId,
        Type = backupDestinationType,
    });

});

    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.GetBackupDestinationsArgs;
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 testBackupDestinations = DatabaseFunctions.getBackupDestinations(GetBackupDestinationsArgs.builder()
            .compartmentId(compartmentId)
            .type(backupDestinationType)
            .build());

    }
}

    variables:
  testBackupDestinations:
    fn::invoke:
      function: oci:Database:getBackupDestinations
      arguments:
        compartmentId: ${compartmentId}
        type: ${backupDestinationType}

    Using getBackupDestinations

    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 getBackupDestinations(args: GetBackupDestinationsArgs, opts?: InvokeOptions): Promise<GetBackupDestinationsResult>
function getBackupDestinationsOutput(args: GetBackupDestinationsOutputArgs, opts?: InvokeOptions): Output<GetBackupDestinationsResult>
    def get_backup_destinations(compartment_id: Optional[str] = None,
                            filters: Optional[Sequence[GetBackupDestinationsFilter]] = None,
                            type: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetBackupDestinationsResult
def get_backup_destinations_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetBackupDestinationsFilterArgs]]]] = None,
                            type: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetBackupDestinationsResult]
    func GetBackupDestinations(ctx *Context, args *GetBackupDestinationsArgs, opts ...InvokeOption) (*GetBackupDestinationsResult, error)
func GetBackupDestinationsOutput(ctx *Context, args *GetBackupDestinationsOutputArgs, opts ...InvokeOption) GetBackupDestinationsResultOutput

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

    public static class GetBackupDestinations 
{
    public static Task<GetBackupDestinationsResult> InvokeAsync(GetBackupDestinationsArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupDestinationsResult> Invoke(GetBackupDestinationsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupDestinationsResult> getBackupDestinations(GetBackupDestinationsArgs args, InvokeOptions options)
public static Output<GetBackupDestinationsResult> getBackupDestinations(GetBackupDestinationsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    CompartmentId string
    The compartment OCID.
    Filters List<GetBackupDestinationsFilter>
    Type string
    A filter to return only resources that match the given type of the Backup Destination.
    CompartmentId string
    The compartment OCID.
    Filters []GetBackupDestinationsFilter
    Type string
    A filter to return only resources that match the given type of the Backup Destination.
    compartmentId String
    The compartment OCID.
    filters List<GetBackupDestinationsFilter>
    type String
    A filter to return only resources that match the given type of the Backup Destination.
    compartmentId string
    The compartment OCID.
    filters GetBackupDestinationsFilter[]
    type string
    A filter to return only resources that match the given type of the Backup Destination.
    compartment_id str
    The compartment OCID.
    filters Sequence[GetBackupDestinationsFilter]
    type str
    A filter to return only resources that match the given type of the Backup Destination.
    compartmentId String
    The compartment OCID.
    filters List<Property Map>
    type String
    A filter to return only resources that match the given type of the Backup Destination.

    getBackupDestinations Result

    The following output properties are available:

    BackupDestinations List<GetBackupDestinationsBackupDestination>
    The list of backup_destinations.
    CompartmentId string
    The OCID of the compartment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters List<GetBackupDestinationsFilter>
    Type string
    Type of the backup destination.
    BackupDestinations []GetBackupDestinationsBackupDestination
    The list of backup_destinations.
    CompartmentId string
    The OCID of the compartment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters []GetBackupDestinationsFilter
    Type string
    Type of the backup destination.
    backupDestinations List<GetBackupDestinationsBackupDestination>
    The list of backup_destinations.
    compartmentId String
    The OCID of the compartment.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<GetBackupDestinationsFilter>
    type String
    Type of the backup destination.
    backupDestinations GetBackupDestinationsBackupDestination[]
    The list of backup_destinations.
    compartmentId string
    The OCID of the compartment.
    id string
    The provider-assigned unique ID for this managed resource.
    filters GetBackupDestinationsFilter[]
    type string
    Type of the backup destination.
    backup_destinations Sequence[GetBackupDestinationsBackupDestination]
    The list of backup_destinations.
    compartment_id str
    The OCID of the compartment.
    id str
    The provider-assigned unique ID for this managed resource.
    filters Sequence[GetBackupDestinationsFilter]
    type str
    Type of the backup destination.
    backupDestinations List<Property Map>
    The list of backup_destinations.
    compartmentId String
    The OCID of the compartment.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<Property Map>
    type String
    Type of the backup destination.

    Supporting Types

    GetBackupDestinationsBackupDestination

    AssociatedDatabases List<GetBackupDestinationsBackupDestinationAssociatedDatabase>
    List of databases associated with the backup destination.
    CompartmentId string
    The compartment OCID.
    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<GetBackupDestinationsBackupDestinationMountTypeDetail>
    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
    A filter to return only resources that match the given 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 []GetBackupDestinationsBackupDestinationAssociatedDatabase
    List of databases associated with the backup destination.
    CompartmentId string
    The compartment OCID.
    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 []GetBackupDestinationsBackupDestinationMountTypeDetail
    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
    A filter to return only resources that match the given 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<GetBackupDestinationsBackupDestinationAssociated>
    List of databases associated with the backup destination.
    compartmentId String
    The compartment OCID.
    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<GetBackupDestinationsBackupDestinationMountTypeDetail>
    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
    A filter to return only resources that match the given 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 GetBackupDestinationsBackupDestinationAssociatedDatabase[]
    List of databases associated with the backup destination.
    compartmentId string
    The compartment OCID.
    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 GetBackupDestinationsBackupDestinationMountTypeDetail[]
    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
    A filter to return only resources that match the given 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[GetBackupDestinationsBackupDestinationAssociatedDatabase]
    List of databases associated with the backup destination.
    compartment_id str
    The compartment OCID.
    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[GetBackupDestinationsBackupDestinationMountTypeDetail]
    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
    A filter to return only resources that match the given 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.
    compartmentId String
    The compartment OCID.
    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
    A filter to return only resources that match the given 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.

    GetBackupDestinationsBackupDestinationAssociatedDatabase

    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.

    GetBackupDestinationsBackupDestinationMountTypeDetail

    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.

    GetBackupDestinationsFilter

    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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci