CreateLongTermBackupDetails¶

class oci.recovery.models.CreateLongTermBackupDetails(**kwargs)¶

Bases: object

Describes the parameters required to create an on demand long term backup.

Methods

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

Attributes

`defined_tags`	Gets the defined_tags of this CreateLongTermBackupDetails.
`display_name`	Gets the display_name of this CreateLongTermBackupDetails.
`freeform_tags`	Gets the freeform_tags of this CreateLongTermBackupDetails.
`protected_database_id`	[Required] Gets the protected_database_id of this CreateLongTermBackupDetails.
`retention_period`	[Required] Gets the retention_period of this CreateLongTermBackupDetails.
`retention_point_in_time`	Gets the retention_point_in_time of this CreateLongTermBackupDetails.
`retention_scn`	Gets the retention_scn of this CreateLongTermBackupDetails.

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateLongTermBackupDetails.
protected_database_id (str) – The value to assign to the protected_database_id property of this CreateLongTermBackupDetails.
retention_scn (int) – The value to assign to the retention_scn property of this CreateLongTermBackupDetails.
retention_point_in_time (datetime) – The value to assign to the retention_point_in_time property of this CreateLongTermBackupDetails.
retention_period (list[oci.recovery.models.RetentionPeriodValue]) – The value to assign to the retention_period property of this CreateLongTermBackupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateLongTermBackupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateLongTermBackupDetails.

defined_tags¶

Gets the defined_tags of this CreateLongTermBackupDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}. For more information, see Resource Tags

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

display_name¶

Gets the display_name of this CreateLongTermBackupDetails. A user provided name for the long term backup. The ‘displayName’ does not have to be unique, and it can be modified. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this CreateLongTermBackupDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

protected_database_id¶

[Required] Gets the protected_database_id of this CreateLongTermBackupDetails. The OCID of the protected database for which you want to create the long-term backup.

Returns:	The protected_database_id of this CreateLongTermBackupDetails.
Return type:	str

retention_period¶

[Required] Gets the retention_period of this CreateLongTermBackupDetails. The maximum period to retain the long-term backup. Specify the retention period type and the duration for the long-term backup. If you have chosen the retention period type as ‘DAYS’, then specify a duration ranging from 90 days to 3650 days. If you have chosen the retention period type as ‘YEARS’, then specify a duration ranging from 1 year to 10 years.

Returns:	The retention_period of this CreateLongTermBackupDetails.
Return type:	list[oci.recovery.models.RetentionPeriodValue]

retention_point_in_time¶

Gets the retention_point_in_time of this CreateLongTermBackupDetails. An RFC3339 formatted datetime string that indicates the desired target point in time in the database at which you want to create the long-term backup. For example, if you want the long-term backup to include all the changes until May 22 at 9:10 PM, then specify the value as, ‘2020-05-22T21:10:00.000Z’. If you want to specify the target point as an SCN value instead of the target time, then use the databaseSCN parameter.

Returns:	The retention_point_in_time of this CreateLongTermBackupDetails.
Return type:	datetime

retention_scn¶

Gets the retention_scn of this CreateLongTermBackupDetails. The desired target point (SCN) at which you want to create the long-term backup of the database.For example, specify the value as 1000 if you want to create the long-term backup until SCN 1000. If you want to specify the target point as a time expression instead of the SCN value, then use the longTermRetentionPointInTime parameter.

Returns:	The retention_scn of this CreateLongTermBackupDetails.
Return type:	int