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

oci.Database.BackupDestination

Explore with Pulumi AI

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

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

    Creates a backup destination in an Exadata Cloud@Customer system.

    Example Usage

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

const testBackupDestination = new oci.database.BackupDestination("test_backup_destination", {
    compartmentId: compartmentId,
    displayName: backupDestinationDisplayName,
    type: backupDestinationType,
    connectionString: backupDestinationConnectionString,
    definedTags: backupDestinationDefinedTags,
    freeformTags: {
        Department: "Finance",
    },
    localMountPointPath: backupDestinationLocalMountPointPath,
    mountTypeDetails: {
        mountType: backupDestinationMountTypeDetailsMountType,
        localMountPointPath: backupDestinationMountTypeDetailsLocalMountPointPath,
        nfsServers: backupDestinationMountTypeDetailsNfsServer,
        nfsServerExport: backupDestinationMountTypeDetailsNfsServerExport,
    },
    vpcUsers: backupDestinationVpcUsers,
});

    import pulumi
import pulumi_oci as oci

test_backup_destination = oci.database.BackupDestination("test_backup_destination",
    compartment_id=compartment_id,
    display_name=backup_destination_display_name,
    type=backup_destination_type,
    connection_string=backup_destination_connection_string,
    defined_tags=backup_destination_defined_tags,
    freeform_tags={
        "Department": "Finance",
    },
    local_mount_point_path=backup_destination_local_mount_point_path,
    mount_type_details={
        "mount_type": backup_destination_mount_type_details_mount_type,
        "local_mount_point_path": backup_destination_mount_type_details_local_mount_point_path,
        "nfs_servers": backup_destination_mount_type_details_nfs_server,
        "nfs_server_export": backup_destination_mount_type_details_nfs_server_export,
    },
    vpc_users=backup_destination_vpc_users)

    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.NewBackupDestination(ctx, "test_backup_destination", &database.BackupDestinationArgs{
			CompartmentId:    pulumi.Any(compartmentId),
			DisplayName:      pulumi.Any(backupDestinationDisplayName),
			Type:             pulumi.Any(backupDestinationType),
			ConnectionString: pulumi.Any(backupDestinationConnectionString),
			DefinedTags:      pulumi.Any(backupDestinationDefinedTags),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			LocalMountPointPath: pulumi.Any(backupDestinationLocalMountPointPath),
			MountTypeDetails: &database.BackupDestinationMountTypeDetailsArgs{
				MountType:           pulumi.Any(backupDestinationMountTypeDetailsMountType),
				LocalMountPointPath: pulumi.Any(backupDestinationMountTypeDetailsLocalMountPointPath),
				NfsServers:          pulumi.Any(backupDestinationMountTypeDetailsNfsServer),
				NfsServerExport:     pulumi.Any(backupDestinationMountTypeDetailsNfsServerExport),
			},
			VpcUsers: pulumi.Any(backupDestinationVpcUsers),
		})
		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 = new Oci.Database.BackupDestination("test_backup_destination", new()
    {
        CompartmentId = compartmentId,
        DisplayName = backupDestinationDisplayName,
        Type = backupDestinationType,
        ConnectionString = backupDestinationConnectionString,
        DefinedTags = backupDestinationDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        LocalMountPointPath = backupDestinationLocalMountPointPath,
        MountTypeDetails = new Oci.Database.Inputs.BackupDestinationMountTypeDetailsArgs
        {
            MountType = backupDestinationMountTypeDetailsMountType,
            LocalMountPointPath = backupDestinationMountTypeDetailsLocalMountPointPath,
            NfsServers = backupDestinationMountTypeDetailsNfsServer,
            NfsServerExport = backupDestinationMountTypeDetailsNfsServerExport,
        },
        VpcUsers = backupDestinationVpcUsers,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.BackupDestination;
import com.pulumi.oci.Database.BackupDestinationArgs;
import com.pulumi.oci.Database.inputs.BackupDestinationMountTypeDetailsArgs;
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 testBackupDestination = new BackupDestination("testBackupDestination", BackupDestinationArgs.builder()
            .compartmentId(compartmentId)
            .displayName(backupDestinationDisplayName)
            .type(backupDestinationType)
            .connectionString(backupDestinationConnectionString)
            .definedTags(backupDestinationDefinedTags)
            .freeformTags(Map.of("Department", "Finance"))
            .localMountPointPath(backupDestinationLocalMountPointPath)
            .mountTypeDetails(BackupDestinationMountTypeDetailsArgs.builder()
                .mountType(backupDestinationMountTypeDetailsMountType)
                .localMountPointPath(backupDestinationMountTypeDetailsLocalMountPointPath)
                .nfsServers(backupDestinationMountTypeDetailsNfsServer)
                .nfsServerExport(backupDestinationMountTypeDetailsNfsServerExport)
                .build())
            .vpcUsers(backupDestinationVpcUsers)
            .build());

    }
}

    resources:
  testBackupDestination:
    type: oci:Database:BackupDestination
    name: test_backup_destination
    properties:
      compartmentId: ${compartmentId}
      displayName: ${backupDestinationDisplayName}
      type: ${backupDestinationType}
      connectionString: ${backupDestinationConnectionString}
      definedTags: ${backupDestinationDefinedTags}
      freeformTags:
        Department: Finance
      localMountPointPath: ${backupDestinationLocalMountPointPath}
      mountTypeDetails:
        mountType: ${backupDestinationMountTypeDetailsMountType}
        localMountPointPath: ${backupDestinationMountTypeDetailsLocalMountPointPath}
        nfsServers: ${backupDestinationMountTypeDetailsNfsServer}
        nfsServerExport: ${backupDestinationMountTypeDetailsNfsServerExport}
      vpcUsers: ${backupDestinationVpcUsers}

    Create BackupDestination Resource

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

    Constructor syntax

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

@overload
def BackupDestination(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      type: Optional[str] = None,
                      connection_string: Optional[str] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      local_mount_point_path: Optional[str] = None,
                      mount_type_details: Optional[_database.BackupDestinationMountTypeDetailsArgs] = None,
                      vpc_users: Optional[Sequence[str]] = None)
    func NewBackupDestination(ctx *Context, name string, args BackupDestinationArgs, opts ...ResourceOption) (*BackupDestination, error)
    public BackupDestination(string name, BackupDestinationArgs args, CustomResourceOptions? opts = null)
    public BackupDestination(String name, BackupDestinationArgs args)
public BackupDestination(String name, BackupDestinationArgs args, CustomResourceOptions options)

    type: oci:Database:BackupDestination
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 BackupDestinationArgs
    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 BackupDestinationArgs
    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 BackupDestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupDestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupDestinationArgs
    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 backupDestinationResource = new Oci.Database.BackupDestination("backupDestinationResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    Type = "string",
    ConnectionString = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    MountTypeDetails = new Oci.Database.Inputs.BackupDestinationMountTypeDetailsArgs
    {
        MountType = "string",
        LocalMountPointPath = "string",
        NfsServerExport = "string",
        NfsServers = new[]
        {
            "string",
        },
    },
    VpcUsers = new[]
    {
        "string",
    },
});

    example, err := Database.NewBackupDestination(ctx, "backupDestinationResource", &Database.BackupDestinationArgs{
	CompartmentId:    pulumi.String("string"),
	DisplayName:      pulumi.String("string"),
	Type:             pulumi.String("string"),
	ConnectionString: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	MountTypeDetails: &database.BackupDestinationMountTypeDetailsArgs{
		MountType:           pulumi.String("string"),
		LocalMountPointPath: pulumi.String("string"),
		NfsServerExport:     pulumi.String("string"),
		NfsServers: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	VpcUsers: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var backupDestinationResource = new BackupDestination("backupDestinationResource", BackupDestinationArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .type("string")
    .connectionString("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .mountTypeDetails(BackupDestinationMountTypeDetailsArgs.builder()
        .mountType("string")
        .localMountPointPath("string")
        .nfsServerExport("string")
        .nfsServers("string")
        .build())
    .vpcUsers("string")
    .build());

    backup_destination_resource = oci.database.BackupDestination("backupDestinationResource",
    compartment_id="string",
    display_name="string",
    type="string",
    connection_string="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    mount_type_details={
        "mount_type": "string",
        "local_mount_point_path": "string",
        "nfs_server_export": "string",
        "nfs_servers": ["string"],
    },
    vpc_users=["string"])

    const backupDestinationResource = new oci.database.BackupDestination("backupDestinationResource", {
    compartmentId: "string",
    displayName: "string",
    type: "string",
    connectionString: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    mountTypeDetails: {
        mountType: "string",
        localMountPointPath: "string",
        nfsServerExport: "string",
        nfsServers: ["string"],
    },
    vpcUsers: ["string"],
});

    type: oci:Database:BackupDestination
properties:
    compartmentId: string
    connectionString: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    mountTypeDetails:
        localMountPointPath: string
        mountType: string
        nfsServerExport: string
        nfsServers:
            - string
    type: string
    vpcUsers:
        - string

    BackupDestination 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 BackupDestination resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment.
    DisplayName string
    The user-provided name of the backup destination.
    Type string
    Type of the backup destination.
    ConnectionString string
    (Updatable) The connection string for connecting to the Recovery Appliance.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    LocalMountPointPath string
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    MountTypeDetails BackupDestinationMountTypeDetails
    Mount type details for backup destination.
    VpcUsers List<string>

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    CompartmentId string
    (Updatable) The OCID of the compartment.
    DisplayName string
    The user-provided name of the backup destination.
    Type string
    Type of the backup destination.
    ConnectionString string
    (Updatable) The connection string for connecting to the Recovery Appliance.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags map[string]string
    (Updatable) 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"}
    LocalMountPointPath string
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    MountTypeDetails BackupDestinationMountTypeDetailsArgs
    Mount type details for backup destination.
    VpcUsers []string

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment.
    displayName String
    The user-provided name of the backup destination.
    type String
    Type of the backup destination.
    connectionString String
    (Updatable) The connection string for connecting to the Recovery Appliance.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<String,String>
    (Updatable) 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"}
    localMountPointPath String
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mountTypeDetails BackupDestinationMountTypeDetails
    Mount type details for backup destination.
    vpcUsers List<String>

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    compartmentId string
    (Updatable) The OCID of the compartment.
    displayName string
    The user-provided name of the backup destination.
    type string
    Type of the backup destination.
    connectionString string
    (Updatable) The connection string for connecting to the Recovery Appliance.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    localMountPointPath string
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mountTypeDetails BackupDestinationMountTypeDetails
    Mount type details for backup destination.
    vpcUsers string[]

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    compartment_id str
    (Updatable) The OCID of the compartment.
    display_name str
    The user-provided name of the backup destination.
    type str
    Type of the backup destination.
    connection_string str
    (Updatable) The connection string for connecting to the Recovery Appliance.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    local_mount_point_path str
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mount_type_details database.BackupDestinationMountTypeDetailsArgs
    Mount type details for backup destination.
    vpc_users Sequence[str]

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment.
    displayName String
    The user-provided name of the backup destination.
    type String
    Type of the backup destination.
    connectionString String
    (Updatable) The connection string for connecting to the Recovery Appliance.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<String>
    (Updatable) 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"}
    localMountPointPath String
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mountTypeDetails Property Map
    Mount type details for backup destination.
    vpcUsers List<String>

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    Outputs

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

    AssociatedDatabases List<BackupDestinationAssociatedDatabase>
    List of databases associated with the backup destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    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.
    UtilizedStorageSizeInGbs int
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    AssociatedDatabases []BackupDestinationAssociatedDatabase
    List of databases associated with the backup destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    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.
    UtilizedStorageSizeInGbs int
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    associatedDatabases List<BackupDestinationAssociated>
    List of databases associated with the backup destination.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    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.
    utilizedStorageSizeInGbs Integer
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    associatedDatabases BackupDestinationAssociatedDatabase[]
    List of databases associated with the backup destination.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    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.
    utilizedStorageSizeInGbs number
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    associated_databases Sequence[database.BackupDestinationAssociatedDatabase]
    List of databases associated with the backup destination.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    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.
    utilized_storage_size_in_gbs int
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
    associatedDatabases List<Property Map>
    List of databases associated with the backup destination.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    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.
    utilizedStorageSizeInGbs Number
    The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.

    Look up Existing BackupDestination Resource

    Get an existing BackupDestination 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?: BackupDestinationState, opts?: CustomResourceOptions): BackupDestination
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associated_databases: Optional[Sequence[_database.BackupDestinationAssociatedDatabaseArgs]] = None,
        compartment_id: Optional[str] = None,
        connection_string: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        local_mount_point_path: Optional[str] = None,
        mount_type_details: Optional[_database.BackupDestinationMountTypeDetailsArgs] = None,
        nfs_mount_type: Optional[str] = None,
        nfs_server_export: Optional[str] = None,
        nfs_servers: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        time_at_which_storage_details_are_updated: Optional[str] = None,
        time_created: Optional[str] = None,
        total_storage_size_in_gbs: Optional[int] = None,
        type: Optional[str] = None,
        utilized_storage_size_in_gbs: Optional[int] = None,
        vpc_users: Optional[Sequence[str]] = None) -> BackupDestination
    func GetBackupDestination(ctx *Context, name string, id IDInput, state *BackupDestinationState, opts ...ResourceOption) (*BackupDestination, error)
    public static BackupDestination Get(string name, Input<string> id, BackupDestinationState? state, CustomResourceOptions? opts = null)
    public static BackupDestination get(String name, Output<String> id, BackupDestinationState state, CustomResourceOptions options)
    resources:  _:    type: oci:Database:BackupDestination    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:
    AssociatedDatabases List<BackupDestinationAssociatedDatabase>
    List of databases associated with the backup destination.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    ConnectionString string
    (Updatable) The connection string for connecting to the Recovery Appliance.
    DefinedTags Dictionary<string, string>
    (Updatable) 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>
    (Updatable) 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"}
    LifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    LocalMountPointPath string
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    MountTypeDetails BackupDestinationMountTypeDetails
    Mount type details for backup destination.
    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>

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    AssociatedDatabases []BackupDestinationAssociatedDatabaseArgs
    List of databases associated with the backup destination.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    ConnectionString string
    (Updatable) The connection string for connecting to the Recovery Appliance.
    DefinedTags map[string]string
    (Updatable) 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
    (Updatable) 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"}
    LifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    LocalMountPointPath string
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    MountTypeDetails BackupDestinationMountTypeDetailsArgs
    Mount type details for backup destination.
    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

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    associatedDatabases List<BackupDestinationAssociated>
    List of databases associated with the backup destination.
    compartmentId String
    (Updatable) The OCID of the compartment.
    connectionString String
    (Updatable) The connection string for connecting to the Recovery Appliance.
    definedTags Map<String,String>
    (Updatable) 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>
    (Updatable) 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"}
    lifecycleDetails String
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    localMountPointPath String
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mountTypeDetails BackupDestinationMountTypeDetails
    Mount type details for backup destination.
    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>

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    associatedDatabases BackupDestinationAssociatedDatabase[]
    List of databases associated with the backup destination.
    compartmentId string
    (Updatable) The OCID of the compartment.
    connectionString string
    (Updatable) The connection string for connecting to the Recovery Appliance.
    definedTags {[key: string]: string}
    (Updatable) 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}
    (Updatable) 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"}
    lifecycleDetails string
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    localMountPointPath string
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mountTypeDetails BackupDestinationMountTypeDetails
    Mount type details for backup destination.
    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[]

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    associated_databases Sequence[database.BackupDestinationAssociatedDatabaseArgs]
    List of databases associated with the backup destination.
    compartment_id str
    (Updatable) The OCID of the compartment.
    connection_string str
    (Updatable) The connection string for connecting to the Recovery Appliance.
    defined_tags Mapping[str, str]
    (Updatable) 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]
    (Updatable) 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"}
    lifecycle_details str
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    local_mount_point_path str
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mount_type_details database.BackupDestinationMountTypeDetailsArgs
    Mount type details for backup destination.
    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]

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    associatedDatabases List<Property Map>
    List of databases associated with the backup destination.
    compartmentId String
    (Updatable) The OCID of the compartment.
    connectionString String
    (Updatable) The connection string for connecting to the Recovery Appliance.
    definedTags Map<String>
    (Updatable) 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>
    (Updatable) 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"}
    lifecycleDetails String
    A descriptive text associated with the lifecycleState. Typically contains additional displayable text
    localMountPointPath String
    (Updatable) Deprecated. 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. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.

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

    mountTypeDetails Property Map
    Mount type details for backup destination.
    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>

    (Updatable) The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

    ** 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

    Supporting Types

    BackupDestinationAssociatedDatabase, BackupDestinationAssociatedDatabaseArgs

    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.

    BackupDestinationMountTypeDetails, BackupDestinationMountTypeDetailsArgs

    MountType string
    Mount type for backup destination.
    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.
    NfsServerExport string
    Specifies the directory on which to mount the file system
    NfsServers List<string>
    IP addresses for NFS Auto mount.
    MountType string
    Mount type for backup destination.
    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.
    NfsServerExport string
    Specifies the directory on which to mount the file system
    NfsServers []string
    IP addresses for NFS Auto mount.
    mountType String
    Mount type for backup destination.
    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.
    nfsServerExport String
    Specifies the directory on which to mount the file system
    nfsServers List<String>
    IP addresses for NFS Auto mount.
    mountType string
    Mount type for backup destination.
    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.
    nfsServerExport string
    Specifies the directory on which to mount the file system
    nfsServers string[]
    IP addresses for NFS Auto mount.
    mount_type str
    Mount type for backup destination.
    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.
    nfs_server_export str
    Specifies the directory on which to mount the file system
    nfs_servers Sequence[str]
    IP addresses for NFS Auto mount.
    mountType String
    Mount type for backup destination.
    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.
    nfsServerExport String
    Specifies the directory on which to mount the file system
    nfsServers List<String>
    IP addresses for NFS Auto mount.

    Import

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

    $ pulumi import oci:Database/backupDestination:BackupDestination test_backup_destination "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.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci