BackupDestinationDetails¶

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

Bases: object

Backup destination details

Attributes

`BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_FOR_72_HOURS`	A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationDetails.
`BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_PER_RETENTION_WINDOW`	A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationDetails.
`TYPE_AWS_S3`	A constant which can be used with the type property of a BackupDestinationDetails.
`TYPE_DBRS`	A constant which can be used with the type property of a BackupDestinationDetails.
`TYPE_LOCAL`	A constant which can be used with the type property of a BackupDestinationDetails.
`TYPE_NFS`	A constant which can be used with the type property of a BackupDestinationDetails.
`TYPE_OBJECT_STORE`	A constant which can be used with the type property of a BackupDestinationDetails.
`TYPE_RECOVERY_APPLIANCE`	A constant which can be used with the type property of a BackupDestinationDetails.
`backup_retention_policy_on_terminate`	Gets the backup_retention_policy_on_terminate of this BackupDestinationDetails.
`dbrs_policy_id`	Gets the dbrs_policy_id of this BackupDestinationDetails.
`id`	Gets the id of this BackupDestinationDetails.
`internet_proxy`	Gets the internet_proxy of this BackupDestinationDetails.
`is_remote`	Gets the is_remote of this BackupDestinationDetails.
`is_retention_lock_enabled`	Gets the is_retention_lock_enabled of this BackupDestinationDetails.
`remote_region`	Gets the remote_region of this BackupDestinationDetails.
`type`	[Required] Gets the type of this BackupDestinationDetails.
`vpc_password`	Gets the vpc_password of this BackupDestinationDetails.
`vpc_user`	Gets the vpc_user of this BackupDestinationDetails.

Methods

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

BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_FOR_72_HOURS = 'RETAIN_FOR_72_HOURS'¶: A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationDetails. This constant has a value of “RETAIN_FOR_72_HOURS”

BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_PER_RETENTION_WINDOW = 'RETAIN_PER_RETENTION_WINDOW'¶: A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationDetails. This constant has a value of “RETAIN_PER_RETENTION_WINDOW”

TYPE_AWS_S3 = 'AWS_S3'¶: A constant which can be used with the type property of a BackupDestinationDetails. This constant has a value of “AWS_S3”

TYPE_DBRS = 'DBRS'¶: A constant which can be used with the type property of a BackupDestinationDetails. This constant has a value of “DBRS”

TYPE_LOCAL = 'LOCAL'¶: A constant which can be used with the type property of a BackupDestinationDetails. This constant has a value of “LOCAL”

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

TYPE_OBJECT_STORE = 'OBJECT_STORE'¶: A constant which can be used with the type property of a BackupDestinationDetails. This constant has a value of “OBJECT_STORE”

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

__init__(**kwargs)¶

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

Parameters:

type (str) – The value to assign to the type property of this BackupDestinationDetails. Allowed values for this property are: “NFS”, “RECOVERY_APPLIANCE”, “OBJECT_STORE”, “LOCAL”, “DBRS”, “AWS_S3”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this BackupDestinationDetails.
vpc_user (str) – The value to assign to the vpc_user property of this BackupDestinationDetails.
vpc_password (str) – The value to assign to the vpc_password property of this BackupDestinationDetails.
internet_proxy (str) – The value to assign to the internet_proxy property of this BackupDestinationDetails.
dbrs_policy_id (str) – The value to assign to the dbrs_policy_id property of this BackupDestinationDetails.
is_retention_lock_enabled (bool) – The value to assign to the is_retention_lock_enabled property of this BackupDestinationDetails.
backup_retention_policy_on_terminate (str) – The value to assign to the backup_retention_policy_on_terminate property of this BackupDestinationDetails. Allowed values for this property are: “RETAIN_PER_RETENTION_WINDOW”, “RETAIN_FOR_72_HOURS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_remote (bool) – The value to assign to the is_remote property of this BackupDestinationDetails.
remote_region (str) – The value to assign to the remote_region property of this BackupDestinationDetails.

backup_retention_policy_on_terminate¶

Gets the backup_retention_policy_on_terminate of this BackupDestinationDetails. Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are ‘RETAIN_PER_RETENTION_WINDOW’ or ‘RETAIN_FOR_72_HOURS’.The default value is ‘RETAIN_FOR_72_HOURS’.

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

Returns:	The backup_retention_policy_on_terminate of this BackupDestinationDetails.
Return type:	str

dbrs_policy_id¶

Gets the dbrs_policy_id of this BackupDestinationDetails. The OCID of the DBRS policy used for backup.

Returns:	The dbrs_policy_id of this BackupDestinationDetails.
Return type:	str

id¶

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

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

internet_proxy¶

Gets the internet_proxy of this BackupDestinationDetails. Proxy URL to connect to object store.

Returns:	The internet_proxy of this BackupDestinationDetails.
Return type:	str

is_remote¶

Gets the is_remote of this BackupDestinationDetails. Indicates whether the backup destination is cross-region or local.

Returns:	The is_remote of this BackupDestinationDetails.
Return type:	bool

is_retention_lock_enabled¶

Gets the is_retention_lock_enabled of this BackupDestinationDetails. Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination.

Returns:	The is_retention_lock_enabled of this BackupDestinationDetails.
Return type:	bool

remote_region¶

Gets the remote_region of this BackupDestinationDetails. The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.

Returns:	The remote_region of this BackupDestinationDetails.
Return type:	str

type¶

[Required] Gets the type of this BackupDestinationDetails. Type of the database backup destination.

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

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

vpc_password¶

Gets the vpc_password of this BackupDestinationDetails. For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.

Returns:	The vpc_password of this BackupDestinationDetails.
Return type:	str

vpc_user¶

Gets the vpc_user of this BackupDestinationDetails. For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

Returns:	The vpc_user of this BackupDestinationDetails.
Return type:	str