BootVolumeBackup¶

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

Bases: object

A point-in-time copy of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see Overview of Boot Volume Backups To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

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

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a BootVolumeBackup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a BootVolumeBackup.
`LIFECYCLE_STATE_FAULTY`	A constant which can be used with the lifecycle_state property of a BootVolumeBackup.
`LIFECYCLE_STATE_REQUEST_RECEIVED`	A constant which can be used with the lifecycle_state property of a BootVolumeBackup.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a BootVolumeBackup.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a BootVolumeBackup.
`SOURCE_TYPE_MANUAL`	A constant which can be used with the source_type property of a BootVolumeBackup.
`SOURCE_TYPE_SCHEDULED`	A constant which can be used with the source_type property of a BootVolumeBackup.
`TYPE_FULL`	A constant which can be used with the type property of a BootVolumeBackup.
`TYPE_INCREMENTAL`	A constant which can be used with the type property of a BootVolumeBackup.
`boot_volume_id`	Gets the boot_volume_id of this BootVolumeBackup.
`compartment_id`	[Required] Gets the compartment_id of this BootVolumeBackup.
`defined_tags`	Gets the defined_tags of this BootVolumeBackup.
`display_name`	[Required] Gets the display_name of this BootVolumeBackup.
`expiration_time`	Gets the expiration_time of this BootVolumeBackup.
`freeform_tags`	Gets the freeform_tags of this BootVolumeBackup.
`id`	[Required] Gets the id of this BootVolumeBackup.
`image_id`	Gets the image_id of this BootVolumeBackup.
`kms_key_id`	Gets the kms_key_id of this BootVolumeBackup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BootVolumeBackup.
`size_in_gbs`	Gets the size_in_gbs of this BootVolumeBackup.
`source_boot_volume_backup_id`	Gets the source_boot_volume_backup_id of this BootVolumeBackup.
`source_type`	Gets the source_type of this BootVolumeBackup.
`system_tags`	Gets the system_tags of this BootVolumeBackup.
`time_created`	[Required] Gets the time_created of this BootVolumeBackup.
`time_request_received`	Gets the time_request_received of this BootVolumeBackup.
`type`	Gets the type of this BootVolumeBackup.
`unique_size_in_gbs`	Gets the unique_size_in_gbs of this BootVolumeBackup.

Methods

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

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a BootVolumeBackup. This constant has a value of “AVAILABLE”

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

LIFECYCLE_STATE_FAULTY = 'FAULTY'¶: A constant which can be used with the lifecycle_state property of a BootVolumeBackup. This constant has a value of “FAULTY”

LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED'¶: A constant which can be used with the lifecycle_state property of a BootVolumeBackup. This constant has a value of “REQUEST_RECEIVED”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a BootVolumeBackup. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a BootVolumeBackup. This constant has a value of “TERMINATING”

SOURCE_TYPE_MANUAL = 'MANUAL'¶: A constant which can be used with the source_type property of a BootVolumeBackup. This constant has a value of “MANUAL”

SOURCE_TYPE_SCHEDULED = 'SCHEDULED'¶: A constant which can be used with the source_type property of a BootVolumeBackup. This constant has a value of “SCHEDULED”

TYPE_FULL = 'FULL'¶: A constant which can be used with the type property of a BootVolumeBackup. This constant has a value of “FULL”

TYPE_INCREMENTAL = 'INCREMENTAL'¶: A constant which can be used with the type property of a BootVolumeBackup. This constant has a value of “INCREMENTAL”

__init__(**kwargs)¶

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

Parameters:

boot_volume_id (str) – The value to assign to the boot_volume_id property of this BootVolumeBackup.
compartment_id (str) – The value to assign to the compartment_id property of this BootVolumeBackup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BootVolumeBackup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BootVolumeBackup.
display_name (str) – The value to assign to the display_name property of this BootVolumeBackup.
expiration_time (datetime) – The value to assign to the expiration_time property of this BootVolumeBackup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BootVolumeBackup.
id (str) – The value to assign to the id property of this BootVolumeBackup.
image_id (str) – The value to assign to the image_id property of this BootVolumeBackup.
kms_key_id (str) – The value to assign to the kms_key_id property of this BootVolumeBackup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BootVolumeBackup. Allowed values for this property are: “CREATING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “REQUEST_RECEIVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
size_in_gbs (int) – The value to assign to the size_in_gbs property of this BootVolumeBackup.
source_boot_volume_backup_id (str) – The value to assign to the source_boot_volume_backup_id property of this BootVolumeBackup.
source_type (str) – The value to assign to the source_type property of this BootVolumeBackup. Allowed values for this property are: “MANUAL”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this BootVolumeBackup.
time_request_received (datetime) – The value to assign to the time_request_received property of this BootVolumeBackup.
type (str) – The value to assign to the type property of this BootVolumeBackup. Allowed values for this property are: “FULL”, “INCREMENTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
unique_size_in_gbs (int) – The value to assign to the unique_size_in_gbs property of this BootVolumeBackup.

boot_volume_id¶

Gets the boot_volume_id of this BootVolumeBackup. The OCID of the boot volume.

Returns:	The boot_volume_id of this BootVolumeBackup.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this BootVolumeBackup. The OCID of the compartment that contains the boot volume backup.

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

defined_tags¶

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

display_name¶

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

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

expiration_time¶

Gets the expiration_time of this BootVolumeBackup. The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.

Returns:	The expiration_time of this BootVolumeBackup.
Return type:	datetime

freeform_tags¶

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

id¶

[Required] Gets the id of this BootVolumeBackup. The OCID of the boot volume backup.

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

image_id¶

Gets the image_id of this BootVolumeBackup. The image OCID used to create the boot volume the backup is taken from.

Returns:	The image_id of this BootVolumeBackup.
Return type:	str

kms_key_id¶

Gets the kms_key_id of this BootVolumeBackup. The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

Returns:	The kms_key_id of this BootVolumeBackup.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this BootVolumeBackup. The current state of a boot volume backup.

Allowed values for this property are: “CREATING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “REQUEST_RECEIVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

size_in_gbs¶

Gets the size_in_gbs of this BootVolumeBackup. The size of the boot volume, in GBs.

Returns:	The size_in_gbs of this BootVolumeBackup.
Return type:	int

source_boot_volume_backup_id¶

Gets the source_boot_volume_backup_id of this BootVolumeBackup. The OCID of the source boot volume backup.

Returns:	The source_boot_volume_backup_id of this BootVolumeBackup.
Return type:	str

source_type¶

Gets the source_type of this BootVolumeBackup. Specifies whether the backup was created manually, or via scheduled backup policy.

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

Returns:	The source_type of this BootVolumeBackup.
Return type:	str

system_tags¶

Gets the system_tags of this BootVolumeBackup. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

time_created¶

[Required] Gets the time_created of this BootVolumeBackup. The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

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

time_request_received¶

Gets the time_request_received of this BootVolumeBackup. The date and time the request to create the boot volume backup was received. Format defined by RFC3339.

Returns:	The time_request_received of this BootVolumeBackup.
Return type:	datetime

type¶

Gets the type of this BootVolumeBackup. The type of a volume backup.

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

Returns:	The type of this BootVolumeBackup.
Return type:	str

unique_size_in_gbs¶

Gets the unique_size_in_gbs of this BootVolumeBackup. The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.

Returns:	The unique_size_in_gbs of this BootVolumeBackup.
Return type:	int