Class: Aws::EC2::Volume
- Inherits:
-
Object
- Object
- Aws::EC2::Volume
- Defined in:
- gems/aws-sdk-ec2/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 is encrypted.
-
#fast_restored ⇒ Boolean
Indicates whether the volume was created using fast snapshot restore.
-
#id ⇒ String
(also: #volume_id)
-
#iops ⇒ Integer
The number of I/O operations per second (IOPS).
-
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
-
#multi_attach_enabled ⇒ Boolean
Indicates whether Amazon EBS Multi-Attach is enabled.
-
#outpost_arn ⇒ String
The Amazon Resource Name (ARN) of the Outpost.
-
#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.
-
#throughput ⇒ Integer
The throughput that the volume supports, in MiB/s.
-
#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
-
#delete_tags(options = {}) ⇒ Tag::Collection
-
#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
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 = {}) {|resource| ... } ⇒ 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.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#attach_to_instance(options = {}) ⇒ Types::VolumeAttachment
285 286 287 288 289 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 285 def attach_to_instance( = {}) = .merge(volume_id: @id) resp = @client.attach_volume() resp.data end |
#attachments ⇒ Array<Types::VolumeAttachment>
Information about the volume attachments.
40 41 42 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 40 def data[:attachments] end |
#availability_zone ⇒ String
The Availability Zone for the volume.
46 47 48 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 46 def availability_zone data[:availability_zone] end |
#client ⇒ Client
136 137 138 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 136 def client @client end |
#create_snapshot(options = {}) ⇒ Snapshot
341 342 343 344 345 346 347 348 349 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 341 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
373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 373 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.
52 53 54 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 52 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
.
156 157 158 159 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 156 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
164 165 166 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 164 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
445 446 447 448 449 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 445 def delete( = {}) = .merge(volume_id: @id) resp = @client.delete_volume() resp.data end |
#delete_tags(options = {}) ⇒ Tag::Collection
418 419 420 421 422 423 424 425 426 427 428 429 430 431 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 418 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 |
#describe_attribute(options = {}) ⇒ Types::DescribeVolumeAttributeResult
466 467 468 469 470 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 466 def describe_attribute( = {}) = .merge(volume_id: @id) resp = @client.describe_volume_attribute() resp.data end |
#describe_status(options = {}) ⇒ Types::DescribeVolumeStatusResult
542 543 544 545 546 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 542 def describe_status( = {}) = Aws::Util.deep_merge(, volume_ids: [@id]) resp = @client.describe_volume_status() resp.data end |
#detach_from_instance(options = {}) ⇒ Types::VolumeAttachment
577 578 579 580 581 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 577 def detach_from_instance( = {}) = .merge(volume_id: @id) resp = @client.detach_volume() resp.data end |
#enable_io(options = {}) ⇒ EmptyStructure
595 596 597 598 599 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 595 def enable_io( = {}) = .merge(volume_id: @id) resp = @client.enable_volume_io() resp.data end |
#encrypted ⇒ Boolean
Indicates whether the volume is encrypted.
58 59 60 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 58 def encrypted data[:encrypted] end |
#fast_restored ⇒ Boolean
Indicates whether the volume was created using fast snapshot restore.
117 118 119 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 117 def fast_restored data[:fast_restored] end |
#id ⇒ String Also known as: volume_id
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 33 def id @id end |
#iops ⇒ Integer
The number of I/O operations per second (IOPS). For gp3
, io1
, and
io2
volumes, this represents the number of IOPS that are provisioned
for the volume. For gp2
volumes, this represents the baseline
performance of the volume and the rate at which the volume accumulates
I/O credits for bursting.
99 100 101 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 99 def iops data[:iops] end |
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
65 66 67 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 65 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
146 147 148 149 150 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 146 def load resp = @client.describe_volumes(volume_ids: [@id]) @data = resp.volumes[0] self end |
#modify_attribute(options = {}) ⇒ EmptyStructure
619 620 621 622 623 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 619 def modify_attribute( = {}) = .merge(volume_id: @id) resp = @client.modify_volume_attribute() resp.data end |
#multi_attach_enabled ⇒ Boolean
Indicates whether Amazon EBS Multi-Attach is enabled.
123 124 125 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 123 def multi_attach_enabled data[:multi_attach_enabled] end |
#outpost_arn ⇒ String
The Amazon Resource Name (ARN) of the Outpost.
71 72 73 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 71 def outpost_arn data[:outpost_arn] end |
#size ⇒ Integer
The size of the volume, in GiBs.
77 78 79 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 77 def size data[:size] end |
#snapshot_id ⇒ String
The snapshot from which the volume was created, if applicable.
83 84 85 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 83 def snapshot_id data[:snapshot_id] end |
#snapshots(options = {}) ⇒ Snapshot::Collection
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 702 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.
89 90 91 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 89 def state data[:state] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the volume.
105 106 107 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 105 def data[:tags] end |
#throughput ⇒ Integer
The throughput that the volume supports, in MiB/s.
129 130 131 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 129 def throughput data[:throughput] end |
#volume_type ⇒ String
The volume type.
111 112 113 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 111 def volume_type data[:volume_type] end |
#wait_until(options = {}) {|resource| ... } ⇒ 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) do |instance|
instance.state.name == 'running'
end
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
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/volume.rb', line 248 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 |