com.amazonaws.services.identitymanagement.model
Class UploadServerCertificateRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.identitymanagement.model.UploadServerCertificateRequest

All Implemented Interfaces:

Serializable

public class UploadServerCertificateRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UploadServerCertificate operation.

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

For information about the number of server certificates you can upload, see Limitations on IAM Entities in Using AWS Identity and Access Management .

NOTE:Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in Using IAM.

See Also:

AmazonIdentityManagement.uploadServerCertificate(UploadServerCertificateRequest), Serialized Form

Constructor Summary

UploadServerCertificateRequest()
Default constructor for a new UploadServerCertificateRequest object.

UploadServerCertificateRequest(String serverCertificateName, String certificateBody, String privateKey)
Constructs a new UploadServerCertificateRequest object.

Method Summary

boolean	equals(Object obj)
String	getCertificateBody() The contents of the public key certificate in PEM-encoded format.
String	getCertificateChain() The contents of the certificate chain.
String	getPath() The path for the server certificate.
String	getPrivateKey() The contents of the private key in PEM-encoded format.
String	getServerCertificateName() The name for the server certificate.
int	hashCode()
void	setCertificateBody(String certificateBody) The contents of the public key certificate in PEM-encoded format.
void	setCertificateChain(String certificateChain) The contents of the certificate chain.
void	setPath(String path) The path for the server certificate.
void	setPrivateKey(String privateKey) The contents of the private key in PEM-encoded format.
void	setServerCertificateName(String serverCertificateName) The name for the server certificate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UploadServerCertificateRequest	withCertificateBody(String certificateBody) The contents of the public key certificate in PEM-encoded format.
UploadServerCertificateRequest	withCertificateChain(String certificateChain) The contents of the certificate chain.
UploadServerCertificateRequest	withPath(String path) The path for the server certificate.
UploadServerCertificateRequest	withPrivateKey(String privateKey) The contents of the private key in PEM-encoded format.
UploadServerCertificateRequest	withServerCertificateName(String serverCertificateName) The name for the server certificate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UploadServerCertificateRequest

public UploadServerCertificateRequest()

Default constructor for a new UploadServerCertificateRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

UploadServerCertificateRequest

public UploadServerCertificateRequest(String serverCertificateName,
                                      String certificateBody,
                                      String privateKey)

Constructs a new UploadServerCertificateRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

serverCertificateName - The name for the server certificate. Do not include the path in this value.

certificateBody - The contents of the public key certificate in PEM-encoded format.

privateKey - The contents of the private key in PEM-encoded format.

Method Detail

getPath

public String getPath()

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Returns:

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

setPath

public void setPath(String path)

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Parameters:

path - The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

withPath

public UploadServerCertificateRequest withPath(String path)

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

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

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Parameters:

path - The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Returns:

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

getServerCertificateName

public String getServerCertificateName()

The name for the server certificate. Do not include the path in this value.

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

Returns:

The name for the server certificate. Do not include the path in this value.

setServerCertificateName

public void setServerCertificateName(String serverCertificateName)

The name for the server certificate. Do not include the path in this value.

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

Parameters:

serverCertificateName - The name for the server certificate. Do not include the path in this value.

withServerCertificateName

public UploadServerCertificateRequest withServerCertificateName(String serverCertificateName)

The name for the server certificate. Do not include the path in this value.

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

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

Parameters:

serverCertificateName - The name for the server certificate. Do not include the path in this value.

Returns:

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

getCertificateBody

public String getCertificateBody()

The contents of the public key certificate in PEM-encoded format.

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

Returns:

The contents of the public key certificate in PEM-encoded format.

setCertificateBody

public void setCertificateBody(String certificateBody)

The contents of the public key certificate in PEM-encoded format.

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

Parameters:

certificateBody - The contents of the public key certificate in PEM-encoded format.

withCertificateBody

public UploadServerCertificateRequest withCertificateBody(String certificateBody)

The contents of the public key certificate in PEM-encoded format.

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

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

Parameters:

certificateBody - The contents of the public key certificate in PEM-encoded format.

Returns:

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

getPrivateKey

public String getPrivateKey()

The contents of the private key in PEM-encoded format.

Constraints:
Length: 1 - 16384
Pattern: [ -?]*

Returns:

The contents of the private key in PEM-encoded format.

setPrivateKey

public void setPrivateKey(String privateKey)

The contents of the private key in PEM-encoded format.

Constraints:
Length: 1 - 16384
Pattern: [ -?]*

Parameters:

privateKey - The contents of the private key in PEM-encoded format.

withPrivateKey

public UploadServerCertificateRequest withPrivateKey(String privateKey)

The contents of the private key in PEM-encoded format.

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

Constraints:
Length: 1 - 16384
Pattern: [ -?]*

Parameters:

privateKey - The contents of the private key in PEM-encoded format.

Returns:

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

getCertificateChain

public String getCertificateChain()

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

Constraints:
Length: 1 - 2097152
Pattern: [ -?]*

Returns:

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

setCertificateChain

public void setCertificateChain(String certificateChain)

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

Constraints:
Length: 1 - 2097152
Pattern: [ -?]*

Parameters:

certificateChain - The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

withCertificateChain

public UploadServerCertificateRequest withCertificateChain(String certificateChain)

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

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

Constraints:
Length: 1 - 2097152
Pattern: [ -?]*

Parameters:

certificateChain - The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

Returns:

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

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