Class: Aws::EC2::Volume
- Inherits:
-
Object
- Object
- Aws::EC2::Volume
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/volume.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#attachments ⇒ Array<Types::VolumeAttachment>
Information about the volume attachments.
-
#availability_zone ⇒ String
The Availability Zone for the volume.
-
#create_time ⇒ Time
The time stamp when volume creation was initiated.
-
#encrypted ⇒ Boolean
Indicates whether the volume will be encrypted.
- #id ⇒ String (also: #volume_id)
-
#iops ⇒ Integer
The number of I/O operations per second (IOPS) that the volume supports.
-
#kms_key_id ⇒ String
The full 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.
-
#size ⇒ Integer
The size of the volume, in GiBs.
-
#snapshot_id ⇒ String
The snapshot from which the volume was created, if applicable.
-
#state ⇒ String
The volume state.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the volume.
-
#volume_type ⇒ String
The volume type.
Actions collapse
- #attach_to_instance(options = {}) ⇒ Types::VolumeAttachment
- #create_snapshot(options = {}) ⇒ Snapshot
- #create_tags(options = {}) ⇒ Tag::Collection
- #delete(options = {}) ⇒ EmptyStructure
- #describe_attribute(options = {}) ⇒ Types::DescribeVolumeAttributeResult
- #describe_status(options = {}) ⇒ Types::DescribeVolumeStatusResult
- #detach_from_instance(options = {}) ⇒ Types::VolumeAttachment
- #enable_io(options = {}) ⇒ EmptyStructure
- #modify_attribute(options = {}) ⇒ EmptyStructure
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #snapshots(options = {}) ⇒ Snapshot::Collection
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Volume
Returns the data for this Volume.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ Volume
constructor
A new instance of Volume.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ Volume #initialize(options = {}) ⇒ Volume
Returns a new instance of Volume.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/volume.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#attach_to_instance(options = {}) ⇒ Types::VolumeAttachment
274 275 276 277 278 |
# File 'lib/aws-sdk-ec2/volume.rb', line 274 def attach_to_instance( = {}) = .merge(volume_id: @id) resp = @client.attach_volume() resp.data end |
#attachments ⇒ Array<Types::VolumeAttachment>
Information about the volume attachments.
36 37 38 |
# File 'lib/aws-sdk-ec2/volume.rb', line 36 def data[:attachments] end |
#availability_zone ⇒ String
The Availability Zone for the volume.
42 43 44 |
# File 'lib/aws-sdk-ec2/volume.rb', line 42 def availability_zone data[:availability_zone] end |
#create_snapshot(options = {}) ⇒ Snapshot
308 309 310 311 312 313 314 315 316 |
# File 'lib/aws-sdk-ec2/volume.rb', line 308 def create_snapshot( = {}) = .merge(volume_id: @id) resp = @client.create_snapshot() Snapshot.new( id: resp.data.snapshot_id, data: resp.data, client: @client ) end |
#create_tags(options = {}) ⇒ Tag::Collection
340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/aws-sdk-ec2/volume.rb', line 340 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = @client.() [:tags].each do |t| batch << Tag.new( resource_id: @id, key: t[:key], value: t[:value], client: @client ) end Tag::Collection.new([batch], size: batch.size) end |
#create_time ⇒ Time
The time stamp when volume creation was initiated.
48 49 50 |
# File 'lib/aws-sdk-ec2/volume.rb', line 48 def create_time data[:create_time] end |
#data ⇒ Types::Volume
Returns the data for this Aws::EC2::Volume. Calls Client#describe_volumes if #data_loaded? is ‘false`.
147 148 149 150 |
# File 'lib/aws-sdk-ec2/volume.rb', line 147 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
155 156 157 |
# File 'lib/aws-sdk-ec2/volume.rb', line 155 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
367 368 369 370 371 |
# File 'lib/aws-sdk-ec2/volume.rb', line 367 def delete( = {}) = .merge(volume_id: @id) resp = @client.delete_volume() resp.data end |
#describe_attribute(options = {}) ⇒ Types::DescribeVolumeAttributeResult
388 389 390 391 392 |
# File 'lib/aws-sdk-ec2/volume.rb', line 388 def describe_attribute( = {}) = .merge(volume_id: @id) resp = @client.describe_volume_attribute() resp.data end |
#describe_status(options = {}) ⇒ Types::DescribeVolumeStatusResult
464 465 466 467 468 |
# File 'lib/aws-sdk-ec2/volume.rb', line 464 def describe_status( = {}) = Aws::Util.deep_merge(, volume_ids: [@id]) resp = @client.describe_volume_status() resp.data end |
#detach_from_instance(options = {}) ⇒ Types::VolumeAttachment
498 499 500 501 502 |
# File 'lib/aws-sdk-ec2/volume.rb', line 498 def detach_from_instance( = {}) = .merge(volume_id: @id) resp = @client.detach_volume() resp.data end |
#enable_io(options = {}) ⇒ EmptyStructure
516 517 518 519 520 |
# File 'lib/aws-sdk-ec2/volume.rb', line 516 def enable_io( = {}) = .merge(volume_id: @id) resp = @client.enable_volume_io() resp.data end |
#encrypted ⇒ Boolean
Indicates whether the volume will be encrypted.
54 55 56 |
# File 'lib/aws-sdk-ec2/volume.rb', line 54 def encrypted data[:encrypted] end |
#id ⇒ String Also known as: volume_id
29 30 31 |
# File 'lib/aws-sdk-ec2/volume.rb', line 29 def id @id end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
638 639 640 |
# File 'lib/aws-sdk-ec2/volume.rb', line 638 def identifiers { id: @id } end |
#iops ⇒ Integer
The 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,000IOPS for `io1` volumes, in most Regions. The maximum IOPS for `io1` 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` volumes; it is not used in requests to create `gp2`, `st1`, `sc1`, or `standard` volumes.
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances
106 107 108 |
# File 'lib/aws-sdk-ec2/volume.rb', line 106 def iops data[:iops] end |
#kms_key_id ⇒ String
The full 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.
62 63 64 |
# File 'lib/aws-sdk-ec2/volume.rb', line 62 def kms_key_id data[:kms_key_id] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::Volume. Returns ‘self` making it possible to chain methods.
volume.reload.data
137 138 139 140 141 |
# File 'lib/aws-sdk-ec2/volume.rb', line 137 def load resp = @client.describe_volumes(volume_ids: [@id]) @data = resp.volumes[0] self end |
#modify_attribute(options = {}) ⇒ EmptyStructure
540 541 542 543 544 |
# File 'lib/aws-sdk-ec2/volume.rb', line 540 def modify_attribute( = {}) = .merge(volume_id: @id) resp = @client.modify_volume_attribute() resp.data end |
#size ⇒ Integer
The size of the volume, in GiBs.
68 69 70 |
# File 'lib/aws-sdk-ec2/volume.rb', line 68 def size data[:size] end |
#snapshot_id ⇒ String
The snapshot from which the volume was created, if applicable.
74 75 76 |
# File 'lib/aws-sdk-ec2/volume.rb', line 74 def snapshot_id data[:snapshot_id] end |
#snapshots(options = {}) ⇒ Snapshot::Collection
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
# File 'lib/aws-sdk-ec2/volume.rb', line 614 def snapshots( = {}) batches = Enumerator.new do |y| = Aws::Util.deep_merge(, filters: [{ name: "volume-id", values: [@id] }]) resp = @client.describe_snapshots() resp.each_page do |page| batch = [] page.data.snapshots.each do |s| batch << Snapshot.new( id: s.snapshot_id, data: s, client: @client ) end y.yield(batch) end end Snapshot::Collection.new(batches) end |
#state ⇒ String
The volume state.
80 81 82 |
# File 'lib/aws-sdk-ec2/volume.rb', line 80 def state data[:state] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the volume.
112 113 114 |
# File 'lib/aws-sdk-ec2/volume.rb', line 112 def data[:tags] end |
#volume_type ⇒ String
The volume type. This can be ‘gp2` for General Purpose SSD, `io1` for Provisioned IOPS SSD, `st1` for Throughput Optimized HDD, `sc1` for Cold HDD, or `standard` for Magnetic volumes.
120 121 122 |
# File 'lib/aws-sdk-ec2/volume.rb', line 120 def volume_type data[:volume_type] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::EC2::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged
Waiter polls an API operation until a resource enters a desired state.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/aws-sdk-ec2/volume.rb', line 237 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |