/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::EC2::ModifyVolume

NAME

Paws::EC2::ModifyVolume - Arguments for method ModifyVolume on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method ModifyVolume on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method ModifyVolume.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyVolume.

SYNOPSIS

my $ec2 = Paws->service('EC2');
my $ModifyVolumeResult = $ec2->ModifyVolume(
  VolumeId           => 'MyVolumeId',
  DryRun             => 1,              # OPTIONAL
  Iops               => 1,              # OPTIONAL
  MultiAttachEnabled => 1,              # OPTIONAL
  Size               => 1,              # OPTIONAL
  Throughput         => 1,              # OPTIONAL
  VolumeType         => 'standard',     # OPTIONAL
);

# Results:
my $VolumeModification = $ModifyVolumeResult->VolumeModification;

# Returns a L<Paws::EC2::ModifyVolumeResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifyVolume

ATTRIBUTES

DryRun => 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 => 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: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

MultiAttachEnabled => 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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html) in the Amazon Elastic Compute Cloud User Guide.

Size => 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: If no size is specified, the existing size is retained.

Throughput => 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: If no throughput value is specified, the existing value is retained.

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

REQUIRED VolumeId => Str

The ID of the volume.

VolumeType => Str

The target EBS volume type of the volume. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the Amazon Elastic Compute Cloud User Guide.

Default: If no type is specified, the existing type is retained.

Valid values are: "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3"

SEE ALSO

This class forms part of Paws, documenting arguments for method ModifyVolume in Paws::EC2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues