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)


17351
17352
17353
17354
17355
17356
17357
17358
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17351

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

#iopsInteger

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.

Returns:

  • (Integer)


17351
17352
17353
17354
17355
17356
17357
17358
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17351

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

#sizeInteger

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.

Returns:

  • (Integer)


17351
17352
17353
17354
17355
17356
17357
17358
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17351

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

#volume_idString

Returns:

  • (String)


17351
17352
17353
17354
17355
17356
17357
17358
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17351

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

#volume_typeString

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.

Returns:

  • (String)


17351
17352
17353
17354
17355
17356
17357
17358
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17351

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