| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IAM.UpdateSSHPublicKey
Description
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
Synopsis
- data UpdateSSHPublicKey = UpdateSSHPublicKey' {
- userName :: Text
- sSHPublicKeyId :: Text
- status :: StatusType
- newUpdateSSHPublicKey :: Text -> Text -> StatusType -> UpdateSSHPublicKey
- updateSSHPublicKey_userName :: Lens' UpdateSSHPublicKey Text
- updateSSHPublicKey_sSHPublicKeyId :: Lens' UpdateSSHPublicKey Text
- updateSSHPublicKey_status :: Lens' UpdateSSHPublicKey StatusType
- data UpdateSSHPublicKeyResponse = UpdateSSHPublicKeyResponse' {
- newUpdateSSHPublicKeyResponse :: UpdateSSHPublicKeyResponse
Creating a Request
data UpdateSSHPublicKey Source #
See: newUpdateSSHPublicKey smart constructor.
Constructors
| UpdateSSHPublicKey' | |
Fields
| |
Instances
newUpdateSSHPublicKey Source #
Arguments
| :: Text | |
| -> Text | |
| -> StatusType | |
| -> UpdateSSHPublicKey |
Create a value of UpdateSSHPublicKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userName:UpdateSSHPublicKey', updateSSHPublicKey_userName - 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: _+=,.@-
$sel:sSHPublicKeyId:UpdateSSHPublicKey', updateSSHPublicKey_sSHPublicKeyId - 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.
$sel:status:UpdateSSHPublicKey', updateSSHPublicKey_status - 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.
Request Lenses
updateSSHPublicKey_userName :: Lens' UpdateSSHPublicKey Text Source #
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: _+=,.@-
updateSSHPublicKey_sSHPublicKeyId :: Lens' UpdateSSHPublicKey Text Source #
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.
updateSSHPublicKey_status :: Lens' UpdateSSHPublicKey StatusType Source #
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.
Destructuring the Response
data UpdateSSHPublicKeyResponse Source #
See: newUpdateSSHPublicKeyResponse smart constructor.
Constructors
| UpdateSSHPublicKeyResponse' | |
Instances
newUpdateSSHPublicKeyResponse :: UpdateSSHPublicKeyResponse Source #
Create a value of UpdateSSHPublicKeyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.