Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.AttachVolume

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data AttachVolume = AttachVolume' {
- dryRun :: Maybe Bool
- device :: Text
- instanceId :: Text
- volumeId :: Text
}
newAttachVolume :: Text -> Text -> Text -> AttachVolume
attachVolume_dryRun :: Lens' AttachVolume (Maybe Bool)
attachVolume_device :: Lens' AttachVolume Text
attachVolume_instanceId :: Lens' AttachVolume Text
attachVolume_volumeId :: Lens' AttachVolume Text
data VolumeAttachment = VolumeAttachment' {
- attachTime :: Maybe ISO8601
- deleteOnTermination :: Maybe Bool
- device :: Maybe Text
- instanceId :: Maybe Text
- state :: Maybe VolumeAttachmentState
- volumeId :: Maybe Text
}
newVolumeAttachment :: VolumeAttachment
volumeAttachment_attachTime :: Lens' VolumeAttachment (Maybe UTCTime)
volumeAttachment_deleteOnTermination :: Lens' VolumeAttachment (Maybe Bool)
volumeAttachment_device :: Lens' VolumeAttachment (Maybe Text)
volumeAttachment_instanceId :: Lens' VolumeAttachment (Maybe Text)
volumeAttachment_state :: Lens' VolumeAttachment (Maybe VolumeAttachmentState)
volumeAttachment_volumeId :: Lens' VolumeAttachment (Maybe Text)

Creating a Request

data AttachVolume Source #

See: newAttachVolume smart constructor.

Constructors

AttachVolume'

Fields

dryRun :: 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.
device :: Text
The device name (for example, /dev/sdh or xvdh).
instanceId :: Text
The ID of the instance.
volumeId :: Text
The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Instances

Instances details

ToHeaders AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods toHeaders :: AttachVolume -> [Header] #
ToPath AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods toPath :: AttachVolume -> ByteString #
ToQuery AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods toQuery :: AttachVolume -> QueryString #
AWSRequest AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Associated Types type AWSResponse AttachVolume # Methods request :: (Service -> Service) -> AttachVolume -> Request AttachVolume # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AttachVolume -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AttachVolume))) #
Generic AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Associated Types type Rep AttachVolume :: Type -> Type # Methods from :: AttachVolume -> Rep AttachVolume x # to :: Rep AttachVolume x -> AttachVolume #
Read AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods readsPrec :: Int -> ReadS AttachVolume # readList :: ReadS [AttachVolume] # readPrec :: ReadPrec AttachVolume # readListPrec :: ReadPrec [AttachVolume] #
Show AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods showsPrec :: Int -> AttachVolume -> ShowS # show :: AttachVolume -> String # showList :: [AttachVolume] -> ShowS #
NFData AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods rnf :: AttachVolume -> () #
Eq AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods (==) :: AttachVolume -> AttachVolume -> Bool # (/=) :: AttachVolume -> AttachVolume -> Bool #
Hashable AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume Methods hashWithSalt :: Int -> AttachVolume -> Int # hash :: AttachVolume -> Int #
type AWSResponse AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume type AWSResponse AttachVolume = VolumeAttachment
type Rep AttachVolume Source #
Instance details Defined in Amazonka.EC2.AttachVolume type Rep AttachVolume = D1 ('MetaData "AttachVolume" "Amazonka.EC2.AttachVolume" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AttachVolume'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAttachVolume Source #

Arguments

:: Text	`AttachVolume`
-> Text	`AttachVolume`
-> Text	`AttachVolume`
-> AttachVolume

Create a value of AttachVolume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:AttachVolume', attachVolume_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.

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

AttachVolume, attachVolume_instanceId - The ID of the instance.

AttachVolume, attachVolume_volumeId - The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Request Lenses

attachVolume_dryRun :: Lens' AttachVolume (Maybe Bool) Source #

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.

attachVolume_device :: Lens' AttachVolume Text Source #

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

attachVolume_instanceId :: Lens' AttachVolume Text Source #

The ID of the instance.

attachVolume_volumeId :: Lens' AttachVolume Text Source #

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

Destructuring the Response

data VolumeAttachment Source #

Describes volume attachment details.

See: newVolumeAttachment smart constructor.

Constructors

VolumeAttachment'
Fields attachTime :: Maybe ISO8601 The time stamp when the attachment initiated. deleteOnTermination :: Maybe Bool Indicates whether the EBS volume is deleted on instance termination. device :: Maybe Text The device name. instanceId :: Maybe Text The ID of the instance. state :: Maybe VolumeAttachmentState The attachment state of the volume. volumeId :: Maybe Text The ID of the volume.

Instances

Instances details

FromXML VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods parseXML :: [Node] -> Either String VolumeAttachment #
Generic VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Associated Types type Rep VolumeAttachment :: Type -> Type # Methods from :: VolumeAttachment -> Rep VolumeAttachment x # to :: Rep VolumeAttachment x -> VolumeAttachment #
Read VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods readsPrec :: Int -> ReadS VolumeAttachment # readList :: ReadS [VolumeAttachment] # readPrec :: ReadPrec VolumeAttachment # readListPrec :: ReadPrec [VolumeAttachment] #
Show VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods showsPrec :: Int -> VolumeAttachment -> ShowS # show :: VolumeAttachment -> String # showList :: [VolumeAttachment] -> ShowS #
NFData VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods rnf :: VolumeAttachment -> () #
Eq VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods (==) :: VolumeAttachment -> VolumeAttachment -> Bool # (/=) :: VolumeAttachment -> VolumeAttachment -> Bool #
Hashable VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods hashWithSalt :: Int -> VolumeAttachment -> Int # hash :: VolumeAttachment -> Int #
type Rep VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment type Rep VolumeAttachment = D1 ('MetaData "VolumeAttachment" "Amazonka.EC2.Types.VolumeAttachment" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "VolumeAttachment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attachTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "deleteOnTermination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeAttachmentState)) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newVolumeAttachment :: VolumeAttachment Source #

Create a value of VolumeAttachment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachTime:VolumeAttachment', volumeAttachment_attachTime - The time stamp when the attachment initiated.

$sel:deleteOnTermination:VolumeAttachment', volumeAttachment_deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.

$sel:device:VolumeAttachment', volumeAttachment_device - The device name.

$sel:instanceId:VolumeAttachment', volumeAttachment_instanceId - The ID of the instance.

$sel:state:VolumeAttachment', volumeAttachment_state - The attachment state of the volume.

$sel:volumeId:VolumeAttachment', volumeAttachment_volumeId - The ID of the volume.

Response Lenses

volumeAttachment_attachTime :: Lens' VolumeAttachment (Maybe UTCTime) Source #

The time stamp when the attachment initiated.

volumeAttachment_deleteOnTermination :: Lens' VolumeAttachment (Maybe Bool) Source #

Indicates whether the EBS volume is deleted on instance termination.

volumeAttachment_device :: Lens' VolumeAttachment (Maybe Text) Source #

The device name.

volumeAttachment_instanceId :: Lens' VolumeAttachment (Maybe Text) Source #

The ID of the instance.

volumeAttachment_state :: Lens' VolumeAttachment (Maybe VolumeAttachmentState) Source #

The attachment state of the volume.

volumeAttachment_volumeId :: Lens' VolumeAttachment (Maybe Text) Source #

The ID of the volume.