Class: Aws::EC2::KeyPairInfo
- Inherits:
-
Object
- Object
- Aws::EC2::KeyPairInfo
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#key_fingerprint ⇒ String
If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key.
-
#key_pair_id ⇒ String
The ID of the key pair.
-
#name ⇒ String
(also: #key_name)
-
#tags ⇒ Array<Types::Tag>
Any tags applied to the key pair.
Actions collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::KeyPairInfo
Returns the data for this KeyPairInfo.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ KeyPairInfo
constructor
A new instance of KeyPairInfo.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current KeyPairInfo.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ KeyPairInfo #initialize(options = {}) ⇒ KeyPairInfo
Returns a new instance of KeyPairInfo.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#client ⇒ Client
62 63 64 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 62 def client @client end |
#data ⇒ Types::KeyPairInfo
Returns the data for this Aws::EC2::KeyPairInfo. Calls
Client#describe_key_pairs if #data_loaded? is false
.
82 83 84 85 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 82 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
90 91 92 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 90 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
208 209 210 211 212 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 208 def delete( = {}) = .merge(key_name: @name) resp = @client.delete_key_pair() resp.data end |
#key_fingerprint ⇒ String
If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
49 50 51 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 49 def key_fingerprint data[:key_fingerprint] end |
#key_pair_id ⇒ String
The ID of the key pair.
40 41 42 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 40 def key_pair_id data[:key_pair_id] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::KeyPairInfo.
Returns self
making it possible to chain methods.
key_pair_info.reload.data
72 73 74 75 76 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 72 def load resp = @client.describe_key_pairs(key_names: [@name]) @data = resp.key_pairs[0] self end |
#name ⇒ String Also known as: key_name
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 33 def name @name end |
#tags ⇒ Array<Types::Tag>
Any tags applied to the key pair.
55 56 57 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 55 def data[:tags] end |
#wait_until(options = {}) {|resource| ... } ⇒ 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) do |instance|
instance.state.name == 'running'
end
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
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 174 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 |