Class: Aws::EC2::Snapshot
- Inherits:
-
Object
- Object
- Aws::EC2::Snapshot
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/snapshot.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#data_encryption_key_id ⇒ String
The data encryption key identifier for the snapshot.
-
#description ⇒ String
The description for the snapshot.
-
#encrypted ⇒ Boolean
Indicates whether the snapshot is encrypted.
- #id ⇒ String (also: #snapshot_id)
-
#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 parent volume.
-
#owner_alias ⇒ String
Value from an Amazon-maintained list (‘amazon` | `aws-marketplace` | `microsoft`) of snapshot owners.
-
#owner_id ⇒ String
The AWS account ID of the EBS snapshot owner.
-
#progress ⇒ String
The progress of the snapshot, as a percentage.
-
#start_time ⇒ Time
The time stamp when the snapshot was initiated.
-
#state ⇒ String
The snapshot state.
-
#state_message ⇒ String
Encrypted Amazon EBS snapshots are copied asynchronously.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the snapshot.
-
#volume_id ⇒ String
The ID of the volume that was used to create the snapshot.
-
#volume_size ⇒ Integer
The size of the volume, in GiB.
Actions collapse
- #copy(options = {}) ⇒ Types::CopySnapshotResult
- #create_tags(options = {}) ⇒ Tag::Collection
- #delete(options = {}) ⇒ EmptyStructure
- #describe_attribute(options = {}) ⇒ Types::DescribeSnapshotAttributeResult
- #modify_attribute(options = {}) ⇒ EmptyStructure
- #reset_attribute(options = {}) ⇒ EmptyStructure
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #volume ⇒ Volume?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Snapshot
Returns the data for this Snapshot.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ Snapshot
constructor
A new instance of Snapshot.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
- #wait_until_completed(options = {}) ⇒ Snapshot
Constructor Details
#initialize(id, options = {}) ⇒ Snapshot #initialize(options = {}) ⇒ Snapshot
Returns a new instance of Snapshot.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/snapshot.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
#copy(options = {}) ⇒ Types::CopySnapshotResult
370 371 372 373 374 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 370 def copy( = {}) = .merge(source_snapshot_id: @id) resp = @client.copy_snapshot() resp.data end |
#create_tags(options = {}) ⇒ Tag::Collection
398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 398 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 |
#data ⇒ Types::Snapshot
Returns the data for this Aws::EC2::Snapshot. Calls Client#describe_snapshots if #data_loaded? is ‘false`.
152 153 154 155 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 152 def data load unless @data @data end |
#data_encryption_key_id ⇒ String
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.
42 43 44 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 42 def data_encryption_key_id data[:data_encryption_key_id] end |
#data_loaded? ⇒ Boolean
160 161 162 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 160 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
425 426 427 428 429 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 425 def delete( = {}) = .merge(snapshot_id: @id) resp = @client.delete_snapshot() resp.data end |
#describe_attribute(options = {}) ⇒ Types::DescribeSnapshotAttributeResult
446 447 448 449 450 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 446 def describe_attribute( = {}) = .merge(snapshot_id: @id) resp = @client.describe_snapshot_attribute() resp.data end |
#description ⇒ String
The description for the snapshot.
48 49 50 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 48 def description data[:description] end |
#encrypted ⇒ Boolean
Indicates whether the snapshot is encrypted.
54 55 56 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 54 def encrypted data[:encrypted] end |
#id ⇒ String Also known as: snapshot_id
29 30 31 |
# File 'lib/aws-sdk-ec2/snapshot.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.
537 538 539 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 537 def identifiers { id: @id } 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 parent volume.
62 63 64 |
# File 'lib/aws-sdk-ec2/snapshot.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::Snapshot. Returns ‘self` making it possible to chain methods.
snapshot.reload.data
142 143 144 145 146 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 142 def load resp = @client.describe_snapshots(snapshot_ids: [@id]) @data = resp.snapshots[0] self end |
#modify_attribute(options = {}) ⇒ EmptyStructure
493 494 495 496 497 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 493 def modify_attribute( = {}) = .merge(snapshot_id: @id) resp = @client.modify_snapshot_attribute() resp.data end |
#owner_alias ⇒ String
Value from an Amazon-maintained list (‘amazon` | `aws-marketplace` | `microsoft`) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
119 120 121 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 119 def owner_alias data[:owner_alias] end |
#owner_id ⇒ String
The AWS account ID of the EBS snapshot owner.
68 69 70 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 68 def owner_id data[:owner_id] end |
#progress ⇒ String
The progress of the snapshot, as a percentage.
74 75 76 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 74 def progress data[:progress] end |
#reset_attribute(options = {}) ⇒ EmptyStructure
515 516 517 518 519 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 515 def reset_attribute( = {}) = .merge(snapshot_id: @id) resp = @client.reset_snapshot_attribute() resp.data end |
#start_time ⇒ Time
The time stamp when the snapshot was initiated.
80 81 82 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 80 def start_time data[:start_time] end |
#state ⇒ String
The snapshot state.
86 87 88 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 86 def state data[:state] end |
#state_message ⇒ String
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.
97 98 99 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 97 def data[:state_message] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the snapshot.
125 126 127 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 125 def data[:tags] end |
#volume ⇒ Volume?
524 525 526 527 528 529 530 531 532 533 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 524 def volume if data[:volume_id] Volume.new( id: data[:volume_id], client: @client ) else nil end end |
#volume_id ⇒ String
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
105 106 107 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 105 def volume_id data[:volume_id] end |
#volume_size ⇒ Integer
The size of the volume, in GiB.
111 112 113 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 111 def volume_size data[:volume_size] 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
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 260 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 |
#wait_until_completed(options = {}) ⇒ Snapshot
170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/aws-sdk-ec2/snapshot.rb', line 170 def wait_until_completed( = {}) , params = () waiter = Waiters::SnapshotCompleted.new() yield_waiter_and_warn(waiter, &Proc.new) if block_given? resp = waiter.wait(params.merge(snapshot_ids: [@id])) Snapshot.new({ id: @id, data: resp.data.snapshots[0], client: @client }) end |