BlockVolumeReplica¶

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

Bases: object

An asynchronous replica of a block volume that can then be used to create a new block volume or recover a block 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 BlockVolumeReplica.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a BlockVolumeReplica.
`LIFECYCLE_STATE_FAULTY`	A constant which can be used with the lifecycle_state property of a BlockVolumeReplica.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a BlockVolumeReplica.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a BlockVolumeReplica.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a BlockVolumeReplica.
`availability_domain`	[Required] Gets the availability_domain of this BlockVolumeReplica.
`block_volume_id`	[Required] Gets the block_volume_id of this BlockVolumeReplica.
`compartment_id`	[Required] Gets the compartment_id of this BlockVolumeReplica.
`defined_tags`	Gets the defined_tags of this BlockVolumeReplica.
`display_name`	[Required] Gets the display_name of this BlockVolumeReplica.
`freeform_tags`	Gets the freeform_tags of this BlockVolumeReplica.
`id`	[Required] Gets the id of this BlockVolumeReplica.
`kms_key_id`	Gets the kms_key_id of this BlockVolumeReplica.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BlockVolumeReplica.
`size_in_gbs`	[Required] Gets the size_in_gbs of this BlockVolumeReplica.
`time_created`	[Required] Gets the time_created of this BlockVolumeReplica.
`time_last_synced`	[Required] Gets the time_last_synced of this BlockVolumeReplica.
`total_data_transferred_in_gbs`	Gets the total_data_transferred_in_gbs of this BlockVolumeReplica.
`volume_group_replica_id`	Gets the volume_group_replica_id of this BlockVolumeReplica.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new BlockVolumeReplica 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 BlockVolumeReplica.
compartment_id (str) – The value to assign to the compartment_id property of this BlockVolumeReplica.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BlockVolumeReplica.
display_name (str) – The value to assign to the display_name property of this BlockVolumeReplica.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BlockVolumeReplica.
id (str) – The value to assign to the id property of this BlockVolumeReplica.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BlockVolumeReplica. 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 BlockVolumeReplica.
time_created (datetime) – The value to assign to the time_created property of this BlockVolumeReplica.
time_last_synced (datetime) – The value to assign to the time_last_synced property of this BlockVolumeReplica.
block_volume_id (str) – The value to assign to the block_volume_id property of this BlockVolumeReplica.
total_data_transferred_in_gbs (int) – The value to assign to the total_data_transferred_in_gbs property of this BlockVolumeReplica.
volume_group_replica_id (str) – The value to assign to the volume_group_replica_id property of this BlockVolumeReplica.
kms_key_id (str) – The value to assign to the kms_key_id property of this BlockVolumeReplica.

availability_domain¶

[Required] Gets the availability_domain of this BlockVolumeReplica. The availability domain of the block volume replica.

Example: Uocm:PHX-AD-1

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

block_volume_id¶

[Required] Gets the block_volume_id of this BlockVolumeReplica. The OCID of the source block volume.

Returns:	The block_volume_id of this BlockVolumeReplica.
Return type:	str

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

kms_key_id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this BlockVolumeReplica. The current state of a block 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 BlockVolumeReplica.
Return type:	str

size_in_gbs¶

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

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

time_created¶

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

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

time_last_synced¶

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

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

total_data_transferred_in_gbs¶

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

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

volume_group_replica_id¶

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

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