BackupDestination¶

class oci.database.models.BackupDestination(**kwargs)¶

Bases: object

Backup destination details.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a BackupDestination.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a BackupDestination.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a BackupDestination.
`NFS_MOUNT_TYPE_AUTOMATED_MOUNT`	A constant which can be used with the nfs_mount_type property of a BackupDestination.
`NFS_MOUNT_TYPE_SELF_MOUNT`	A constant which can be used with the nfs_mount_type property of a BackupDestination.
`TYPE_NFS`	A constant which can be used with the type property of a BackupDestination.
`TYPE_RECOVERY_APPLIANCE`	A constant which can be used with the type property of a BackupDestination.
`associated_databases`	Gets the associated_databases of this BackupDestination.
`compartment_id`	Gets the compartment_id of this BackupDestination.
`connection_string`	Gets the connection_string of this BackupDestination.
`defined_tags`	Gets the defined_tags of this BackupDestination.
`display_name`	Gets the display_name of this BackupDestination.
`freeform_tags`	Gets the freeform_tags of this BackupDestination.
`id`	Gets the id of this BackupDestination.
`lifecycle_details`	Gets the lifecycle_details of this BackupDestination.
`lifecycle_state`	Gets the lifecycle_state of this BackupDestination.
`local_mount_point_path`	Gets the local_mount_point_path of this BackupDestination.
`nfs_mount_type`	Gets the nfs_mount_type of this BackupDestination.
`nfs_server`	Gets the nfs_server of this BackupDestination.
`nfs_server_export`	Gets the nfs_server_export of this BackupDestination.
`time_created`	Gets the time_created of this BackupDestination.
`type`	Gets the type of this BackupDestination.
`vpc_users`	Gets the vpc_users of this BackupDestination.

Methods

__init__(**kwargs) Initializes a new BackupDestination object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a BackupDestination. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a BackupDestination. This constant has a value of “DELETED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a BackupDestination. This constant has a value of “FAILED”

NFS_MOUNT_TYPE_AUTOMATED_MOUNT = 'AUTOMATED_MOUNT'¶: A constant which can be used with the nfs_mount_type property of a BackupDestination. This constant has a value of “AUTOMATED_MOUNT”

NFS_MOUNT_TYPE_SELF_MOUNT = 'SELF_MOUNT'¶: A constant which can be used with the nfs_mount_type property of a BackupDestination. This constant has a value of “SELF_MOUNT”

TYPE_NFS = 'NFS'¶: A constant which can be used with the type property of a BackupDestination. This constant has a value of “NFS”

TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'¶: A constant which can be used with the type property of a BackupDestination. This constant has a value of “RECOVERY_APPLIANCE”

__init__(**kwargs)¶

Initializes a new BackupDestination object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this BackupDestination.
display_name (str) – The value to assign to the display_name property of this BackupDestination.
compartment_id (str) – The value to assign to the compartment_id property of this BackupDestination.
type (str) – The value to assign to the type property of this BackupDestination. Allowed values for this property are: “NFS”, “RECOVERY_APPLIANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
associated_databases (list[oci.database.models.AssociatedDatabaseDetails]) – The value to assign to the associated_databases property of this BackupDestination.
connection_string (str) – The value to assign to the connection_string property of this BackupDestination.
vpc_users (list[str]) – The value to assign to the vpc_users property of this BackupDestination.
local_mount_point_path (str) – The value to assign to the local_mount_point_path property of this BackupDestination.
nfs_mount_type (str) – The value to assign to the nfs_mount_type property of this BackupDestination. Allowed values for this property are: “SELF_MOUNT”, “AUTOMATED_MOUNT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
nfs_server (list[str]) – The value to assign to the nfs_server property of this BackupDestination.
nfs_server_export (str) – The value to assign to the nfs_server_export property of this BackupDestination.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BackupDestination. Allowed values for this property are: “ACTIVE”, “FAILED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this BackupDestination.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this BackupDestination.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BackupDestination.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BackupDestination.

associated_databases¶

Gets the associated_databases of this BackupDestination. List of databases associated with the backup destination.

Returns:	The associated_databases of this BackupDestination.
Return type:	list[oci.database.models.AssociatedDatabaseDetails]

compartment_id¶

Gets the compartment_id of this BackupDestination. The OCID of the compartment.

Returns:	The compartment_id of this BackupDestination.
Return type:	str

connection_string¶

Gets the connection_string of this BackupDestination. For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

Returns:	The connection_string of this BackupDestination.
Return type:	str

defined_tags¶

Gets the defined_tags of this BackupDestination. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:	The defined_tags of this BackupDestination.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this BackupDestination. The user-provided name of the backup destination.

Returns:	The display_name of this BackupDestination.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this BackupDestination. 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”}

Returns:	The freeform_tags of this BackupDestination.
Return type:	dict(str, str)

id¶

Gets the id of this BackupDestination. The OCID of the backup destination.

Returns:	The id of this BackupDestination.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this BackupDestination. A descriptive text associated with the lifecycleState. Typically contains additional displayable text

Returns:	The lifecycle_details of this BackupDestination.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this BackupDestination. The current lifecycle state of the backup destination.

Allowed values for this property are: “ACTIVE”, “FAILED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this BackupDestination.
Return type:	str

local_mount_point_path¶

Gets the local_mount_point_path of this BackupDestination. 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.

Returns:	The local_mount_point_path of this BackupDestination.
Return type:	str

nfs_mount_type¶

Gets the nfs_mount_type of this BackupDestination. NFS Mount type for backup destination.

Allowed values for this property are: “SELF_MOUNT”, “AUTOMATED_MOUNT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The nfs_mount_type of this BackupDestination.
Return type:	str

nfs_server¶

Gets the nfs_server of this BackupDestination. Host names or IP addresses for NFS Auto mount.

Returns:	The nfs_server of this BackupDestination.
Return type:	list[str]

nfs_server_export¶

Gets the nfs_server_export of this BackupDestination. Specifies the directory on which to mount the file system

Returns:	The nfs_server_export of this BackupDestination.
Return type:	str

time_created¶

Gets the time_created of this BackupDestination. The date and time the backup destination was created.

Returns:	The time_created of this BackupDestination.
Return type:	datetime

type¶

Gets the type of this BackupDestination. Type of the backup destination.

Allowed values for this property are: “NFS”, “RECOVERY_APPLIANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this BackupDestination.
Return type:	str

vpc_users¶

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

Returns:	The vpc_users of this BackupDestination.
Return type:	list[str]