CreateBootVolumeBackupDetails

class oci.core.models.CreateBootVolumeBackupDetails(**kwargs)

Bases: object

CreateBootVolumeBackupDetails model.

Attributes:

TYPE_FULL

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

TYPE_INCREMENTAL

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

boot_volume_id

[Required] Gets the boot_volume_id of this CreateBootVolumeBackupDetails.

defined_tags

Gets the defined_tags of this CreateBootVolumeBackupDetails.

display_name

Gets the display_name of this CreateBootVolumeBackupDetails.

freeform_tags

Gets the freeform_tags of this CreateBootVolumeBackupDetails.

is_indefinite_retention_enabled

Gets the is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails.

is_prevent_deletion_enabled

Gets the is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails.

is_retention_lock_enabled

Gets the is_retention_lock_enabled of this CreateBootVolumeBackupDetails.

kms_key_id

Gets the kms_key_id of this CreateBootVolumeBackupDetails.

retention_period

Gets the retention_period of this CreateBootVolumeBackupDetails.

type

Gets the type of this CreateBootVolumeBackupDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateBootVolumeBackupDetails object with values from keyword arguments.

TYPE_FULL = 'FULL'

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

TYPE_INCREMENTAL = 'INCREMENTAL'

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

__init__(**kwargs)

Initializes a new CreateBootVolumeBackupDetails 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 CreateBootVolumeBackupDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateBootVolumeBackupDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateBootVolumeBackupDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateBootVolumeBackupDetails.

  • type (str) – The value to assign to the type property of this CreateBootVolumeBackupDetails. Allowed values for this property are: “FULL”, “INCREMENTAL”

  • kms_key_id (str) – The value to assign to the kms_key_id property of this CreateBootVolumeBackupDetails.

  • retention_period (oci.core.models.RetentionDuration) – The value to assign to the retention_period property of this CreateBootVolumeBackupDetails.

  • is_prevent_deletion_enabled (bool) – The value to assign to the is_prevent_deletion_enabled property of this CreateBootVolumeBackupDetails.

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

  • is_indefinite_retention_enabled (bool) – The value to assign to the is_indefinite_retention_enabled property of this CreateBootVolumeBackupDetails.

property boot_volume_id

[Required] Gets the boot_volume_id of this CreateBootVolumeBackupDetails. The OCID of the boot volume that needs to be backed up.

Returns

The boot_volume_id of this CreateBootVolumeBackupDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateBootVolumeBackupDetails. 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 CreateBootVolumeBackupDetails.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this CreateBootVolumeBackupDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateBootVolumeBackupDetails. 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 CreateBootVolumeBackupDetails.

Return type

dict(str, str)

property is_indefinite_retention_enabled

Gets the is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails. feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.

Returns

The is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails.

Return type

bool

property is_prevent_deletion_enabled

Gets the is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails. Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.

Returns

The is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails.

Return type

bool

property is_retention_lock_enabled

Gets the is_retention_lock_enabled of this CreateBootVolumeBackupDetails. feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.

Returns

The is_retention_lock_enabled of this CreateBootVolumeBackupDetails.

Return type

bool

property kms_key_id

Gets the kms_key_id of this CreateBootVolumeBackupDetails. The OCID of the Vault service key which is the master encryption key for the 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 CreateBootVolumeBackupDetails.

Return type

str

property retention_period

Gets the retention_period of this CreateBootVolumeBackupDetails.

Returns

The retention_period of this CreateBootVolumeBackupDetails.

Return type

oci.core.models.RetentionDuration

property type

Gets the type of this CreateBootVolumeBackupDetails. The type of backup to create. If omitted, defaults to incremental.

Allowed values for this property are: “FULL”, “INCREMENTAL”

Returns

The type of this CreateBootVolumeBackupDetails.

Return type

str