ProtectedDatabaseSummary¶

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

Bases: object

A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery.

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

`DATABASE_SIZE_AUTO`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`DATABASE_SIZE_L`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`DATABASE_SIZE_M`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`DATABASE_SIZE_S`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`DATABASE_SIZE_XL`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`DATABASE_SIZE_XS`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`DATABASE_SIZE_XXL`	A constant which can be used with the database_size property of a ProtectedDatabaseSummary.
`HEALTH_ALERT`	A constant which can be used with the health property of a ProtectedDatabaseSummary.
`HEALTH_PROTECTED`	A constant which can be used with the health property of a ProtectedDatabaseSummary.
`HEALTH_WARNING`	A constant which can be used with the health property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_DELETE_SCHEDULED`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary.
`compartment_id`	[Required] Gets the compartment_id of this ProtectedDatabaseSummary.
`database_id`	Gets the database_id of this ProtectedDatabaseSummary.
`database_size`	[Required] Gets the database_size of this ProtectedDatabaseSummary.
`db_unique_name`	[Required] Gets the db_unique_name of this ProtectedDatabaseSummary.
`defined_tags`	Gets the defined_tags of this ProtectedDatabaseSummary.
`display_name`	Gets the display_name of this ProtectedDatabaseSummary.
`freeform_tags`	Gets the freeform_tags of this ProtectedDatabaseSummary.
`health`	Gets the health of this ProtectedDatabaseSummary.
`health_details`	Gets the health_details of this ProtectedDatabaseSummary.
`id`	[Required] Gets the id of this ProtectedDatabaseSummary.
`is_read_only_resource`	Gets the is_read_only_resource of this ProtectedDatabaseSummary.
`lifecycle_details`	Gets the lifecycle_details of this ProtectedDatabaseSummary.
`lifecycle_state`	Gets the lifecycle_state of this ProtectedDatabaseSummary.
`metrics`	Gets the metrics of this ProtectedDatabaseSummary.
`policy_locked_date_time`	Gets the policy_locked_date_time of this ProtectedDatabaseSummary.
`protection_policy_id`	[Required] Gets the protection_policy_id of this ProtectedDatabaseSummary.
`recovery_service_subnets`	Gets the recovery_service_subnets of this ProtectedDatabaseSummary.
`subscription_id`	Gets the subscription_id of this ProtectedDatabaseSummary.
`system_tags`	Gets the system_tags of this ProtectedDatabaseSummary.
`time_created`	Gets the time_created of this ProtectedDatabaseSummary.
`time_updated`	Gets the time_updated of this ProtectedDatabaseSummary.
`vpc_user_name`	[Required] Gets the vpc_user_name of this ProtectedDatabaseSummary.

Methods

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

DATABASE_SIZE_AUTO = 'AUTO'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “AUTO”

DATABASE_SIZE_L = 'L'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “L”

DATABASE_SIZE_M = 'M'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “M”

DATABASE_SIZE_S = 'S'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “S”

DATABASE_SIZE_XL = 'XL'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “XL”

DATABASE_SIZE_XS = 'XS'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “XS”

DATABASE_SIZE_XXL = 'XXL'¶: A constant which can be used with the database_size property of a ProtectedDatabaseSummary. This constant has a value of “XXL”

HEALTH_ALERT = 'ALERT'¶: A constant which can be used with the health property of a ProtectedDatabaseSummary. This constant has a value of “ALERT”

HEALTH_PROTECTED = 'PROTECTED'¶: A constant which can be used with the health property of a ProtectedDatabaseSummary. This constant has a value of “PROTECTED”

HEALTH_WARNING = 'WARNING'¶: A constant which can be used with the health property of a ProtectedDatabaseSummary. This constant has a value of “WARNING”

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

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

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ProtectedDatabaseSummary. 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 ProtectedDatabaseSummary. 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 ProtectedDatabaseSummary. This constant has a value of “DELETING”

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

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

__init__(**kwargs)¶

Initializes a new ProtectedDatabaseSummary 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 ProtectedDatabaseSummary.
display_name (str) – The value to assign to the display_name property of this ProtectedDatabaseSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ProtectedDatabaseSummary.
db_unique_name (str) – The value to assign to the db_unique_name property of this ProtectedDatabaseSummary.
vpc_user_name (str) – The value to assign to the vpc_user_name property of this ProtectedDatabaseSummary.
database_size (str) – The value to assign to the database_size property of this ProtectedDatabaseSummary. Allowed values for this property are: “XS”, “S”, “M”, “L”, “XL”, “XXL”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
protection_policy_id (str) – The value to assign to the protection_policy_id property of this ProtectedDatabaseSummary.
policy_locked_date_time (str) – The value to assign to the policy_locked_date_time property of this ProtectedDatabaseSummary.
recovery_service_subnets (list[oci.recovery.models.RecoveryServiceSubnetDetails]) – The value to assign to the recovery_service_subnets property of this ProtectedDatabaseSummary.
database_id (str) – The value to assign to the database_id property of this ProtectedDatabaseSummary.
time_created (datetime) – The value to assign to the time_created property of this ProtectedDatabaseSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ProtectedDatabaseSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ProtectedDatabaseSummary. 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’.
health (str) – The value to assign to the health property of this ProtectedDatabaseSummary. Allowed values for this property are: “PROTECTED”, “WARNING”, “ALERT”, ‘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 ProtectedDatabaseSummary.
health_details (str) – The value to assign to the health_details property of this ProtectedDatabaseSummary.
is_read_only_resource (bool) – The value to assign to the is_read_only_resource property of this ProtectedDatabaseSummary.
metrics (oci.recovery.models.MetricsSummary) – The value to assign to the metrics property of this ProtectedDatabaseSummary.
subscription_id (str) – The value to assign to the subscription_id property of this ProtectedDatabaseSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ProtectedDatabaseSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ProtectedDatabaseSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ProtectedDatabaseSummary.

compartment_id¶

[Required] Gets the compartment_id of this ProtectedDatabaseSummary. The OCID of the compartment that contains the protected database.

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

database_id¶

Gets the database_id of this ProtectedDatabaseSummary. The OCID of the protected database.

Returns:	The database_id of this ProtectedDatabaseSummary.
Return type:	str

database_size¶

[Required] Gets the database_size of this ProtectedDatabaseSummary. The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.

Allowed values for this property are: “XS”, “S”, “M”, “L”, “XL”, “XXL”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The database_size of this ProtectedDatabaseSummary.
Return type:	str

db_unique_name¶

[Required] Gets the db_unique_name of this ProtectedDatabaseSummary. The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.

Returns:	The db_unique_name of this ProtectedDatabaseSummary.
Return type:	str

defined_tags¶

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

display_name¶

Gets the display_name of this ProtectedDatabaseSummary. The protected database name. You can change the displayName. Avoid entering confidential information.

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

freeform_tags¶

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

health¶

Gets the health of this ProtectedDatabaseSummary. The health of the Protected Database.

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

Returns:	The health of this ProtectedDatabaseSummary.
Return type:	str

health_details¶

Gets the health_details of this ProtectedDatabaseSummary. A message describing the current health of the protected database.

Returns:	The health_details of this ProtectedDatabaseSummary.
Return type:	str

id¶

[Required] Gets the id of this ProtectedDatabaseSummary. The OCID of the protected database.

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

is_read_only_resource¶

Gets the is_read_only_resource of this ProtectedDatabaseSummary. Indicates whether the protected database is created by Recovery Service or created manually. Set to <b>TRUE</b> for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to <b>FALSE</b> for a user-defined protected database.

Returns:	The is_read_only_resource of this ProtectedDatabaseSummary.
Return type:	bool

lifecycle_details¶

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

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

lifecycle_state¶

Gets the lifecycle_state of this ProtectedDatabaseSummary. The current state of the Protected Database.

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 ProtectedDatabaseSummary.
Return type:	str

metrics¶

Gets the metrics of this ProtectedDatabaseSummary.

Returns:	The metrics of this ProtectedDatabaseSummary.
Return type:	oci.recovery.models.MetricsSummary

policy_locked_date_time¶

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

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

protection_policy_id¶

[Required] Gets the protection_policy_id of this ProtectedDatabaseSummary. The OCID of the protection policy associated with the protected database.

Returns:	The protection_policy_id of this ProtectedDatabaseSummary.
Return type:	str

recovery_service_subnets¶

Gets the recovery_service_subnets of this ProtectedDatabaseSummary. List of recovery service subnet resources associated with the protected database.

Returns:	The recovery_service_subnets of this ProtectedDatabaseSummary.
Return type:	list[oci.recovery.models.RecoveryServiceSubnetDetails]

subscription_id¶

Gets the subscription_id of this ProtectedDatabaseSummary. The OCID of the cloud service subscription to which the protected database is linked.

Returns:	The subscription_id of this ProtectedDatabaseSummary.
Return type:	str

system_tags¶

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

time_created¶

Gets the time_created of this ProtectedDatabaseSummary. An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: ‘2020-05-22T21:10:29.600Z’

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

time_updated¶

Gets the time_updated of this ProtectedDatabaseSummary. An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: ‘2020-05-22T21:10:29.600Z’

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

vpc_user_name¶

[Required] Gets the vpc_user_name of this ProtectedDatabaseSummary. The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.

Returns:	The vpc_user_name of this ProtectedDatabaseSummary.
Return type:	str