amazonka-ec2-1.6.0: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.ModifyVolume

Contents

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 Source #

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 Source #

See: modifyVolume smart constructor.

Instances

Eq ModifyVolume Source # 
Data ModifyVolume Source # 

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 Source # 
Show ModifyVolume Source # 
Generic ModifyVolume Source # 

Associated Types

type Rep ModifyVolume :: * -> * #

Hashable ModifyVolume Source # 
NFData ModifyVolume Source # 

Methods

rnf :: ModifyVolume -> () #

AWSRequest ModifyVolume Source # 
ToHeaders ModifyVolume Source # 
ToPath ModifyVolume Source # 
ToQuery ModifyVolume Source # 
type Rep ModifyVolume Source # 
type Rep ModifyVolume = D1 * (MetaData "ModifyVolume" "Network.AWS.EC2.ModifyVolume" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "ModifyVolume'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mvSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_mvIOPS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mvVolumeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VolumeType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mvDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_mvVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs ModifyVolume Source # 

Request Lenses

mvSize :: Lens' ModifyVolume (Maybe Int) Source #

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) Source #

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) Source #

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) 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 .

mvVolumeId :: Lens' ModifyVolume Text Source #

The ID of the volume.

Destructuring the Response

modifyVolumeResponse Source #

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:

data ModifyVolumeResponse Source #

See: modifyVolumeResponse smart constructor.

Instances

Eq ModifyVolumeResponse Source # 
Data ModifyVolumeResponse Source # 

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 Source # 
Show ModifyVolumeResponse Source # 
Generic ModifyVolumeResponse Source # 
NFData ModifyVolumeResponse Source # 

Methods

rnf :: ModifyVolumeResponse -> () #

type Rep ModifyVolumeResponse Source # 
type Rep ModifyVolumeResponse = D1 * (MetaData "ModifyVolumeResponse" "Network.AWS.EC2.ModifyVolume" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "ModifyVolumeResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_mvrsVolumeModification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VolumeModification))) (S1 * (MetaSel (Just Symbol "_mvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

mvrsResponseStatus :: Lens' ModifyVolumeResponse Int Source #

  • - | The response status code.