AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the AttachVolume operation. Attaches an Amazon EBS volume to a running or stopped instance, and exposes it to the instance with the specified device name.

The maximum number of Amazon EBS volumes that you can attach to an instance depends on the instance type. If you exceed the volume attachment limit for an instance type, the attachment request fails with the AttachmentLimitExceeded error. For more information, see Instance volume limits.

After you attach an EBS volume, you must make it available for use. For more information, see Make an EBS volume available for use.

If a volume has an Amazon Web Services Marketplace product code:

For more information, see Attach an Amazon EBS volume to an instance in the Amazon EBS User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.AttachVolumeRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class AttachVolumeRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The AttachVolumeRequest type exposes the following members

Constructors

NameDescription
Public Method AttachVolumeRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method AttachVolumeRequest(string, string, string)

Instantiates AttachVolumeRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Device System.String

Gets and sets the property Device.

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

Public Property DryRun System.Nullable<System.Boolean>

Gets and sets the property DryRun.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the instance.

Public Property VolumeId System.String

Gets and sets the property VolumeId.

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Examples

This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.

To attach a volume to an instance


var client = new AmazonEC2Client();
var response = client.AttachVolume(new AttachVolumeRequest 
{
    Device = "/dev/sdf",
    InstanceId = "i-01474ef662b89480",
    VolumeId = "vol-1234567890abcdef0"
});

DateTime attachTime = response.AttachTime;
string device = response.Device;
string instanceId = response.InstanceId;
string state = response.State;
string volumeId = response.VolumeId;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer