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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass UpdateSSHPublicKeyRequest data as a 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 (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Returns:

  • (String)


8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8223

class UpdateSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_id,
  :status)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8223

class UpdateSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_id,
  :status)
  include Aws::Structure
end

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


8223
8224
8225
8226
8227
8228
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8223

class UpdateSSHPublicKeyRequest < Struct.new(
  :user_name,
  :ssh_public_key_id,
  :status)
  include Aws::Structure
end