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: "VolumeId", # required
  size: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  iops: 1,
  throughput: 1,
  multi_attach_enabled: false,
}

Constant Summary collapse

SENSITIVE =
[]

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)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

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.

Returns:

  • (Integer)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#multi_attach_enabledBoolean

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.

Returns:

  • (Boolean)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#sizeInteger

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.

Returns:

  • (Integer)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#throughputInteger

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.

Returns:

  • (Integer)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#volume_idString

The ID of the volume.

Returns:

  • (String)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#volume_typeString

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.

Returns:

  • (String)


42154
42155
42156
42157
42158
42159
42160
42161
42162
42163
42164
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42154

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  include Aws::Structure
end