com.amazonaws.services.ec2.model

Class AttachVolumeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.AttachVolumeRequest

All Implemented Interfaces:

DryRunSupportedRequest<AttachVolumeRequest>, Serializable

public class AttachVolumeRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<AttachVolumeRequest>

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.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance . Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide .

If a volume has an AWS Marketplace product code:

• The volume can only be attached as the root device of a stopped instance.
• You must be subscribed to the AWS Marketplace code that is on the volume.
• The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.
• AWS Marketplace product codes are copied from the volume to the instance.

For an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000 . For more information about how to use the AWS Marketplace, see AWS Marketplace .

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.attachVolume(AttachVolumeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AttachVolumeRequest() Default constructor for a new AttachVolumeRequest object.
AttachVolumeRequest(String volumeId, String instanceId, String device) Constructs a new AttachVolumeRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDevice() The device name to expose to the instance (for example, /dev/sdh or xvdh).
Request<AttachVolumeRequest>	getDryRunRequest() This method is intended for internal use only.
String	getInstanceId() The ID of the instance.
String	getVolumeId() The ID of the Amazon EBS volume.
int	hashCode()
void	setDevice(String device) The device name to expose to the instance (for example, /dev/sdh or xvdh).
void	setInstanceId(String instanceId) The ID of the instance.
void	setVolumeId(String volumeId) The ID of the Amazon EBS volume.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AttachVolumeRequest	withDevice(String device) The device name to expose to the instance (for example, /dev/sdh or xvdh).
AttachVolumeRequest	withInstanceId(String instanceId) The ID of the instance.
AttachVolumeRequest	withVolumeId(String volumeId) The ID of the Amazon EBS volume.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachVolumeRequest

public AttachVolumeRequest()

Default constructor for a new AttachVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

AttachVolumeRequest

public AttachVolumeRequest(String volumeId,
                   String instanceId,
                   String device)

Constructs a new AttachVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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

instanceId - The ID of the instance.

device - The device name to expose to the instance (for example, /dev/sdh or xvdh).

Method Detail

getVolumeId

public String getVolumeId()

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

Returns:

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

setVolumeId

public void setVolumeId(String volumeId)

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

Parameters:

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

withVolumeId

public AttachVolumeRequest withVolumeId(String volumeId)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceId

public String getInstanceId()

The ID of the instance.

Returns:

The ID of the instance.

setInstanceId

public void setInstanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

withInstanceId

public AttachVolumeRequest withInstanceId(String instanceId)

The ID of the instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceId - The ID of the instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getDevice

public String getDevice()

The device name to expose to the instance (for example, /dev/sdh or xvdh).

Returns:

The device name to expose to the instance (for example, /dev/sdh or xvdh).

setDevice

public void setDevice(String device)

The device name to expose to the instance (for example, /dev/sdh or xvdh).

Parameters:

device - The device name to expose to the instance (for example, /dev/sdh or xvdh).

withDevice

public AttachVolumeRequest withDevice(String device)

The device name to expose to the instance (for example, /dev/sdh or xvdh).

Returns a reference to this object so that method calls can be chained together.

Parameters:

device - The device name to expose to the instance (for example, /dev/sdh or xvdh).

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<AttachVolumeRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<AttachVolumeRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object