backup_destination

Creates, updates, deletes, gets or lists a backup_destination resource.

Overview

Name	backup_destination
Type	Resource
Id	oci.database.backup_destination

Fields

The following fields are returned by SELECT queries:

list

Backup destination details, including the list of databases using the backup destination.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination.
associatedDatabases	array	List of databases associated with the backup destination.
associatedLongTermBackupCount	integer	Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination.
associatedLongTermBackups	array	List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
connectionString	string	For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayName	string	The user-provided name of the backup destination.
freeformTags	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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetails	string	A descriptive text associated with the lifecycleState. Typically contains additional displayable text
lifecycleState	string	The current lifecycle state of the backup destination. (ACTIVE, FAILED, DELETED)
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.
nfsMountType	string	NFS Mount type for backup destination. (SELF_MOUNT, AUTOMATED_MOUNT)
nfsServer	array	Host names or IP addresses for NFS Auto mount.
nfsServerExport	string	Specifies the directory on which to mount the file system
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeAtWhichStorageDetailsAreUpdated	string (date-time)	The time when the total storage size and the utilized storage size of the backup destination are updated.
timeCreated	string (date-time)	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. (NFS, RECOVERY_APPLIANCE)
utilizedStorageSizeInGBs	integer	The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer.
vpcUsers	array	For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	compartmentId, region	limit, page, opc-request-id, type	Gets a list of backup destinations in the specified compartment.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
page	string	The pagination token to continue listing from.
type	string	A filter to return only resources that match the given type of the Backup Destination.

SELECT examples

list

Gets a list of backup destinations in the specified compartment.<br />

SELECT
id,
associatedDatabases,
associatedLongTermBackupCount,
associatedLongTermBackups,
compartmentId,
connectionString,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
localMountPointPath,
nfsMountType,
nfsServer,
nfsServerExport,
systemTags,
timeAtWhichStorageDetailsAreUpdated,
timeCreated,
totalStorageSizeInGBs,
type,
utilizedStorageSizeInGBs,
vpcUsers
FROM oci.database.backup_destination
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND type = '{{ type }}'
;