You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Actions collapse

Read-Only Attributes 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)


19
20
21
22
23
24
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 19

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

Instance Method Details

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::KeyPairInfo

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

Returns:



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

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.



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

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


key_pair_info.delete({
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

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


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

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

Returns:

  • (String)


39
40
41
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 39

def key_fingerprint
  data.key_fingerprint
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)


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

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)


29
30
31
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/key_pair_info.rb', line 29

def name
  @name
end