AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::VolumeAttachment

CfnVolumeAttachment

Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name. 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. 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. If the root volume is detached from an instance with an AWS Marketplace product code, then the product codes from that volume are no longer associated with the instance.

Import

import { CfnVolumeAttachment } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnVolumeAttachment

Properties

Configuration passed to the constructor as CfnVolumeAttachmentProps.

instanceIdRequired
string | IInstanceRef

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.

volumeIdRequired
string | IVolumeRef

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.

deviceOptional
string

The device name (for example, `/dev/sdh` or `xvdh` ).

ebsCardIndexOptional
number

The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::EC2::VolumeAttachmentView in CloudFormation Explorer

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-ec2
CFN TypeAWS::EC2::VolumeAttachment
Properties4

Related Constructs

Explore This Service

External Links