Class ProtectedDatabaseSummary

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.

Inheritance
object
ProtectedDatabaseSummary
Inherited Members
Namespace: Oci.RecoveryService.Models
Assembly: OCI.DotNetSDK.Recovery.dll
Syntax
public class ProtectedDatabaseSummary

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains the protected database.
Remarks

Required

DatabaseId

Declaration
[JsonProperty(PropertyName = "databaseId")]
public string DatabaseId { get; set; }
Property Value
Type Description
string

The OCID of the protected database.

DatabaseSize

Declaration
[Required(ErrorMessage = "DatabaseSize is required.")]
[JsonProperty(PropertyName = "databaseSize")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseSizes? DatabaseSize { get; set; }
Property Value
Type Description
DatabaseSizes?

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.
Remarks

Required

DbUniqueName

Declaration
[Required(ErrorMessage = "DbUniqueName is required.")]
[JsonProperty(PropertyName = "dbUniqueName")]
public string DbUniqueName { get; set; }
Property Value
Type Description
string

The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The protected database name. You can change the displayName. Avoid entering confidential information.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Health

Declaration
[JsonProperty(PropertyName = "health")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Health? Health { get; set; }
Property Value
Type Description
Health?

The health of the Protected Database.

HealthDetails

Declaration
[JsonProperty(PropertyName = "healthDetails")]
public string HealthDetails { get; set; }
Property Value
Type Description
string

A message describing the current health of the protected database.

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the protected database.
Remarks

Required

IsReadOnlyResource

Declaration
[JsonProperty(PropertyName = "isReadOnlyResource")]
public bool? IsReadOnlyResource { get; set; }
Property Value
Type Description
bool?

Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE 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 FALSE for a user-defined protected database.

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

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.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current state of the Protected Database.

Metrics

Declaration
[JsonProperty(PropertyName = "metrics")]
public MetricsSummary Metrics { get; set; }
Property Value
Type Description
MetricsSummary

PolicyLockedDateTime

Declaration
[JsonProperty(PropertyName = "policyLockedDateTime")]
public string PolicyLockedDateTime { get; set; }
Property Value
Type Description
string

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.

ProtectionPolicyId

Declaration
[Required(ErrorMessage = "ProtectionPolicyId is required.")]
[JsonProperty(PropertyName = "protectionPolicyId")]
public string ProtectionPolicyId { get; set; }
Property Value
Type Description
string

The OCID of the protection policy associated with the protected database.
Remarks

Required

RecoveryServiceSubnets

Declaration
[JsonProperty(PropertyName = "recoveryServiceSubnets")]
public List<RecoveryServiceSubnetDetails> RecoveryServiceSubnets { get; set; }
Property Value
Type Description
List<RecoveryServiceSubnetDetails>

List of recovery service subnet resources associated with the protected database.

SubscriptionId

Declaration
[JsonProperty(PropertyName = "subscriptionId")]
public string SubscriptionId { get; set; }
Property Value
Type Description
string

The OCID of the cloud service subscription to which the protected database is linked.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the created time for a protected database. For Example: '2020-05-22T21:10:29.600Z'

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For Example: '2020-05-22T21:10:29.600Z'

VpcUserName

Declaration
[Required(ErrorMessage = "VpcUserName is required.")]
[JsonProperty(PropertyName = "vpcUserName")]
public string VpcUserName { get; set; }
Property Value
Type Description
string

The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
Remarks

Required