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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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.

• #multi_attach_enabled ⇒ Boolean

  Specifies whether to enable Amazon EBS Multi-Attach.

• #size ⇒ Integer

  The target size of the volume, in GiB.

• #throughput ⇒ Integer

  The target throughput of the volume, in MiB/s.

• #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 50388

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

#iops ⇒ Integer

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 - 256,000 IOPS

For ‘io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances, you can achieve performance up to 32,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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances

Returns:

• (Integer)

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

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

#multi_attach_enabled ⇒ Boolean

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 EBS User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances [2]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html

Returns:

• (Boolean)

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

class ModifyVolumeRequest < Struct.new(
  :dry_run,
  :volume_id,
  :size,
  :volume_type,
  :iops,
  :throughput,
  :multi_attach_enabled)
  SENSITIVE = []
  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 the existing size of the volume.

The following are the supported volumes sizes for each volume type:

• ‘gp2` and `gp3`: 1 - 16,384 GiB

• ‘io1`: 4 - 16,384 GiB

• ‘io2`: 4 - 65,536 GiB

• ‘st1` and `sc1`: 125 - 16,384 GiB

• ‘standard`: 1 - 1024 GiB

Default: The existing size is retained.

Returns:

• (Integer)

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

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

#throughput ⇒ Integer

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)

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

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

#volume_id ⇒ String

The ID of the volume.

Returns:

• (String)

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

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

#volume_type ⇒ String

The target EBS volume type of the volume. For more information, see

Amazon EBS volume types][1

in the *Amazon EBS User Guide*.

Default: The existing type is retained.

[1]: docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html

Returns:

• (String)

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

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