Class: Aws::EC2::KeyPair
- Inherits:
-
Object
- Object
- Aws::EC2::KeyPair
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/key_pair.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#key_fingerprint ⇒ String
The SHA-1 digest of the DER encoded private key.
-
#key_material ⇒ String
An unencrypted PEM encoded RSA private key.
- #name ⇒ String (also: #key_name)
Actions collapse
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::KeyPair
Returns the data for this KeyPair.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ KeyPair
constructor
A new instance of KeyPair.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ KeyPair #initialize(options = {}) ⇒ KeyPair
Returns a new instance of KeyPair.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#data ⇒ Types::KeyPair
Returns the data for this Aws::EC2::KeyPair.
64 65 66 67 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 64 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
72 73 74 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 72 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
185 186 187 188 189 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 185 def delete( = {}) = .merge(key_name: @name) resp = @client.delete_key_pair() resp.data 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.
193 194 195 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 193 def identifiers { name: @name } end |
#key_fingerprint ⇒ String
The SHA-1 digest of the DER encoded private key.
36 37 38 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 36 def key_fingerprint data[:key_fingerprint] end |
#key_material ⇒ String
An unencrypted PEM encoded RSA private key.
42 43 44 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 42 def key_material data[:key_material] end |
#load ⇒ Object Also known as: reload
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.
55 56 57 58 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 55 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#name ⇒ String Also known as: key_name
29 30 31 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 29 def name @name 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
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/aws-sdk-ec2/key_pair.rb', line 154 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 |