BootVolumeAttachment¶

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

Bases: object

Represents an attachment between a boot volume and an instance.

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

Attributes

`ENCRYPTION_IN_TRANSIT_TYPE_BM_ENCRYPTION_IN_TRANSIT`	A constant which can be used with the encryption_in_transit_type property of a BootVolumeAttachment.
`ENCRYPTION_IN_TRANSIT_TYPE_NONE`	A constant which can be used with the encryption_in_transit_type property of a BootVolumeAttachment.
`LIFECYCLE_STATE_ATTACHED`	A constant which can be used with the lifecycle_state property of a BootVolumeAttachment.
`LIFECYCLE_STATE_ATTACHING`	A constant which can be used with the lifecycle_state property of a BootVolumeAttachment.
`LIFECYCLE_STATE_DETACHED`	A constant which can be used with the lifecycle_state property of a BootVolumeAttachment.
`LIFECYCLE_STATE_DETACHING`	A constant which can be used with the lifecycle_state property of a BootVolumeAttachment.
`availability_domain`	[Required] Gets the availability_domain of this BootVolumeAttachment.
`boot_volume_id`	[Required] Gets the boot_volume_id of this BootVolumeAttachment.
`compartment_id`	[Required] Gets the compartment_id of this BootVolumeAttachment.
`display_name`	Gets the display_name of this BootVolumeAttachment.
`encryption_in_transit_type`	Gets the encryption_in_transit_type of this BootVolumeAttachment.
`id`	[Required] Gets the id of this BootVolumeAttachment.
`instance_id`	[Required] Gets the instance_id of this BootVolumeAttachment.
`is_pv_encryption_in_transit_enabled`	Gets the is_pv_encryption_in_transit_enabled of this BootVolumeAttachment.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BootVolumeAttachment.
`time_created`	[Required] Gets the time_created of this BootVolumeAttachment.

Methods

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

ENCRYPTION_IN_TRANSIT_TYPE_BM_ENCRYPTION_IN_TRANSIT = 'BM_ENCRYPTION_IN_TRANSIT'¶: A constant which can be used with the encryption_in_transit_type property of a BootVolumeAttachment. This constant has a value of “BM_ENCRYPTION_IN_TRANSIT”

ENCRYPTION_IN_TRANSIT_TYPE_NONE = 'NONE'¶: A constant which can be used with the encryption_in_transit_type property of a BootVolumeAttachment. This constant has a value of “NONE”

LIFECYCLE_STATE_ATTACHED = 'ATTACHED'¶: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. This constant has a value of “ATTACHED”

LIFECYCLE_STATE_ATTACHING = 'ATTACHING'¶: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. This constant has a value of “ATTACHING”

LIFECYCLE_STATE_DETACHED = 'DETACHED'¶: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. This constant has a value of “DETACHED”

LIFECYCLE_STATE_DETACHING = 'DETACHING'¶: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment. This constant has a value of “DETACHING”

__init__(**kwargs)¶

Initializes a new BootVolumeAttachment 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 BootVolumeAttachment.
boot_volume_id (str) – The value to assign to the boot_volume_id property of this BootVolumeAttachment.
compartment_id (str) – The value to assign to the compartment_id property of this BootVolumeAttachment.
display_name (str) – The value to assign to the display_name property of this BootVolumeAttachment.
id (str) – The value to assign to the id property of this BootVolumeAttachment.
instance_id (str) – The value to assign to the instance_id property of this BootVolumeAttachment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BootVolumeAttachment. Allowed values for this property are: “ATTACHING”, “ATTACHED”, “DETACHING”, “DETACHED”, ‘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 BootVolumeAttachment.
is_pv_encryption_in_transit_enabled (bool) – The value to assign to the is_pv_encryption_in_transit_enabled property of this BootVolumeAttachment.
encryption_in_transit_type (str) – The value to assign to the encryption_in_transit_type property of this BootVolumeAttachment. Allowed values for this property are: “NONE”, “BM_ENCRYPTION_IN_TRANSIT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

availability_domain¶

[Required] Gets the availability_domain of this BootVolumeAttachment. The availability domain of an instance.

Example: Uocm:PHX-AD-1

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

boot_volume_id¶

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

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

compartment_id¶

[Required] Gets the compartment_id of this BootVolumeAttachment. The OCID of the compartment.

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

display_name¶

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

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

encryption_in_transit_type¶

Gets the encryption_in_transit_type of this BootVolumeAttachment. Refer the top-level definition of encryptionInTransitType. The default value is NONE.

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

Returns:	The encryption_in_transit_type of this BootVolumeAttachment.
Return type:	str

id¶

[Required] Gets the id of this BootVolumeAttachment. The OCID of the boot volume attachment.

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

instance_id¶

[Required] Gets the instance_id of this BootVolumeAttachment. The OCID of the instance the boot volume is attached to.

Returns:	The instance_id of this BootVolumeAttachment.
Return type:	str

is_pv_encryption_in_transit_enabled¶

Gets the is_pv_encryption_in_transit_enabled of this BootVolumeAttachment. Whether in-transit encryption for the boot volume’s paravirtualized attachment is enabled or not.

Returns:	The is_pv_encryption_in_transit_enabled of this BootVolumeAttachment.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this BootVolumeAttachment. The current state of the boot volume attachment.

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

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

time_created¶

[Required] Gets the time_created of this BootVolumeAttachment. The date and time the boot volume was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

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