backup_destinations

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

Overview

Name	`backup_destinations`
Type	Resource
Id	`oci.database.backup_destinations`

Fields

The following fields are returned by SELECT queries:

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
`get`	`select`	`backupDestinationId`, `region`	`opc-request-id`	Gets information about the specified backup destination in an Exadata Cloud@Customer system.<br />
`create`	`insert`	`region`, `displayName`, `compartmentId`, `type`	`opc-retry-token`, `opc-request-id`	Creates a backup destination in an Exadata Cloud@Customer system.<br />
`update`	`update`	`backupDestinationId`, `region`	`if-match`, `opc-request-id`	If no database is associated with the backup destination:<br />- For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users.<br />- For an NFS backup destination, updates the NFS location.<br />
`delete`	`delete`	`backupDestinationId`, `region`	`if-match`, `opc-request-id`	Deletes a backup destination in an Exadata Cloud@Customer system.<br />
`change_compartment`	`exec`	`backupDestinationId`, `region`, `compartmentId`	`opc-retry-token`, `opc-request-id`, `if-match`	Move the backup destination and its dependent resources to the specified compartment.<br />For more information, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<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
`backupDestinationId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination.
`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)
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc-request-id`	`string`	Unique identifier for the request.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

`SELECT` examples

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

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_destinations
WHERE backupDestinationId = '{{ backupDestinationId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

`INSERT` examples

create
Manifest

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

INSERT INTO oci.database.backup_destinations (
compartmentId,
definedTags,
displayName,
freeformTags,
type,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ type }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
associatedDatabases,
associatedLongTermBackupCount,
associatedLongTermBackups,
compartmentId,
connectionString,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
localMountPointPath,
nfsMountType,
nfsServer,
nfsServerExport,
systemTags,
timeAtWhichStorageDetailsAreUpdated,
timeCreated,
totalStorageSizeInGBs,
type,
utilizedStorageSizeInGBs,
vpcUsers
;

# Description fields are for documentation purposes
- name: backup_destinations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the backup_destinations resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      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).
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-provided name of the backup destination.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      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"}`
  - name: type
    value: "{{ type }}"
    description: |
      Type of the backup destination.
    valid_values: ['NFS', 'RECOVERY_APPLIANCE']
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

`UPDATE` examples

update

If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. - For an NFS backup destination, updates the NFS location.

UPDATE oci.database.backup_destinations
SET 
connectionString = '{{ connectionString }}',
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}',
localMountPointPath = '{{ localMountPointPath }}',
nfsMountType = '{{ nfsMountType }}',
nfsServer = '{{ nfsServer }}',
nfsServerExport = '{{ nfsServerExport }}',
vpcUsers = '{{ vpcUsers }}'
WHERE 
backupDestinationId = '{{ backupDestinationId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
associatedDatabases,
associatedLongTermBackupCount,
associatedLongTermBackups,
compartmentId,
connectionString,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
localMountPointPath,
nfsMountType,
nfsServer,
nfsServerExport,
systemTags,
timeAtWhichStorageDetailsAreUpdated,
timeCreated,
totalStorageSizeInGBs,
type,
utilizedStorageSizeInGBs,
vpcUsers;

`DELETE` examples

delete

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

DELETE FROM oci.database.backup_destinations
WHERE backupDestinationId = '{{ backupDestinationId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

change_compartment

Move the backup destination and its dependent resources to the specified compartment. For more information, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).

EXEC oci.database.backup_destinations.change_compartment 
@backupDestinationId='{{ backupDestinationId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​