You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Volume Instance Attribute Summary collapseInformation about the volume attachments.
The Availability Zone for the volume.
The time stamp when volume creation was initiated.
Indicates whether the volume is encrypted.
Indicates whether the volume was created using fast snapshot restore.
The number of I/O operations per second (IOPS) that the volume supports.
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
Indicates whether Amazon EBS Multi-Attach is enabled.
The Amazon Resource Name (ARN) of the Outpost.
The size of the volume, in GiBs.
The snapshot from which the volume was created, if applicable.
The volume state.
Any tags assigned to the volume.
The ID of the volume.
The volume type.
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption.
Deletes the specified EBS volume.
Describes the specified attribute of the specified volume.
Describes the status of the specified volumes.
Detaches an EBS volume from an instance.
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
.
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption.
Returns a Collection of Snapshot resources.
add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until
Methods included from Resources::OperationMethods#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations
Constructor Details #initialize(id, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object Instance Attribute Details #availability_zone ⇒ StringThe Availability Zone for the volume.
#create_time ⇒ TimeThe time stamp when volume creation was initiated.
#encrypted ⇒ BooleanIndicates whether the volume is encrypted.
#fast_restored ⇒ BooleanIndicates whether the volume was created using fast snapshot restore.
#iops ⇒ IntegerThe number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2
volumes and 100 to 64,000 IOPS for io1
and io2
volumes, in most Regions. The maximum IOPS for io1
and io2
of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.
Condition: This parameter is required for requests to create io1
and io2
volumes; it is not used in requests to create gp2
, st1
, sc1
, or standard
volumes.
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
#multi_attach_enabled ⇒ BooleanIndicates whether Amazon EBS Multi-Attach is enabled.
#outpost_arn ⇒ StringThe Amazon Resource Name (ARN) of the Outpost.
#size ⇒ IntegerThe size of the volume, in GiBs.
#snapshot_id ⇒ StringThe snapshot from which the volume was created, if applicable.
#state ⇒ StringThe volume state.
Possible values:
Any tags assigned to the volume.
#volume_type ⇒ StringThe volume type. This can be gp2
for General Purpose SSD, io1
or io2
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic volumes.
Possible values:
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use.
If a volume has an AWS Marketplace product code:
The volume can be attached only to a stopped instance.
AWS Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
#create_snapshot(options = {}) ⇒ Snapshot #create_tags(options = {}) ⇒ Array<Tag> #delete(options = {}) ⇒ StructDeletes the specified EBS volume. The volume must be in the available
state (not attached to an instance).
The volume can remain in the deleting
state for several minutes.
For more information, see Deleting an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
#delete_tags(options = {}) ⇒ Array<Tag> #describe_attribute(options = {}) ⇒ Types::DescribeVolumeAttributeResultDescribes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
#describe_status(options = {}) ⇒ Types::DescribeVolumeStatusResultDescribes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus
operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok
, impaired
, warning
, or insufficient-data
. If all checks pass, the overall status of the volume is ok
. If the check fails, the overall status is impaired
. If the status is insufficient-data
, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired
status, then the volume event might be potential-data-inconsistency
. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.
Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired
and the volume event shows potential-data-inconsistency
, then the action shows enable-volume-io
. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error
state (for example, when a volume is incapable of accepting I/O.)
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy
state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
#enable_io(options = {}) ⇒ StructEnables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
#modify_attribute(options = {}) ⇒ StructModifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
#snapshots(options = {}) ⇒ Collection<Snapshot>RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4