1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
module AWS
class EC2
# Represents an Amazon EBS snapshot.
#
# @example Taking a snapshot from a volume
# snapshot = volume.create_snapshot("Database Backup 12/21/2010")
# sleep 1 until [:completed, :error].include?(snapshot.status)
#
# @example Managing snapshot permissions
# unless snapshot.public?
# snapshot.permissions.add("12345678901")
# end
#
# @attr_reader [String] volume_id The ID of the volume this
# snapshot was created from.
#
# @attr_reader [Symbol] status The status of the snapshot.
# Possible values:
#
# * `:pending`
# * `:completed`
# * `:error`
#
# @attr_reader [Time] start_time The time at which the snapshot
# was initiated.
#
# @attr_reader [Integer] progress The progress of the snapshot
# as a percentage.
#
# @attr_reader [String] owner_id The AWS account ID of the
# snapshot owner.
#
# @attr_reader [Integer] volume_size The size of the volume from
# which the snapshot was created.
#
# @attr_reader [String] description The description of the
# snapshot provided at snapshot initiation.
class Snapshot < Resource
include TaggedItem
include HasPermissions
# @api private
def initialize id, options = {}
@id = id
super(options)
end
# @return [String] Returns the snapshot's ID.
attr_reader :id
attribute :status, :to_sym => true
attribute :start_time, :static => true
attribute :progress do
translates_output {|value| value.to_i if value }
end
attribute :owner_id, :static => true
attribute :volume_size, :static => true
attribute :volume_id, :static => true
attribute :owner_alias, :static => true
attribute :description, :static => true
alias_method :create_volume_permissions, :permissions
populates_from(:create_snapshot) do |resp|
resp if resp.snapshot_id == id
end
populates_from(:describe_snapshots) do |resp|
resp.snapshot_index[id]
end
# Deletes the snapshot.
# @return [nil]
def delete
client.delete_snapshot(:snapshot_id => id)
nil
end
# Creates a volume from the snapshot.
#
# @param [AvailabilityZone or String] availability_zone The
# Availability Zone in which to create the new volume. See
# {EC2#availability_zones} for how to get a list of
# availability zones.
#
# @param [Hash] options Additional options for creating the volume
#
# @option options [Integer] size The desired size (in gigabytes)
# for the volume.
#
# @return [Volume] The newly created volume
def create_volume availability_zone, options = {}
volumes = VolumeCollection.new(:config => config)
volumes.create(options.merge(
:availability_zone => availability_zone,
:snapshot => self
))
end
# @return [Boolean] True if the snapshot exists.
def exists?
resp =
client.describe_snapshots(:filters => [{ :name => 'snapshot-id',
:values => [id] }]) and
!resp.snapshot_set.empty?
end
# @return [Volume] The volume this snapshot was created from.
def volume
Volume.new(volume_id, :config => config) if volume_id
end
# @api private
def __permissions_attribute__
"createVolumePermission"
end
end
end
end
|
