Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getBackupDestination

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

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testBackupDestination = Output.Create(Oci.Database.GetBackupDestination.InvokeAsync(new Oci.Database.GetBackupDestinationArgs
        {
            BackupDestinationId = oci_database_backup_destination.Test_backup_destination.Id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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: oci_database_backup_destination.Test_backup_destination.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_backup_destination = oci.Database.get_backup_destination(backup_destination_id=oci_database_backup_destination["test_backup_destination"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

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

Coming soon!

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)
// Output-based functions aren't available in Java yet
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, object>

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, object>

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.

TimeCreated string

The date and time the backup destination was created.

Type string

Type of the backup destination.

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]interface{}

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]interface{}

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.

TimeCreated string

The date and time the backup destination was created.

Type string

Type of the backup destination.

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,Object>

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,Object>

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.

timeCreated String

The date and time the backup destination was created.

type String

Type of the backup destination.

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]: any}

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]: any}

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.

timeCreated string

The date and time the backup destination was created.

type string

Type of the backup destination.

vpcUsers string[]

For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

associated_databases 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, Any]

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, Any]

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 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_created str

The date and time the backup destination was created.

type str

Type of the backup destination.

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

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

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.

timeCreated String

The date and time the backup destination was created.

type String

Type of the backup destination.

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.