CreateProtectionPolicyDetails¶

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

Bases: object

Describes the parameters required to create a custom protection policy.

Methods

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

Attributes

`backup_retention_period_in_days`	[Required] Gets the backup_retention_period_in_days of this CreateProtectionPolicyDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateProtectionPolicyDetails.
`defined_tags`	Gets the defined_tags of this CreateProtectionPolicyDetails.
`display_name`	[Required] Gets the display_name of this CreateProtectionPolicyDetails.
`freeform_tags`	Gets the freeform_tags of this CreateProtectionPolicyDetails.
`must_enforce_cloud_locality`	Gets the must_enforce_cloud_locality of this CreateProtectionPolicyDetails.
`policy_locked_date_time`	Gets the policy_locked_date_time of this CreateProtectionPolicyDetails.

__init__(**kwargs)¶

Initializes a new CreateProtectionPolicyDetails 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 CreateProtectionPolicyDetails.
backup_retention_period_in_days (int) – The value to assign to the backup_retention_period_in_days property of this CreateProtectionPolicyDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateProtectionPolicyDetails.
must_enforce_cloud_locality (bool) – The value to assign to the must_enforce_cloud_locality property of this CreateProtectionPolicyDetails.
policy_locked_date_time (str) – The value to assign to the policy_locked_date_time property of this CreateProtectionPolicyDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateProtectionPolicyDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateProtectionPolicyDetails.

backup_retention_period_in_days¶

[Required] Gets the backup_retention_period_in_days of this CreateProtectionPolicyDetails. The maximum number of days to retain backups for a protected database.

Returns:	The backup_retention_period_in_days of this CreateProtectionPolicyDetails.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this CreateProtectionPolicyDetails. Compartment Identifier

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

defined_tags¶

Gets the defined_tags of this CreateProtectionPolicyDetails. 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 CreateProtectionPolicyDetails.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this CreateProtectionPolicyDetails. A user provided name for the protection policy. The ‘displayName’ does not have to be unique, and it can be modified. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this CreateProtectionPolicyDetails. 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 CreateProtectionPolicyDetails.
Return type:	dict(str, str)

must_enforce_cloud_locality¶

Gets the must_enforce_cloud_locality of this CreateProtectionPolicyDetails. Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. This parameter is applicable if your Oracle Database runs in a different cloud service environment, such as Microsoft Azure. If you set the mustEnforceCloudLocality parameter to TRUE, then Recovery Service stores the database backups locally in the same cloud service environment where the database resides. For example, if your Oracle Database is provisioned on Microsoft Azure, then Recovery Service stores the database backups in Azure. Note: You cannot change the mustEnforceCloudLocality setting for a protection policy after you create it.

Returns:	The must_enforce_cloud_locality of this CreateProtectionPolicyDetails.
Return type:	bool

policy_locked_date_time¶

Gets the policy_locked_date_time of this CreateProtectionPolicyDetails. An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.

The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups.
Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date.
For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to ‘2023-08-15T21:00:00.600Z’ (Aug 15, 2023, 9:00 pm), or greater.
During the 14-day delay period, you can either increase or decrease the retention period in the policy.
However, you are only allowed to increase the retention period on or after the retention lock date.
You cannot change the value of policyLockedDateTime if the retention lock is already in effect.

Returns:	The policy_locked_date_time of this CreateProtectionPolicyDetails.
Return type:	str