CreateVolumeBackupDetails¶

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

Bases: object

CreateVolumeBackupDetails model.

Attributes

`TYPE_FULL`	A constant which can be used with the type property of a CreateVolumeBackupDetails.
`TYPE_INCREMENTAL`	A constant which can be used with the type property of a CreateVolumeBackupDetails.
`defined_tags`	Gets the defined_tags of this CreateVolumeBackupDetails.
`display_name`	Gets the display_name of this CreateVolumeBackupDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVolumeBackupDetails.
`is_indefinite_retention_enabled`	Gets the is_indefinite_retention_enabled of this CreateVolumeBackupDetails.
`is_prevent_deletion_enabled`	Gets the is_prevent_deletion_enabled of this CreateVolumeBackupDetails.
`is_retention_lock_enabled`	Gets the is_retention_lock_enabled of this CreateVolumeBackupDetails.
`kms_key_id`	Gets the kms_key_id of this CreateVolumeBackupDetails.
`retention_period`	Gets the retention_period of this CreateVolumeBackupDetails.
`type`	Gets the type of this CreateVolumeBackupDetails.
`volume_id`	[Required] Gets the volume_id of this CreateVolumeBackupDetails.

Methods

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

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

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

__init__(**kwargs)¶

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

Parameters:

kms_key_id (str) – The value to assign to the kms_key_id property of this CreateVolumeBackupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVolumeBackupDetails.
display_name (str) – The value to assign to the display_name property of this CreateVolumeBackupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVolumeBackupDetails.
type (str) – The value to assign to the type property of this CreateVolumeBackupDetails. Allowed values for this property are: “FULL”, “INCREMENTAL”
volume_id (str) – The value to assign to the volume_id property of this CreateVolumeBackupDetails.
retention_period (oci.core.models.RetentionDuration) – The value to assign to the retention_period property of this CreateVolumeBackupDetails.
is_prevent_deletion_enabled (bool) – The value to assign to the is_prevent_deletion_enabled property of this CreateVolumeBackupDetails.
is_retention_lock_enabled (bool) – The value to assign to the is_retention_lock_enabled property of this CreateVolumeBackupDetails.
is_indefinite_retention_enabled (bool) – The value to assign to the is_indefinite_retention_enabled property of this CreateVolumeBackupDetails.

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

is_indefinite_retention_enabled¶

Gets the is_indefinite_retention_enabled of this CreateVolumeBackupDetails. 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 CreateVolumeBackupDetails.
Return type:	bool

is_prevent_deletion_enabled¶

Gets the is_prevent_deletion_enabled of this CreateVolumeBackupDetails. 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 CreateVolumeBackupDetails.
Return type:	bool

is_retention_lock_enabled¶

Gets the is_retention_lock_enabled of this CreateVolumeBackupDetails. 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 CreateVolumeBackupDetails.
Return type:	bool

kms_key_id¶

Gets the kms_key_id of this CreateVolumeBackupDetails. 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 CreateVolumeBackupDetails.
Return type:	str

retention_period¶

Gets the retention_period of this CreateVolumeBackupDetails.

Returns:	The retention_period of this CreateVolumeBackupDetails.
Return type:	oci.core.models.RetentionDuration

type¶

Gets the type of this CreateVolumeBackupDetails. The type of backup to create. If omitted, defaults to INCREMENTAL.

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

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

volume_id¶

[Required] Gets the volume_id of this CreateVolumeBackupDetails. The OCID of the volume that needs to be backed up.

Returns:	The volume_id of this CreateVolumeBackupDetails.
Return type:	str