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

Class: Aws::IAM::Types::GetSSHPublicKeyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass GetSSHPublicKeyRequest data as a hash:

{
  user_name: "userNameType", # required
  ssh_public_key_id: "publicKeyIdType", # required
  encoding: "SSH", # required, accepts SSH, PEM
}

Instance Attribute Summary collapse

Instance Attribute Details

#encodingString

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Returns:

  • (String)


3308
3309
3310
3311
3312
3313
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3308

class GetSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_id,
  :encoding)
  include Aws::Structure
end

#ssh_public_key_idString

The unique identifier for the SSH public key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Returns:

  • (String)


3308
3309
3310
3311
3312
3313
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3308

class GetSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_id,
  :encoding)
  include Aws::Structure
end

#user_nameString

The name of the IAM user associated with the SSH public key.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:

  • (String)


3308
3309
3310
3311
3312
3313
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 3308

class GetSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_id,
  :encoding)
  include Aws::Structure
end