AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::IAM::Types::UpdateSSHPublicKeyRequest

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

Overview

Note:

When passing UpdateSSHPublicKeyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_name: "userNameType", # required
  ssh_public_key_id: "publicKeyIdType", # required
  status: "Active", # required, accepts Active, Inactive
}

Instance Attribute Summary collapse

Instance Attribute Details

#ssh_public_key_idString

The unique identifier for the SSH public key.

This parameter allows (through 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.

#statusString

The status to assign to the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used.

Possible values:

  • Active
  • Inactive

Returns:

  • (String)

    The status to assign to the SSH public key.

#user_nameString

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

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

Returns:

  • (String)

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