BackupDestinationConfigurationSummary

class oci.database.models.BackupDestinationConfigurationSummary(**kwargs)

Bases: object

Information about the Autonomous Container Database’s secondary backup destination(s).

Attributes:

BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_FOR_72_HOURS

A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationConfigurationSummary.

BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_PER_RETENTION_WINDOW

A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationConfigurationSummary.

TYPE_AWS_S3

A constant which can be used with the type property of a BackupDestinationConfigurationSummary.

TYPE_DBRS

A constant which can be used with the type property of a BackupDestinationConfigurationSummary.

TYPE_LOCAL

A constant which can be used with the type property of a BackupDestinationConfigurationSummary.

TYPE_NFS

A constant which can be used with the type property of a BackupDestinationConfigurationSummary.

TYPE_OBJECT_STORE

A constant which can be used with the type property of a BackupDestinationConfigurationSummary.

TYPE_RECOVERY_APPLIANCE

A constant which can be used with the type property of a BackupDestinationConfigurationSummary.

backup_destination_attach_history

Gets the backup_destination_attach_history of this BackupDestinationConfigurationSummary.

backup_retention_policy_on_terminate

Gets the backup_retention_policy_on_terminate of this BackupDestinationConfigurationSummary.

dbrs_policy_id

Gets the dbrs_policy_id of this BackupDestinationConfigurationSummary.

id

Gets the id of this BackupDestinationConfigurationSummary.

internet_proxy

Gets the internet_proxy of this BackupDestinationConfigurationSummary.

is_remote

Gets the is_remote of this BackupDestinationConfigurationSummary.

is_retention_lock_enabled

Gets the is_retention_lock_enabled of this BackupDestinationConfigurationSummary.

is_zero_data_loss_enabled

Gets the is_zero_data_loss_enabled of this BackupDestinationConfigurationSummary.

recovery_window_in_days

Gets the recovery_window_in_days of this BackupDestinationConfigurationSummary.

remote_region

Gets the remote_region of this BackupDestinationConfigurationSummary.

space_utilized_in_gbs

Gets the space_utilized_in_gbs of this BackupDestinationConfigurationSummary.

tde_wallet_backup_destination

Gets the tde_wallet_backup_destination of this BackupDestinationConfigurationSummary.

time_at_which_storage_details_are_updated

Gets the time_at_which_storage_details_are_updated of this BackupDestinationConfigurationSummary.

type

[Required] Gets the type of this BackupDestinationConfigurationSummary.

vpc_password

Gets the vpc_password of this BackupDestinationConfigurationSummary.

vpc_user

Gets the vpc_user of this BackupDestinationConfigurationSummary.

Methods:

__init__(**kwargs)

Initializes a new BackupDestinationConfigurationSummary object with values from keyword arguments.

BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_FOR_72_HOURS = 'RETAIN_FOR_72_HOURS'

A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationConfigurationSummary. This constant has a value of “RETAIN_FOR_72_HOURS”

BACKUP_RETENTION_POLICY_ON_TERMINATE_RETAIN_PER_RETENTION_WINDOW = 'RETAIN_PER_RETENTION_WINDOW'

A constant which can be used with the backup_retention_policy_on_terminate property of a BackupDestinationConfigurationSummary. This constant has a value of “RETAIN_PER_RETENTION_WINDOW”

TYPE_AWS_S3 = 'AWS_S3'

A constant which can be used with the type property of a BackupDestinationConfigurationSummary. This constant has a value of “AWS_S3”

TYPE_DBRS = 'DBRS'

A constant which can be used with the type property of a BackupDestinationConfigurationSummary. This constant has a value of “DBRS”

TYPE_LOCAL = 'LOCAL'

A constant which can be used with the type property of a BackupDestinationConfigurationSummary. This constant has a value of “LOCAL”

TYPE_NFS = 'NFS'

A constant which can be used with the type property of a BackupDestinationConfigurationSummary. This constant has a value of “NFS”

TYPE_OBJECT_STORE = 'OBJECT_STORE'

A constant which can be used with the type property of a BackupDestinationConfigurationSummary. This constant has a value of “OBJECT_STORE”

TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'

A constant which can be used with the type property of a BackupDestinationConfigurationSummary. This constant has a value of “RECOVERY_APPLIANCE”

__init__(**kwargs)

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

Parameters
  • recovery_window_in_days (int) – The value to assign to the recovery_window_in_days property of this BackupDestinationConfigurationSummary.

  • backup_destination_attach_history (list[datetime]) – The value to assign to the backup_destination_attach_history property of this BackupDestinationConfigurationSummary.

  • space_utilized_in_gbs (int) – The value to assign to the space_utilized_in_gbs property of this BackupDestinationConfigurationSummary.

  • time_at_which_storage_details_are_updated (datetime) – The value to assign to the time_at_which_storage_details_are_updated property of this BackupDestinationConfigurationSummary.

  • type (str) – The value to assign to the type property of this BackupDestinationConfigurationSummary. Allowed values for this property are: “NFS”, “RECOVERY_APPLIANCE”, “OBJECT_STORE”, “LOCAL”, “DBRS”, “AWS_S3”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • id (str) – The value to assign to the id property of this BackupDestinationConfigurationSummary.

  • vpc_user (str) – The value to assign to the vpc_user property of this BackupDestinationConfigurationSummary.

  • vpc_password (str) – The value to assign to the vpc_password property of this BackupDestinationConfigurationSummary.

  • is_zero_data_loss_enabled (bool) – The value to assign to the is_zero_data_loss_enabled property of this BackupDestinationConfigurationSummary.

  • internet_proxy (str) – The value to assign to the internet_proxy property of this BackupDestinationConfigurationSummary.

  • dbrs_policy_id (str) – The value to assign to the dbrs_policy_id property of this BackupDestinationConfigurationSummary.

  • is_retention_lock_enabled (bool) – The value to assign to the is_retention_lock_enabled property of this BackupDestinationConfigurationSummary.

  • backup_retention_policy_on_terminate (str) – The value to assign to the backup_retention_policy_on_terminate property of this BackupDestinationConfigurationSummary. Allowed values for this property are: “RETAIN_PER_RETENTION_WINDOW”, “RETAIN_FOR_72_HOURS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • is_remote (bool) – The value to assign to the is_remote property of this BackupDestinationConfigurationSummary.

  • remote_region (str) – The value to assign to the remote_region property of this BackupDestinationConfigurationSummary.

  • tde_wallet_backup_destination (oci.database.models.TdeWalletBackupDestination) – The value to assign to the tde_wallet_backup_destination property of this BackupDestinationConfigurationSummary.

property backup_destination_attach_history

Gets the backup_destination_attach_history of this BackupDestinationConfigurationSummary. The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups.

Returns

The backup_destination_attach_history of this BackupDestinationConfigurationSummary.

Return type

list[datetime]

property backup_retention_policy_on_terminate

Gets the backup_retention_policy_on_terminate of this BackupDestinationConfigurationSummary. Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are ‘RETAIN_PER_RETENTION_WINDOW’ or ‘RETAIN_FOR_72_HOURS’.The default value is ‘RETAIN_FOR_72_HOURS’.

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

Returns

The backup_retention_policy_on_terminate of this BackupDestinationConfigurationSummary.

Return type

str

property dbrs_policy_id

Gets the dbrs_policy_id of this BackupDestinationConfigurationSummary. The OCID of the DBRS policy used for backup. Not applicable for Autonomous Container Databases on Cloud Autonomous VM Cluster and Autonomous VM Cluster.

Returns

The dbrs_policy_id of this BackupDestinationConfigurationSummary.

Return type

str

property id

Gets the id of this BackupDestinationConfigurationSummary. The OCID of the backup destination. Not applicable for Autonomous Container Databases on Cloud Autonomous VM Cluster.

Returns

The id of this BackupDestinationConfigurationSummary.

Return type

str

property internet_proxy

Gets the internet_proxy of this BackupDestinationConfigurationSummary. Proxy URL to connect to object store. Not applicable for Autonomous Container Databases on Cloud Autonomous VM Cluster.

Returns

The internet_proxy of this BackupDestinationConfigurationSummary.

Return type

str

property is_remote

Gets the is_remote of this BackupDestinationConfigurationSummary. Indicates whether the backup destination is cross-region or local.

Returns

The is_remote of this BackupDestinationConfigurationSummary.

Return type

bool

property is_retention_lock_enabled

Gets the is_retention_lock_enabled of this BackupDestinationConfigurationSummary. Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination.

Returns

The is_retention_lock_enabled of this BackupDestinationConfigurationSummary.

Return type

bool

property is_zero_data_loss_enabled

Gets the is_zero_data_loss_enabled of this BackupDestinationConfigurationSummary. Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to TRUE if no value is given. Not applicable for Autonomous Container Databases on Cloud Autonomous VM Cluster.

Returns

The is_zero_data_loss_enabled of this BackupDestinationConfigurationSummary.

Return type

bool

property recovery_window_in_days

Gets the recovery_window_in_days of this BackupDestinationConfigurationSummary. Number of days between the current and earliest point of recoverability covered by automatic backups and manual backups, but not long term backups.

Returns

The recovery_window_in_days of this BackupDestinationConfigurationSummary.

Return type

int

property remote_region

Gets the remote_region of this BackupDestinationConfigurationSummary. The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.

Returns

The remote_region of this BackupDestinationConfigurationSummary.

Return type

str

property space_utilized_in_gbs

Gets the space_utilized_in_gbs of this BackupDestinationConfigurationSummary. The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer.

Returns

The space_utilized_in_gbs of this BackupDestinationConfigurationSummary.

Return type

int

property tde_wallet_backup_destination

Gets the tde_wallet_backup_destination of this BackupDestinationConfigurationSummary.

Returns

The tde_wallet_backup_destination of this BackupDestinationConfigurationSummary.

Return type

oci.database.models.TdeWalletBackupDestination

property time_at_which_storage_details_are_updated

Gets the time_at_which_storage_details_are_updated of this BackupDestinationConfigurationSummary. The latest timestamp when the backup destination details, such as ‘spaceUtilized,’ are updated.

Returns

The time_at_which_storage_details_are_updated of this BackupDestinationConfigurationSummary.

Return type

datetime

property type

[Required] Gets the type of this BackupDestinationConfigurationSummary. Type of the database backup destination.

Allowed values for this property are: “NFS”, “RECOVERY_APPLIANCE”, “OBJECT_STORE”, “LOCAL”, “DBRS”, “AWS_S3”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this BackupDestinationConfigurationSummary.

Return type

str

property vpc_password

Gets the vpc_password of this BackupDestinationConfigurationSummary. For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. Not applicable for Autonomous Container Databases on Cloud Autonomous VM Cluster.

Returns

The vpc_password of this BackupDestinationConfigurationSummary.

Return type

str

property vpc_user

Gets the vpc_user of this BackupDestinationConfigurationSummary. For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. Not applicable for Autonomous Container Databases on Cloud Autonomous VM Cluster.

Returns

The vpc_user of this BackupDestinationConfigurationSummary.

Return type

str