amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.ModifyVolume

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 might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).

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 more information, see Extend a Linux file system or Extend 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 DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.

With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.

After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.

Synopsis

Creating a Request

data ModifyVolume Source #

See: newModifyVolume smart constructor.

Constructors

ModifyVolume' 

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.

  • iops :: Maybe Int

    The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

    The following are the supported values for each volume type:

    • gp3: 3,000-16,000 IOPS
    • io1: 100-64,000 IOPS
    • io2: 100-64,000 IOPS

    Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.

  • multiAttachEnabled :: Maybe Bool

    Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

  • size :: Maybe Int

    The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

    The following are the supported volumes sizes for each volume type:

    • gp2 and gp3: 1-16,384
    • io1 and io2: 4-16,384
    • st1 and sc1: 125-16,384
    • standard: 1-1,024

    Default: The existing size is retained.

  • throughput :: Maybe Int

    The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

    Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.

    Valid Range: Minimum value of 125. Maximum value of 1000.

  • volumeType :: Maybe VolumeType

    The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

    Default: The existing type is retained.

  • volumeId :: Text

    The ID of the volume.

Instances

Instances details
ToHeaders ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

toHeaders :: ModifyVolume -> [Header] #

ToPath ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

toPath :: ModifyVolume -> ByteString #

ToQuery ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

toQuery :: ModifyVolume -> QueryString #

AWSRequest ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Associated Types

type AWSResponse ModifyVolume #

Methods

request :: (Service -> Service) -> ModifyVolume -> Request ModifyVolume #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyVolume -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyVolume))) #

Generic ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Associated Types

type Rep ModifyVolume :: Type -> Type #

Methods

from :: ModifyVolume -> Rep ModifyVolume x #

to :: Rep ModifyVolume x -> ModifyVolume #

Read ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

readsPrec :: Int -> ReadS ModifyVolume #

readList :: ReadS [ModifyVolume] #

readPrec :: ReadPrec ModifyVolume #

readListPrec :: ReadPrec [ModifyVolume] #

Show ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

showsPrec :: Int -> ModifyVolume -> ShowS #

show :: ModifyVolume -> String #

showList :: [ModifyVolume] -> ShowS #

NFData ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

rnf :: ModifyVolume -> () #

Eq ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

(==) :: ModifyVolume -> ModifyVolume -> Bool #

(/=) :: ModifyVolume -> ModifyVolume -> Bool #

Hashable ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

hashWithSalt :: Int -> ModifyVolume -> Int #

hash :: ModifyVolume -> Int #

type AWSResponse ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

type AWSResponse ModifyVolume = ModifyVolumeResponse
type Rep ModifyVolume Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

type Rep ModifyVolume = D1 ('MetaData "ModifyVolume" "Amazonka.EC2.ModifyVolume" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyVolume'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "multiAttachEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "throughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "volumeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeType)) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyVolume Source #

Arguments

:: Text

ModifyVolume

-> ModifyVolume 

Create a value of ModifyVolume 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:ModifyVolume', modifyVolume_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.

ModifyVolume, modifyVolume_iops - The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS
  • io1: 100-64,000 IOPS
  • io2: 100-64,000 IOPS

Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.

ModifyVolume, modifyVolume_multiAttachEnabled - Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

ModifyVolume, modifyVolume_size - The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384
  • io1 and io2: 4-16,384
  • st1 and sc1: 125-16,384
  • standard: 1-1,024

Default: The existing size is retained.

ModifyVolume, modifyVolume_throughput - The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.

Valid Range: Minimum value of 125. Maximum value of 1000.

ModifyVolume, modifyVolume_volumeType - The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: The existing type is retained.

ModifyVolume, modifyVolume_volumeId - The ID of the volume.

Request Lenses

modifyVolume_dryRun :: 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.

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

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS
  • io1: 100-64,000 IOPS
  • io2: 100-64,000 IOPS

Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.

modifyVolume_multiAttachEnabled :: Lens' ModifyVolume (Maybe Bool) Source #

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

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

The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384
  • io1 and io2: 4-16,384
  • st1 and sc1: 125-16,384
  • standard: 1-1,024

Default: The existing size is retained.

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

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.

Valid Range: Minimum value of 125. Maximum value of 1000.

modifyVolume_volumeType :: Lens' ModifyVolume (Maybe VolumeType) Source #

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: The existing type is retained.

modifyVolume_volumeId :: Lens' ModifyVolume Text Source #

The ID of the volume.

Destructuring the Response

data ModifyVolumeResponse Source #

See: newModifyVolumeResponse smart constructor.

Constructors

ModifyVolumeResponse' 

Fields

Instances

Instances details
Generic ModifyVolumeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Associated Types

type Rep ModifyVolumeResponse :: Type -> Type #

Methods

from :: ModifyVolumeResponse -> Rep ModifyVolumeResponse x #

to :: Rep ModifyVolumeResponse x -> ModifyVolumeResponse #

Read ModifyVolumeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

readsPrec :: Int -> ReadS ModifyVolumeResponse #

readList :: ReadS [ModifyVolumeResponse] #

readPrec :: ReadPrec ModifyVolumeResponse #

readListPrec :: ReadPrec [ModifyVolumeResponse] #

Show ModifyVolumeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

showsPrec :: Int -> ModifyVolumeResponse -> ShowS #

show :: ModifyVolumeResponse -> String #

showList :: [ModifyVolumeResponse] -> ShowS #

NFData ModifyVolumeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

rnf :: ModifyVolumeResponse -> () #

Eq ModifyVolumeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

Methods

(==) :: ModifyVolumeResponse -> ModifyVolumeResponse -> Bool #

(/=) :: ModifyVolumeResponse -> ModifyVolumeResponse -> Bool #

type Rep ModifyVolumeResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyVolume

type Rep ModifyVolumeResponse = D1 ('MetaData "ModifyVolumeResponse" "Amazonka.EC2.ModifyVolume" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyVolumeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumeModification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeModification)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyVolumeResponse Source #

Arguments

:: Int

$sel:httpStatus:ModifyVolumeResponse'

-> ModifyVolumeResponse 

Create a value of ModifyVolumeResponse 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:volumeModification:ModifyVolumeResponse', modifyVolumeResponse_volumeModification - Information about the volume modification.

$sel:httpStatus:ModifyVolumeResponse', modifyVolumeResponse_httpStatus - The response's http status code.

Response Lenses

modifyVolumeResponse_volumeModification :: Lens' ModifyVolumeResponse (Maybe VolumeModification) Source #

Information about the volume modification.

modifyVolumeResponse_httpStatus :: Lens' ModifyVolumeResponse Int Source #

The response's http status code.