Network.AWS.EC2.AttachVolume

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

Encrypted 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 EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for 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 be attached only to a stopped instance.
• AWS 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 an overview of the AWS Marketplace, see Introducing AWS Marketplace.

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

Creating a Request

attachVolume

Arguments

:: Text

avVolumeId

-> Text

avInstanceId

-> Text

avDevice

-> AttachVolume

Creates a value of AttachVolume with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• avDryRun
• avVolumeId
• avInstanceId
• avDevice

data AttachVolume

Contains the parameters for AttachVolume.

See: attachVolume smart constructor.

Instances

Eq AttachVolume

Methods

(==) :: AttachVolume -> AttachVolume -> Bool

(/=) :: AttachVolume -> AttachVolume -> Bool

Data AttachVolume

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttachVolume -> c AttachVolume

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttachVolume

toConstr :: AttachVolume -> Constr

dataTypeOf :: AttachVolume -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttachVolume)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttachVolume)

gmapT :: (forall b. Data b => b -> b) -> AttachVolume -> AttachVolume

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttachVolume -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttachVolume -> r

gmapQ :: (forall d. Data d => d -> u) -> AttachVolume -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttachVolume -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttachVolume -> m AttachVolume

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttachVolume -> m AttachVolume

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttachVolume -> m AttachVolume

Read AttachVolume

Methods

readsPrec :: Int -> ReadS AttachVolume

readList :: ReadS [AttachVolume]

readPrec :: ReadPrec AttachVolume

readListPrec :: ReadPrec [AttachVolume]

Show AttachVolume

Methods

showsPrec :: Int -> AttachVolume -> ShowS

show :: AttachVolume -> String

showList :: [AttachVolume] -> ShowS

Generic AttachVolume

Associated Types

type Rep AttachVolume :: * -> *

Methods

from :: AttachVolume -> Rep AttachVolume x

to :: Rep AttachVolume x -> AttachVolume

Hashable AttachVolume

Methods

hashWithSalt :: Int -> AttachVolume -> Int

hash :: AttachVolume -> Int

NFData AttachVolume

Methods

rnf :: AttachVolume -> ()

AWSRequest AttachVolume

Associated Types

type Rs AttachVolume :: *

Methods

request :: AttachVolume -> Request AttachVolume

response :: MonadResource m => Logger -> Service -> Proxy * AttachVolume -> ClientResponse -> m (Response AttachVolume)

ToQuery AttachVolume

Methods

toQuery :: AttachVolume -> QueryString

ToPath AttachVolume

Methods

toPath :: AttachVolume -> ByteString

ToHeaders AttachVolume

Methods

toHeaders :: AttachVolume -> [Header]

type Rep AttachVolume

type Rep AttachVolume = D1 (MetaData "AttachVolume" "Network.AWS.EC2.AttachVolume" "amazonka-ec2-1.4.1-5DlWz6no0BoLQhxZVyzMyd" False) (C1 (MetaCons "AttachVolume'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_avDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_avVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_avInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_avDevice") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs AttachVolume

type Rs AttachVolume = VolumeAttachment

Request Lenses

avDryRun :: Lens' AttachVolume (Maybe Bool)

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.

avVolumeId :: Lens' AttachVolume Text

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

avInstanceId :: Lens' AttachVolume Text

The ID of the instance.

avDevice :: Lens' AttachVolume Text

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

Destructuring the Response

volumeAttachment :: VolumeAttachment

Creates a value of VolumeAttachment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• volInstanceId
• volDeleteOnTermination
• volState
• volDevice
• volVolumeId
• volAttachTime

data VolumeAttachment

Describes volume attachment details.

See: volumeAttachment smart constructor.

Instances

Eq VolumeAttachment

Methods

(==) :: VolumeAttachment -> VolumeAttachment -> Bool

(/=) :: VolumeAttachment -> VolumeAttachment -> Bool

Data VolumeAttachment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VolumeAttachment -> c VolumeAttachment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VolumeAttachment

toConstr :: VolumeAttachment -> Constr

dataTypeOf :: VolumeAttachment -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c VolumeAttachment)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VolumeAttachment)

gmapT :: (forall b. Data b => b -> b) -> VolumeAttachment -> VolumeAttachment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VolumeAttachment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VolumeAttachment -> r

gmapQ :: (forall d. Data d => d -> u) -> VolumeAttachment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> VolumeAttachment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VolumeAttachment -> m VolumeAttachment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VolumeAttachment -> m VolumeAttachment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VolumeAttachment -> m VolumeAttachment

Read VolumeAttachment

Methods

readsPrec :: Int -> ReadS VolumeAttachment

readList :: ReadS [VolumeAttachment]

readPrec :: ReadPrec VolumeAttachment

readListPrec :: ReadPrec [VolumeAttachment]

Show VolumeAttachment

Methods

showsPrec :: Int -> VolumeAttachment -> ShowS

show :: VolumeAttachment -> String

showList :: [VolumeAttachment] -> ShowS

Generic VolumeAttachment

Associated Types

type Rep VolumeAttachment :: * -> *

Methods

from :: VolumeAttachment -> Rep VolumeAttachment x

to :: Rep VolumeAttachment x -> VolumeAttachment

Hashable VolumeAttachment

Methods

hashWithSalt :: Int -> VolumeAttachment -> Int

hash :: VolumeAttachment -> Int

NFData VolumeAttachment

Methods

rnf :: VolumeAttachment -> ()

FromXML VolumeAttachment

Methods

parseXML :: [Node] -> Either String VolumeAttachment

type Rep VolumeAttachment

type Rep VolumeAttachment = D1 (MetaData "VolumeAttachment" "Network.AWS.EC2.Types.Product" "amazonka-ec2-1.4.1-5DlWz6no0BoLQhxZVyzMyd" False) (C1 (MetaCons "VolumeAttachment'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_volInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_volDeleteOnTermination") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_volState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumeAttachmentState))))) ((:*:) (S1 (MetaSel (Just Symbol "_volDevice") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_volVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_volAttachTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)))))))

Response Lenses

volInstanceId :: Lens' VolumeAttachment (Maybe Text)

The ID of the instance.

volDeleteOnTermination :: Lens' VolumeAttachment (Maybe Bool)

Indicates whether the EBS volume is deleted on instance termination.

volState :: Lens' VolumeAttachment (Maybe VolumeAttachmentState)

The attachment state of the volume.

volDevice :: Lens' VolumeAttachment (Maybe Text)

The device name.

volVolumeId :: Lens' VolumeAttachment (Maybe Text)

The ID of the volume.

volAttachTime :: Lens' VolumeAttachment (Maybe UTCTime)

The time stamp when the attachment initiated.