Class: Aws::EC2::KeyPairInfo

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of KeyPairInfo.

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ KeyPairInfo

    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_info.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

#clientClient

Returns:



108
109
110
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 108

def client
  @client
end

#create_timeTime

If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.

If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.

Returns:

  • (Time)


101
102
103
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 101

def create_time
  data[:create_time]
end

#dataTypes::KeyPairInfo

Returns the data for this Aws::EC2::KeyPairInfo. Calls Client#describe_key_pairs if #data_loaded? is false.

Returns:



128
129
130
131
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 128

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.



136
137
138
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 136

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


key_pair_info.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:

  • (EmptyStructure)


254
255
256
257
258
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 254

def delete(options = {})
  options = options.merge(key_name: @name)
  resp = @client.delete_key_pair(options)
  resp.data
end

#key_fingerprintString

If you used CreateKeyPair to create the key pair:

  • 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.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • 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)


67
68
69
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 67

def key_fingerprint
  data[:key_fingerprint]
end

#key_pair_idString

The ID of the key pair.

Returns:

  • (String)


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

#key_typeString

The type of key pair.

Returns:

  • (String)


73
74
75
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 73

def key_type
  data[:key_type]
end

#loadself 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

Returns:

  • (self)


118
119
120
121
122
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 118

def load
  resp = @client.describe_key_pairs(key_names: [@name])
  @data = resp.key_pairs[0]
  self
end

#nameString Also known as: key_name

Returns:

  • (String)


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

def name
  @name
end

#public_keyString

The public key material.

Returns:

  • (String)


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

def public_key
  data[:public_key]
end

#tagsArray<Types::Tag>

Any tags applied to the key pair.

Returns:



79
80
81
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 79

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 220

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::Waiters::Waiter.new(options).wait({})
end