You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::ModifyVolumeRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyVolumeRequest data as a hash:

{
  dry_run: false,
  volume_id: "String", # required
  size: 1,
  volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
  iops: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


21636
21637
21638
21639
21640
21641
21642
21643
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21636

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops)
  include Aws::Structure
end

#iopsInteger

The target IOPS rate of the volume.

This is only valid for Provisioned IOPS SSD (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes.

Default: If no IOPS value is specified, the existing value is retained.

Returns:

  • (Integer)


21636
21637
21638
21639
21640
21641
21642
21643
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21636

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops)
  include Aws::Structure
end

#sizeInteger

The target size of the volume, in GiB. The 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 Amazon EBS Volume Types.

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

Returns:

  • (Integer)


21636
21637
21638
21639
21640
21641
21642
21643
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21636

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops)
  include Aws::Structure
end

#volume_idString

The ID of the volume.

Returns:

  • (String)


21636
21637
21638
21639
21640
21641
21642
21643
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21636

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops)
  include Aws::Structure
end

#volume_typeString

The target EBS volume type of the volume.

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

Returns:

  • (String)


21636
21637
21638
21639
21640
21641
21642
21643
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21636

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops)
  include Aws::Structure
end