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

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 UpdateSSHPublicKeyRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)

12371
12372
12373
12374
12375
12376
12377
# File 'lib/aws-sdk-iam/types.rb', line 12371

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

#statusString

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

Returns:

  • (String)

12371
12372
12373
12374
12375
12376
12377
# File 'lib/aws-sdk-iam/types.rb', line 12371

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

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

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)

12371
12372
12373
12374
12375
12376
12377
# File 'lib/aws-sdk-iam/types.rb', line 12371

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