com.amazonaws.services.identitymanagement.model

Class UpdateSSHPublicKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.UpdateSSHPublicKeyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateSSHPublicKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateSSHPublicKey operation.

Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action 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 action is 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 .

See Also:

AmazonIdentityManagement.updateSSHPublicKey(UpdateSSHPublicKeyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateSSHPublicKeyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateSSHPublicKeyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getSSHPublicKeyId() The unique identifier for the SSH public key.
String	getStatus() The status to assign to the SSH public key.
String	getUserName() The name of the IAM user associated with the SSH public key.
int	hashCode()
void	setSSHPublicKeyId(String sSHPublicKeyId) The unique identifier for the SSH public key.
void	setStatus(StatusType status) The status to assign to the SSH public key.
void	setStatus(String status) The status to assign to the SSH public key.
void	setUserName(String userName) The name of the IAM user associated with the SSH public key.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateSSHPublicKeyRequest	withSSHPublicKeyId(String sSHPublicKeyId) The unique identifier for the SSH public key.
UpdateSSHPublicKeyRequest	withStatus(StatusType status) The status to assign to the SSH public key.
UpdateSSHPublicKeyRequest	withStatus(String status) The status to assign to the SSH public key.
UpdateSSHPublicKeyRequest	withUserName(String userName) The name of the IAM user associated with the SSH public key.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateSSHPublicKeyRequest

public UpdateSSHPublicKeyRequest()

Method Detail

getUserName

public String getUserName()

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

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+

Returns:

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

setUserName

public void setUserName(String userName)

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

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+

Parameters:

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

withUserName

public UpdateSSHPublicKeyRequest withUserName(String userName)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSSHPublicKeyId

public String getSSHPublicKeyId()

The unique identifier for the SSH public key.

Constraints:
Length: 20 - 128
Pattern: [\w]+

Returns:

The unique identifier for the SSH public key.

setSSHPublicKeyId

public void setSSHPublicKeyId(String sSHPublicKeyId)

The unique identifier for the SSH public key.

Constraints:
Length: 20 - 128
Pattern: [\w]+

Parameters:

sSHPublicKeyId - The unique identifier for the SSH public key.

withSSHPublicKeyId

public UpdateSSHPublicKeyRequest withSSHPublicKeyId(String sSHPublicKeyId)

The unique identifier for the SSH public key.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 128
Pattern: [\w]+

Parameters:

sSHPublicKeyId - The unique identifier for the SSH public key.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()

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.

Constraints:
Allowed Values: Active, Inactive

Returns:

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.

See Also:

StatusType

setStatus

public void setStatus(String status)

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.

Constraints:
Allowed Values: Active, Inactive

Parameters:

status - 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.

See Also:

StatusType

withStatus

public UpdateSSHPublicKeyRequest withStatus(String status)

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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Active, Inactive

Parameters:

status - 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:

A reference to this updated object so that method calls can be chained together.

See Also:

StatusType

setStatus

public void setStatus(StatusType status)

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.

Constraints:
Allowed Values: Active, Inactive

Parameters:

status - 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.

See Also:

StatusType

withStatus

public UpdateSSHPublicKeyRequest withStatus(StatusType status)

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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Active, Inactive

Parameters:

status - 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:

A reference to this updated object so that method calls can be chained together.

See Also:

StatusType

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public UpdateSSHPublicKeyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()