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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyVolumeRequest

Includes:

Structure

Defined in:

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,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #iops ⇒ Integer

  The target IOPS rate of the volume.

• #size ⇒ Integer

  The target size of the volume, in GiB.

• #volume_id ⇒ String

  The ID of the volume.

• #volume_type ⇒ String

  The target EBS volume type of the volume.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

# File 'lib/aws-sdk-ec2/types.rb', line 26542

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

#iops ⇒ Integer

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html#EBSVolumeTypes_piops

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 26542

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

#size ⇒ Integer

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 26542

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

#volume_id ⇒ String

The ID of the volume.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 26542

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

#volume_type ⇒ String

The target EBS volume type of the volume.

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 26542

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