boot_volume_attachments

Creates, updates, deletes, gets or lists a boot_volume_attachments resource.

Overview

Name	boot_volume_attachments
Type	Resource
Id	oci.compute.boot_volume_attachments

Fields

The following fields are returned by SELECT queries:

get

The boot volume attachment was retrieved.

Name	Datatype	Description
id	string	The OCID of the boot volume attachment.
availabilityDomain	string	The availability domain of an instance. Example: Uocm:PHX-AD-1
bootVolumeId	string	The OCID of the boot volume.
compartmentId	string	The OCID of the compartment.
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encryptionInTransitType	string	Refer the top-level definition of encryptionInTransitType. The default value is NONE. (NONE, BM_ENCRYPTION_IN_TRANSIT) (default: NONE, x-obmcs-top-level-enum: #/definitions/EncryptionInTransitType)
instanceId	string	The OCID of the instance the boot volume is attached to.
isPvEncryptionInTransitEnabled	boolean	Whether in-transit encryption for the boot volume's paravirtualized attachment is enabled or not.
lifecycleState	string	The current state of the boot volume attachment. (ATTACHING, ATTACHED, DETACHING, DETACHED)
timeCreated	string (date-time)	The date and time the boot volume was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeUpdated	string (date-time)	The date and time the boot volume attachment was updated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

list

Represents an attachment between a boot volume and an instance.<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you<br />supply string values using the API.<br />

Name	Datatype	Description
id	string	The OCID of the boot volume attachment.
availabilityDomain	string	The availability domain of an instance. Example: Uocm:PHX-AD-1
bootVolumeId	string	The OCID of the boot volume.
compartmentId	string	The OCID of the compartment.
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encryptionInTransitType	string	Refer the top-level definition of encryptionInTransitType. The default value is NONE. (NONE, BM_ENCRYPTION_IN_TRANSIT) (default: NONE, x-obmcs-top-level-enum: #/definitions/EncryptionInTransitType)
instanceId	string	The OCID of the instance the boot volume is attached to.
isPvEncryptionInTransitEnabled	boolean	Whether in-transit encryption for the boot volume's paravirtualized attachment is enabled or not.
lifecycleState	string	The current state of the boot volume attachment. (ATTACHING, ATTACHED, DETACHING, DETACHED)
timeCreated	string (date-time)	The date and time the boot volume was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeUpdated	string (date-time)	The date and time the boot volume attachment was updated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bootVolumeAttachmentId, region		Gets information about the specified boot volume attachment.
list	select	availabilityDomain, compartmentId, region	limit, page, instanceId, bootVolumeId	Lists the boot volume attachments in the specified compartment. You can filter the<br />list by specifying an instance OCID, boot volume OCID, or both.<br />
attach	insert	region, instanceId, bootVolumeId	opc-retry-token	Attaches the specified boot volume to the specified instance.<br />
detach	delete	bootVolumeAttachmentId, region	if-match	Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.<br /><br />This is an asynchronous operation. The attachment's lifecycleState will change to DETACHING temporarily<br />until the attachment is completely removed.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
availabilityDomain	string	The name of the availability domain. Example: Uocm:PHX-AD-1
bootVolumeAttachmentId	string	The OCID of the boot volume attachment.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
bootVolumeId	string	The OCID of the boot volume.
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
instanceId	string	The OCID of the instance.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

SELECT examples

get

Gets information about the specified boot volume attachment.

SELECT
id,
availabilityDomain,
bootVolumeId,
compartmentId,
displayName,
encryptionInTransitType,
instanceId,
isPvEncryptionInTransitEnabled,
lifecycleState,
timeCreated,
timeUpdated
FROM oci.compute.boot_volume_attachments
WHERE bootVolumeAttachmentId = '{{ bootVolumeAttachmentId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the boot volume attachments in the specified compartment. You can filter the<br />list by specifying an instance OCID, boot volume OCID, or both.<br />

SELECT
id,
availabilityDomain,
bootVolumeId,
compartmentId,
displayName,
encryptionInTransitType,
instanceId,
isPvEncryptionInTransitEnabled,
lifecycleState,
timeCreated,
timeUpdated
FROM oci.compute.boot_volume_attachments
WHERE availabilityDomain = '{{ availabilityDomain }}' -- required
AND compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND instanceId = '{{ instanceId }}'
AND bootVolumeId = '{{ bootVolumeId }}'
;

INSERT examples

attach

Attaches the specified boot volume to the specified instance.<br />

INSERT INTO oci.compute.boot_volume_attachments (
bootVolumeId,
displayName,
encryptionInTransitType,
instanceId,
region,
opc-retry-token
)
SELECT 
'{{ bootVolumeId }}' /* required */,
'{{ displayName }}',
'{{ encryptionInTransitType }}',
'{{ instanceId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
availabilityDomain,
bootVolumeId,
compartmentId,
displayName,
encryptionInTransitType,
instanceId,
isPvEncryptionInTransitEnabled,
lifecycleState,
timeCreated,
timeUpdated
;

Manifest

# Description fields are for documentation purposes
- name: boot_volume_attachments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the boot_volume_attachments resource.
  - name: bootVolumeId
    value: "{{ bootVolumeId }}"
    description: |
      The OCID of the  boot volume.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: encryptionInTransitType
    value: "{{ encryptionInTransitType }}"
    description: |
      Refer the top-level definition of encryptionInTransitType.
      The default value is NONE.
    valid_values: ['NONE', 'BM_ENCRYPTION_IN_TRANSIT']
    default: NONE
  - name: instanceId
    value: "{{ instanceId }}"
    description: |
      The OCID of the instance.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

DELETE examples

detach

Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.<br /><br />This is an asynchronous operation. The attachment's lifecycleState will change to DETACHING temporarily<br />until the attachment is completely removed.<br />

DELETE FROM oci.compute.boot_volume_attachments
WHERE bootVolumeAttachmentId = '{{ bootVolumeAttachmentId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;