Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AttachVolumeCommand

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

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

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

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

  • The volume can be attached only to a stopped instance.

  • Amazon Web Services Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

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

example

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, AttachVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, AttachVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const command = new AttachVolumeCommand(input);
const response = await client.send(command);
see

AttachVolumeCommandInput for command's input shape.

see

AttachVolumeCommandOutput for command's response shape.

see

config for EC2Client's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly input

input: AttachVolumeCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<AttachVolumeCommandInput, AttachVolumeCommandOutput>

Methods

Static getEndpointParameterInstructions