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.

Returns:

  • (String) —

    the current value of availability_zone_name



56
57
58
 
# File 'lib/aws/ec2/volume.rb', line 56

def availability_zone_name
  @availability_zone_name
end

#create_time ⇒ Time (readonly)

The time at which the volume was created.

Returns:

  • (Time) —

    the current value of create_time



56
57
58
 
# File 'lib/aws/ec2/volume.rb', line 56

def create_time
  @create_time
end

#id ⇒ String (readonly)

Returns the volume ID.

Returns:

  • (String) —

    Returns the volume ID.



67
68
69
 
# File 'lib/aws/ec2/volume.rb', line 67

def id
  @id
end

#size ⇒ Integer (readonly)

The size of the volume in gigabytes.

Returns:

  • (Integer) —

    the current value of size



56
57
58
 
# File 'lib/aws/ec2/volume.rb', line 56

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

Returns:

  • (Symbol) —

    the current value of status



56
57
58
 
# File 'lib/aws/ec2/volume.rb', line 56

def status
  @status
end

Instance Method Details

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

Attaches the volume to an instance.

Parameters:

  • instance (Instance) —

    The instance to which the volume attaches. The volume and instance must be within the same Availability Zone and the instance must be running.

  • device (String) —

    How the device is exposed to the instance (e.g., /dev/sdh, or xvdh).

Returns:

  • (Attachment) —

    An object representing the attachment, which you can use to query the attachment status.



121
122
123
124
125
126
127
128
129
 
# File 'lib/aws/ec2/volume.rb', line 121

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

Returns The collection of attachments that involve this volume.

Returns:



170
171
172
 
# File 'lib/aws/ec2/volume.rb', line 170

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

#availability_zone ⇒ AvailabilityZone

Returns the Availability Zone in which the volume was created.

Returns:

  • (AvailabilityZone) —

    Returns the Availability Zone in which the volume was created.



162
163
164
165
166
 
# File 'lib/aws/ec2/volume.rb', line 162

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

#create_snapshot(description = nil) ⇒ Snapshot

Returns A new snapshot created from the volume.

Parameters:

  • description (String) (defaults to: nil) —

    An optional description of the snapshot. May be up to 255 characters in length.

Returns:

  • (Snapshot) —

    A new snapshot created from the volume.



104
105
106
107
108
 
# File 'lib/aws/ec2/volume.rb', line 104

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.



95
96
97
98
 
# File 'lib/aws/ec2/volume.rb', line 95

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

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

Detaches the volume from an instance.

Parameters:

  • instance (Instance) —

    The instance to detach from.

  • device (String) —

    The device name.

  • options (Hash) (defaults to: {})

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.

Returns:

  • (Attachment) —

    Returns the no-longer valid attachment.



139
140
141
142
143
144
 
# File 'lib/aws/ec2/volume.rb', line 139

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

Returns True if the volume exists.

Returns:

  • (Boolean) —

    True if the volume exists.



147
148
149
150
151
152
 
# File 'lib/aws/ec2/volume.rb', line 147

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

#snapshot ⇒ Snapshot

Returns Snapshot from which the volume was created (may be nil).

Returns:

  • (Snapshot) —

    Snapshot from which the volume was created (may be nil).



156
157
158
 
# File 'lib/aws/ec2/volume.rb', line 156

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