VolumeBackupPolicy¶

class oci.core.models.VolumeBackupPolicy(**kwargs)¶

Bases: object

A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Methods

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

Attributes

`compartment_id`	Gets the compartment_id of this VolumeBackupPolicy.
`defined_tags`	Gets the defined_tags of this VolumeBackupPolicy.
`destination_region`	Gets the destination_region of this VolumeBackupPolicy.
`display_name`	[Required] Gets the display_name of this VolumeBackupPolicy.
`freeform_tags`	Gets the freeform_tags of this VolumeBackupPolicy.
`id`	[Required] Gets the id of this VolumeBackupPolicy.
`schedules`	[Required] Gets the schedules of this VolumeBackupPolicy.
`time_created`	[Required] Gets the time_created of this VolumeBackupPolicy.

__init__(**kwargs)¶

Initializes a new VolumeBackupPolicy 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 VolumeBackupPolicy.
id (str) – The value to assign to the id property of this VolumeBackupPolicy.
schedules (list[oci.core.models.VolumeBackupSchedule]) – The value to assign to the schedules property of this VolumeBackupPolicy.
destination_region (str) – The value to assign to the destination_region property of this VolumeBackupPolicy.
time_created (datetime) – The value to assign to the time_created property of this VolumeBackupPolicy.
compartment_id (str) – The value to assign to the compartment_id property of this VolumeBackupPolicy.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VolumeBackupPolicy.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VolumeBackupPolicy.

compartment_id¶

Gets the compartment_id of this VolumeBackupPolicy. The OCID of the compartment that contains the volume backup.

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

defined_tags¶

Gets the defined_tags of this VolumeBackupPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this VolumeBackupPolicy.
Return type:	dict(str, dict(str, object))

destination_region¶

Gets the destination_region of this VolumeBackupPolicy. The paired destination region for copying scheduled backups to. Example us-ashburn-1. See Region Pairs for details about paired regions.

Returns:	The destination_region of this VolumeBackupPolicy.
Return type:	str

display_name¶

[Required] Gets the display_name of this VolumeBackupPolicy. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this VolumeBackupPolicy. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this VolumeBackupPolicy.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this VolumeBackupPolicy. The OCID of the volume backup policy.

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

schedules¶

[Required] Gets the schedules of this VolumeBackupPolicy. The collection of schedules that this policy will apply.

Returns:	The schedules of this VolumeBackupPolicy.
Return type:	list[oci.core.models.VolumeBackupSchedule]

time_created¶

[Required] Gets the time_created of this VolumeBackupPolicy. The date and time the volume backup policy was created. Format defined by RFC3339.

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