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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetSSHPublicKeyRequest as input to an Aws::Client method, you can use a vanilla 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.

Possible values:

  • SSH
  • PEM

Returns:

  • (String)

    Specifies the public key encoding format to use in the response.

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

    The unique identifier for the SSH public key.

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

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