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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#encoding ⇒ String

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) 


3443
3444
3445
3446
3447
3448
 
# File 'lib/aws-sdk-iam/types.rb', line 3443

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

#ssh_public_key_id ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


3443
3444
3445
3446
3447
3448
 
# File 'lib/aws-sdk-iam/types.rb', line 3443

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

#user_name ⇒ String

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: _+=,.@-

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


3443
3444
3445
3446
3447
3448
 
# File 'lib/aws-sdk-iam/types.rb', line 3443

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