volume_attachments

Used to retrieve a list of volume_attachments in a region or to create or delete a volume_attachments resource, use volume_attachment to read or update an individual resource.

Overview

Name	volume_attachments
Type	Resource
Description	Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.<br/> Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.<br/> If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.<br/> If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
Id	aws.ec2.volume_attachments

Fields

Name	Datatype	Description
volume_id	undefined	The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_id	undefined	The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	VolumeId, InstanceId, region
delete_resource	DELETE	data__Identifier, region
list_resource	SELECT	region

SELECT Example

SELECT
region,
volume_id,
instance_id
FROM aws.ec2.volume_attachments
WHERE region = 'us-east-1';

INSERT Example

Use the following StackQL query and manifest file to create a new volume_attachment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ec2.volume_attachments (
 VolumeId,
 InstanceId,
 region
)
SELECT 
'{{ VolumeId }}',
 '{{ InstanceId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.volume_attachments (
 VolumeId,
 InstanceId,
 Device,
 region
)
SELECT 
 '{{ VolumeId }}',
 '{{ InstanceId }}',
 '{{ Device }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: volume_attachment
    props:
      - name: VolumeId
        value: '{{ VolumeId }}'
      - name: InstanceId
        value: '{{ InstanceId }}'
      - name: Device
        value: '{{ Device }}'

DELETE Example

/*+ delete */
DELETE FROM aws.ec2.volume_attachments
WHERE data__Identifier = '<VolumeId|InstanceId>'
AND region = 'us-east-1';

Permissions

To operate on the volume_attachments resource, the following permissions are required:

Create

ec2:AttachVolume,
ec2:DescribeVolumes

Delete

ec2:DetachVolume,
ec2:DescribeVolumes

List

ec2:DescribeVolumes