Class: AWS::EC2::Volume

Inherits:
Resource
  • Object
show all
Includes:
TaggedItem
Defined in:
lib/aws/ec2/volume.rb

Overview

Represents an Amazon EBS volume.

Examples:

Create an empty 15GiB volume and attach it to an instance

volume = ec2.volumes.create(:size => 15,
                            :availability_zone => "us-east-1a")
attachment = volume.attach_to(ec2.instances["i-123"], "/dev/sdf")
sleep 1 until attachment.status != :attaching

Remove all attachments from a volume and then delete it

volume.attachments.each do |attachment|
  attachment.delete(:force => true)
end
sleep 1 until volume.status == :available
volume.delete

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TaggedItem

#add_tag, #clear_tags, #tags

Instance Attribute Details

#availability_zone_name ⇒ String (readonly)

Name of the Availability Zone in which the volume was created.



53
54
55
 
# File 'lib/aws/ec2/volume.rb', line 53

def availability_zone_name
  @availability_zone_name
end

#create_time ⇒ Time (readonly)

The time at which the volume was created.



53
54
55
 
# File 'lib/aws/ec2/volume.rb', line 53

def create_time
  @create_time
end

#id ⇒ String (readonly) 



64
65
66
 
# File 'lib/aws/ec2/volume.rb', line 64

def id
  @id
end

#iops ⇒ String (readonly) 



53
54
55
 
# File 'lib/aws/ec2/volume.rb', line 53

def iops
  @iops
end

#size ⇒ Integer (readonly)

The size of the volume in gigabytes.



53
54
55
 
# File 'lib/aws/ec2/volume.rb', line 53

def size
  @size
end

#status ⇒ Symbol (readonly) Also known as: state

The status of the volume. Possible values:

  • :creating

  • :available

  • :in_use

  • :deleting

  • :deleted

  • :error



53
54
55
 
# File 'lib/aws/ec2/volume.rb', line 53

def status
  @status
end

Instance Method Details

#attach_to(instance, device) ⇒ Attachment Also known as: attach

Attaches the volume to an instance.



118
119
120
121
122
123
124
125
126
 
# File 'lib/aws/ec2/volume.rb', line 118

def attach_to(instance, device)
  resp = client.attach_volume(
    :volume_id => id,
    :instance_id => instance.id,
    :device => device
  )
  instance = Instance.new(resp.instance_id, :config => config)
  Attachment.new(self, instance, resp.device, :config => config)
end

#attachments ⇒ AttachmentCollection 



167
168
169
 
# File 'lib/aws/ec2/volume.rb', line 167

def attachments
  AttachmentCollection.new(self, :config => config)
end

#availability_zone ⇒ AvailabilityZone 



159
160
161
162
163
 
# File 'lib/aws/ec2/volume.rb', line 159

def availability_zone
  if name = availability_zone_name
    AvailabilityZone.new(name, :config => config)
  end
end

#create_snapshot(description = nil) ⇒ Snapshot 



101
102
103
104
105
 
# File 'lib/aws/ec2/volume.rb', line 101

def create_snapshot description = nil
  opts = { :volume => self }
  opts[:description] = description if description
  SnapshotCollection.new(:config => config).create(opts)
end

#delete ⇒ Object

Deletes the volume.



92
93
94
95
 
# File 'lib/aws/ec2/volume.rb', line 92

def delete
  client.delete_volume(:volume_id => id)
  nil
end

#detach_from(instance, device, options = {}) ⇒ Attachment

Detaches the volume from an instance.

Options Hash (options):

  • :force (Boolean) —

    Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.



136
137
138
139
140
141
 
# File 'lib/aws/ec2/volume.rb', line 136

def detach_from(instance, device, options = {})
  instance = Instance.new(instance.id, :config => config),
  a = Attachment.new(self, instance, device, :config => config)
  a.delete(options)
  a
end

#exists? ⇒ Boolean 



144
145
146
147
148
149
 
# File 'lib/aws/ec2/volume.rb', line 144

def exists?
  resp = client.describe_volumes(:filters => [
    { :name => 'volume-id', :values => [id] }
  ]) 
  resp.volume_index.key?(id)
end

#snapshot ⇒ Snapshot 



153
154
155
 
# File 'lib/aws/ec2/volume.rb', line 153

def snapshot
  snapshot_id ? Snapshot.new(snapshot_id, :config => config) : nil
end