Class: Aws::IAM::Types::UploadSSHPublicKeyRequest

Inherits:

Struct

Object
Struct
Aws::IAM::Types::UploadSSHPublicKeyRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iam/types.rb

Overview

Note:

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

{
  user_name: "userNameType", # required
  ssh_public_key_body: "publicKeyMaterialType", # required
}

Instance Attribute Summary collapse

#ssh_public_key_body ⇒ String

The SSH public key.
#user_name ⇒ String

The name of the IAM user to associate the SSH public key with.

Instance Attribute Details

#ssh_public_key_body ⇒ `String`

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The [regex pattern] used to validate this parameter is a string of characters consisting of the following:

Any printable ASCII character ranging from the space character (‘u0020`) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through ‘u00FF`)
The special characters tab (‘u0009`), line feed (`u000A`), and carriage return (`u000D`)

[1]: wikipedia.org/wiki/regex

Returns:

(String)

# File 'lib/aws-sdk-iam/types.rb', line 11008

class UploadSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_body)
  include Aws::Structure
end

#user_name ⇒ `String`

The name of the IAM user to associate the SSH public key with.

This parameter allows (through 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: _+=,.@-