iam_upload_ssh_public_key: Uploads an SSH public key and associates it with the...

Description Usage Arguments Details Request syntax

View source: R/iam_operations.R

Description

Uploads an SSH public key and associates it with the specified IAM user.

Usage

1
iam_upload_ssh_public_key(UserName, SSHPublicKeyBody)

Arguments

UserName

[required] 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: \_+=,[email protected]

SSHPublicKeyBody

[required] 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 (U+0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through U+00FF)

  • The special characters tab (U+0009), line feed (U+000A), and carriage return (U+000D)

Details

The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

Request syntax

1
2
3
4
svc$upload_ssh_public_key(
  UserName = "string",
  SSHPublicKeyBody = "string"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.