Class: Aws::EC2::KeyPair

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ KeyPair #initialize(options = {}) ⇒ KeyPair

Returns a new instance of KeyPair.

Overloads:

  • #initialize(name, options = {}) ⇒ KeyPair

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ KeyPair

    Options Hash (options):

    • :name (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#client ⇒ Client

Returns:



70
71
72
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 70

def client
  @client
end

#data ⇒ Types::KeyPair

Returns the data for this Aws::EC2::KeyPair.

Returns:

Raises:



85
86
87
88
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 85

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



93
94
95
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 93

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ Types::DeleteKeyPairResult

Examples:

Request syntax with placeholder values


key_pair.delete({
  key_pair_id: "KeyPairId",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :key_pair_id (String) —

    The ID of the key pair.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



213
214
215
216
217
218
219
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 213

def delete(options = {})
  options = options.merge(key_name: @name)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_key_pair(options)
  end
  resp.data
end

#key_fingerprint ⇒ String

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Returns:

  • (String) 


45
46
47
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 45

def key_fingerprint
  data[:key_fingerprint]
end

#key_material ⇒ String

An unencrypted PEM encoded RSA or ED25519 private key.

Returns:

  • (String) 


51
52
53
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 51

def key_material
  data[:key_material]
end

#key_pair_id ⇒ String

The ID of the key pair.

Returns:

  • (String) 


57
58
59
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 57

def key_pair_id
  data[:key_pair_id]
end

#name ⇒ String Also known as: key_name

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 33

def name
  @name
end

#tags ⇒ Array<Types::Tag>

Any tags applied to the key pair.

Returns:



63
64
65
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 63

def tags
  data[:tags]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

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(options) {|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

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair.rb', line 177

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end