BootVolumeReplica¶

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

Bases: object

An asynchronous replica 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 Cross-Region Volume Replication 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_ACTIVATING`	A constant which can be used with the lifecycle_state property of a BootVolumeReplica.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a BootVolumeReplica.
`LIFECYCLE_STATE_FAULTY`	A constant which can be used with the lifecycle_state property of a BootVolumeReplica.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a BootVolumeReplica.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a BootVolumeReplica.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a BootVolumeReplica.
`availability_domain`	[Required] Gets the availability_domain of this BootVolumeReplica.
`boot_volume_id`	[Required] Gets the boot_volume_id of this BootVolumeReplica.
`compartment_id`	[Required] Gets the compartment_id of this BootVolumeReplica.
`defined_tags`	Gets the defined_tags of this BootVolumeReplica.
`display_name`	[Required] Gets the display_name of this BootVolumeReplica.
`freeform_tags`	Gets the freeform_tags of this BootVolumeReplica.
`id`	[Required] Gets the id of this BootVolumeReplica.
`image_id`	Gets the image_id of this BootVolumeReplica.
`kms_key_id`	Gets the kms_key_id of this BootVolumeReplica.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BootVolumeReplica.
`size_in_gbs`	[Required] Gets the size_in_gbs of this BootVolumeReplica.
`time_created`	[Required] Gets the time_created of this BootVolumeReplica.
`time_last_synced`	[Required] Gets the time_last_synced of this BootVolumeReplica.
`total_data_transferred_in_gbs`	Gets the total_data_transferred_in_gbs of this BootVolumeReplica.
`volume_group_replica_id`	Gets the volume_group_replica_id of this BootVolumeReplica.

Methods

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

LIFECYCLE_STATE_ACTIVATING = 'ACTIVATING'¶: A constant which can be used with the lifecycle_state property of a BootVolumeReplica. This constant has a value of “ACTIVATING”

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

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a BootVolumeReplica. This constant has a value of “PROVISIONING”

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

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

__init__(**kwargs)¶

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

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this BootVolumeReplica.
compartment_id (str) – The value to assign to the compartment_id property of this BootVolumeReplica.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BootVolumeReplica.
display_name (str) – The value to assign to the display_name property of this BootVolumeReplica.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BootVolumeReplica.
id (str) – The value to assign to the id property of this BootVolumeReplica.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BootVolumeReplica. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “ACTIVATING”, “TERMINATING”, “TERMINATED”, “FAULTY”, ‘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 BootVolumeReplica.
time_created (datetime) – The value to assign to the time_created property of this BootVolumeReplica.
time_last_synced (datetime) – The value to assign to the time_last_synced property of this BootVolumeReplica.
boot_volume_id (str) – The value to assign to the boot_volume_id property of this BootVolumeReplica.
image_id (str) – The value to assign to the image_id property of this BootVolumeReplica.
total_data_transferred_in_gbs (int) – The value to assign to the total_data_transferred_in_gbs property of this BootVolumeReplica.
volume_group_replica_id (str) – The value to assign to the volume_group_replica_id property of this BootVolumeReplica.
kms_key_id (str) – The value to assign to the kms_key_id property of this BootVolumeReplica.

availability_domain¶

[Required] Gets the availability_domain of this BootVolumeReplica. The availability domain of the boot volume replica.

Example: Uocm:PHX-AD-1

Returns:	The availability_domain of this BootVolumeReplica.
Return type:	str

boot_volume_id¶

[Required] Gets the boot_volume_id of this BootVolumeReplica. The OCID of the source boot volume.

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

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this BootVolumeReplica. The boot volume replica’s Oracle ID (OCID).

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

image_id¶

Gets the image_id of this BootVolumeReplica. The image OCID used to create the boot volume the replica is replicated from.

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

kms_key_id¶

Gets the kms_key_id of this BootVolumeReplica. The OCID of the Vault service key to assign as the master encryption key for the boot volume replica, see Overview of Vault service and Using Keys.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this BootVolumeReplica. The current state of a boot volume replica.

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

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

size_in_gbs¶

[Required] Gets the size_in_gbs of this BootVolumeReplica. The size of the source boot volume, in GBs.

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

time_created¶

[Required] Gets the time_created of this BootVolumeReplica. The date and time the boot volume replica was created. Format defined by RFC3339.

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

time_last_synced¶

[Required] Gets the time_last_synced of this BootVolumeReplica. The date and time the boot volume replica was last synced from the source boot volume. Format defined by RFC3339.

Returns:	The time_last_synced of this BootVolumeReplica.
Return type:	datetime

total_data_transferred_in_gbs¶

Gets the total_data_transferred_in_gbs of this BootVolumeReplica. The total size of the data transferred from the source boot volume to the boot volume replica, in GBs.

Returns:	The total_data_transferred_in_gbs of this BootVolumeReplica.
Return type:	int

volume_group_replica_id¶

Gets the volume_group_replica_id of this BootVolumeReplica. The OCID of the volume group replica.

Returns:	The volume_group_replica_id of this BootVolumeReplica.
Return type:	str