com.amazonaws.services.identitymanagement.model

Class GetSSHPublicKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetSSHPublicKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetSSHPublicKey operation.

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved 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.getSSHPublicKey(GetSSHPublicKeyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetSSHPublicKeyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GetSSHPublicKeyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getEncoding() Specifies the public key encoding format to use in the response.
String	getSSHPublicKeyId() The unique identifier for the SSH public key.
String	getUserName() The name of the IAM user associated with the SSH public key.
int	hashCode()
void	setEncoding(EncodingType encoding) Specifies the public key encoding format to use in the response.
void	setEncoding(String encoding) Specifies the public key encoding format to use in the response.
void	setSSHPublicKeyId(String sSHPublicKeyId) The unique identifier for 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.
GetSSHPublicKeyRequest	withEncoding(EncodingType encoding) Specifies the public key encoding format to use in the response.
GetSSHPublicKeyRequest	withEncoding(String encoding) Specifies the public key encoding format to use in the response.
GetSSHPublicKeyRequest	withSSHPublicKeyId(String sSHPublicKeyId) The unique identifier for the SSH public key.
GetSSHPublicKeyRequest	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

GetSSHPublicKeyRequest

public GetSSHPublicKeyRequest()

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

getEncoding

public String getEncoding()

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Constraints:
Allowed Values: SSH, PEM

Returns:

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

See Also:

EncodingType

setEncoding

public void setEncoding(String encoding)

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Constraints:
Allowed Values: SSH, PEM

Parameters:

encoding - Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

See Also:

EncodingType

withEncoding

public GetSSHPublicKeyRequest withEncoding(String encoding)

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

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

Constraints:
Allowed Values: SSH, PEM

Parameters:

encoding - Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Returns:

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

See Also:

EncodingType

setEncoding

public void setEncoding(EncodingType encoding)

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Constraints:
Allowed Values: SSH, PEM

Parameters:

encoding - Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

See Also:

EncodingType

withEncoding

public GetSSHPublicKeyRequest withEncoding(EncodingType encoding)

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

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

Constraints:
Allowed Values: SSH, PEM

Parameters:

encoding - Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

Returns:

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

See Also:

EncodingType

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 GetSSHPublicKeyRequest 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()