Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.EC2.ModifyVolume

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux . For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows .

When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System . For information about extending a Windows file system, see Extending a Windows File System .

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide . You can also track the status of a modification using the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications .

Synopsis

Creating a Request

modifyVolume #

Arguments

:: Text	`mvVolumeId`
-> ModifyVolume

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

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

mvSize - Target size in GiB of the volume to be modified. Target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html . Default: If no size is specified, the existing size is retained.
mvIOPS - Target IOPS rate of the volume to be modified. Only valid for Provisioned IOPS SSD (io1 ) volumes. For more information about io1 IOPS configuration, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html#EBSVolumeTypes_piops . Default: If no IOPS value is specified, the existing value is retained.
mvVolumeType - Target EBS volume type of the volume to be modified The API does not support modifications for volume type standard . You also cannot change the type of a volume to standard . Default: If no type is specified, the existing type is retained.
mvDryRun - 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 .
mvVolumeId - The ID of the volume.

data ModifyVolume #

See: modifyVolume smart constructor.

Instances

Eq ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods (==) :: ModifyVolume -> ModifyVolume -> Bool # (/=) :: ModifyVolume -> ModifyVolume -> Bool #
Data ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyVolume -> c ModifyVolume # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyVolume # toConstr :: ModifyVolume -> Constr # dataTypeOf :: ModifyVolume -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyVolume) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyVolume) # gmapT :: (forall b. Data b => b -> b) -> ModifyVolume -> ModifyVolume # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyVolume -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyVolume -> r # gmapQ :: (forall d. Data d => d -> u) -> ModifyVolume -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyVolume -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyVolume -> m ModifyVolume # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyVolume -> m ModifyVolume # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyVolume -> m ModifyVolume #
Read ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods readsPrec :: Int -> ReadS ModifyVolume # readList :: ReadS [ModifyVolume] # readPrec :: ReadPrec ModifyVolume # readListPrec :: ReadPrec [ModifyVolume] #
Show ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods showsPrec :: Int -> ModifyVolume -> ShowS # show :: ModifyVolume -> String # showList :: [ModifyVolume] -> ShowS #
Generic ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Associated Types type Rep ModifyVolume :: * -> * # Methods from :: ModifyVolume -> Rep ModifyVolume x # to :: Rep ModifyVolume x -> ModifyVolume #
Hashable ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods hashWithSalt :: Int -> ModifyVolume -> Int # hash :: ModifyVolume -> Int #
AWSRequest ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Associated Types type Rs ModifyVolume :: * # Methods request :: ModifyVolume -> Request ModifyVolume # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ModifyVolume -> ClientResponse -> m (Response ModifyVolume) #
ToHeaders ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods toHeaders :: ModifyVolume -> [Header] #
ToPath ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods toPath :: ModifyVolume -> ByteString #
ToQuery ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods toQuery :: ModifyVolume -> QueryString #
NFData ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods rnf :: ModifyVolume -> () #
type Rep ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume type Rep ModifyVolume = D1 (MetaData "ModifyVolume" "Network.AWS.EC2.ModifyVolume" "amazonka-ec2-1.6.0-G6ppxISnQxeI7PhDx9p8Zy" False) (C1 (MetaCons "ModifyVolume'" PrefixI True) ((S1 (MetaSel (Just "_mvSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :: S1 (MetaSel (Just "_mvIOPS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :: (S1 (MetaSel (Just "_mvVolumeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumeType)) :: (S1 (MetaSel (Just "_mvDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_mvVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ModifyVolume #
Instance details Defined in Network.AWS.EC2.ModifyVolume type Rs ModifyVolume = ModifyVolumeResponse

Request Lenses

mvSize :: Lens' ModifyVolume (Maybe Int) #

Target size in GiB of the volume to be modified. Target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html . Default: If no size is specified, the existing size is retained.

mvIOPS :: Lens' ModifyVolume (Maybe Int) #

Target IOPS rate of the volume to be modified. Only valid for Provisioned IOPS SSD (io1 ) volumes. For more information about io1 IOPS configuration, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html#EBSVolumeTypes_piops . Default: If no IOPS value is specified, the existing value is retained.

mvVolumeType :: Lens' ModifyVolume (Maybe VolumeType) #

Target EBS volume type of the volume to be modified The API does not support modifications for volume type standard . You also cannot change the type of a volume to standard . Default: If no type is specified, the existing type is retained.

mvDryRun :: Lens' ModifyVolume (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 .

mvVolumeId :: Lens' ModifyVolume Text #

The ID of the volume.

Destructuring the Response

modifyVolumeResponse #

Arguments

:: Int	`mvrsResponseStatus`
-> ModifyVolumeResponse

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

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

mvrsVolumeModification - A VolumeModification object.
mvrsResponseStatus - -- | The response status code.

data ModifyVolumeResponse #

See: modifyVolumeResponse smart constructor.

Instances

Eq ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods (==) :: ModifyVolumeResponse -> ModifyVolumeResponse -> Bool # (/=) :: ModifyVolumeResponse -> ModifyVolumeResponse -> Bool #
Data ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyVolumeResponse -> c ModifyVolumeResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyVolumeResponse # toConstr :: ModifyVolumeResponse -> Constr # dataTypeOf :: ModifyVolumeResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyVolumeResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyVolumeResponse) # gmapT :: (forall b. Data b => b -> b) -> ModifyVolumeResponse -> ModifyVolumeResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyVolumeResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyVolumeResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ModifyVolumeResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyVolumeResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyVolumeResponse -> m ModifyVolumeResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyVolumeResponse -> m ModifyVolumeResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyVolumeResponse -> m ModifyVolumeResponse #
Read ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods readsPrec :: Int -> ReadS ModifyVolumeResponse # readList :: ReadS [ModifyVolumeResponse] # readPrec :: ReadPrec ModifyVolumeResponse # readListPrec :: ReadPrec [ModifyVolumeResponse] #
Show ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods showsPrec :: Int -> ModifyVolumeResponse -> ShowS # show :: ModifyVolumeResponse -> String # showList :: [ModifyVolumeResponse] -> ShowS #
Generic ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume Associated Types type Rep ModifyVolumeResponse :: * -> * # Methods from :: ModifyVolumeResponse -> Rep ModifyVolumeResponse x # to :: Rep ModifyVolumeResponse x -> ModifyVolumeResponse #
NFData ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume Methods rnf :: ModifyVolumeResponse -> () #
type Rep ModifyVolumeResponse #
Instance details Defined in Network.AWS.EC2.ModifyVolume type Rep ModifyVolumeResponse = D1 (MetaData "ModifyVolumeResponse" "Network.AWS.EC2.ModifyVolume" "amazonka-ec2-1.6.0-G6ppxISnQxeI7PhDx9p8Zy" False) (C1 (MetaCons "ModifyVolumeResponse'" PrefixI True) (S1 (MetaSel (Just "_mvrsVolumeModification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumeModification)) :*: S1 (MetaSel (Just "_mvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

mvrsVolumeModification :: Lens' ModifyVolumeResponse (Maybe VolumeModification) #

A VolumeModification object.

mvrsResponseStatus :: Lens' ModifyVolumeResponse Int #

- | The response status code.