ProtectionPolicySummary¶

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

Bases: object

Recovery Service enables policy driven backup storage management.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

For information about access control and compartments, see Overview of the Identity Service.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`LIFECYCLE_STATE_DELETE_SCHEDULED`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary.
`backup_retention_period_in_days`	[Required] Gets the backup_retention_period_in_days of this ProtectionPolicySummary.
`compartment_id`	[Required] Gets the compartment_id of this ProtectionPolicySummary.
`defined_tags`	Gets the defined_tags of this ProtectionPolicySummary.
`display_name`	Gets the display_name of this ProtectionPolicySummary.
`freeform_tags`	Gets the freeform_tags of this ProtectionPolicySummary.
`id`	[Required] Gets the id of this ProtectionPolicySummary.
`is_predefined_policy`	[Required] Gets the is_predefined_policy of this ProtectionPolicySummary.
`lifecycle_details`	Gets the lifecycle_details of this ProtectionPolicySummary.
`lifecycle_state`	Gets the lifecycle_state of this ProtectionPolicySummary.
`must_enforce_cloud_locality`	Gets the must_enforce_cloud_locality of this ProtectionPolicySummary.
`policy_locked_date_time`	Gets the policy_locked_date_time of this ProtectionPolicySummary.
`system_tags`	Gets the system_tags of this ProtectionPolicySummary.
`time_created`	Gets the time_created of this ProtectionPolicySummary.
`time_updated`	Gets the time_updated of this ProtectionPolicySummary.

Methods

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

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

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary. This constant has a value of “CREATING”

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

LIFECYCLE_STATE_DELETE_SCHEDULED = 'DELETE_SCHEDULED'¶: A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary. This constant has a value of “DELETE_SCHEDULED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary. This constant has a value of “DELETING”

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ProtectionPolicySummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ProtectionPolicySummary 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 ProtectionPolicySummary.
display_name (str) – The value to assign to the display_name property of this ProtectionPolicySummary.
compartment_id (str) – The value to assign to the compartment_id property of this ProtectionPolicySummary.
backup_retention_period_in_days (int) – The value to assign to the backup_retention_period_in_days property of this ProtectionPolicySummary.
is_predefined_policy (bool) – The value to assign to the is_predefined_policy property of this ProtectionPolicySummary.
policy_locked_date_time (str) – The value to assign to the policy_locked_date_time property of this ProtectionPolicySummary.
must_enforce_cloud_locality (bool) – The value to assign to the must_enforce_cloud_locality property of this ProtectionPolicySummary.
time_created (datetime) – The value to assign to the time_created property of this ProtectionPolicySummary.
time_updated (datetime) – The value to assign to the time_updated property of this ProtectionPolicySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ProtectionPolicySummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETE_SCHEDULED”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ProtectionPolicySummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ProtectionPolicySummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ProtectionPolicySummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ProtectionPolicySummary.

backup_retention_period_in_days¶

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

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

compartment_id¶

[Required] Gets the compartment_id of this ProtectionPolicySummary. The OCID of the compartment that contains the protection policy.

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

defined_tags¶

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

display_name¶

Gets the display_name of this ProtectionPolicySummary. A user provided name for the protection policy.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ProtectionPolicySummary. The protection policy OCID.

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

is_predefined_policy¶

[Required] Gets the is_predefined_policy of this ProtectionPolicySummary. Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies.

Returns:	The is_predefined_policy of this ProtectionPolicySummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this ProtectionPolicySummary. Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state.

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

lifecycle_state¶

Gets the lifecycle_state of this ProtectionPolicySummary. The current state of the Protection Policy.

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

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

must_enforce_cloud_locality¶

Gets the must_enforce_cloud_locality of this ProtectionPolicySummary. Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.

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

policy_locked_date_time¶

Gets the policy_locked_date_time of this ProtectionPolicySummary. 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.

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

system_tags¶

Gets the system_tags of this ProtectionPolicySummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}. For more information, see Resource Tags

Returns:	The system_tags of this ProtectionPolicySummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this ProtectionPolicySummary. The time the Protection Policy was created. An RFC3339 formatted datetime string

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

time_updated¶

Gets the time_updated of this ProtectionPolicySummary. The time the Protection Policy was updated. An RFC3339 formatted datetime string

Returns:	The time_updated of this ProtectionPolicySummary.
Return type:	datetime