com.amazonaws.services.identitymanagement.model

Class UpdateSigningCertificateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateRequest

All Implemented Interfaces:

Serializable

public class UpdateSigningCertificateRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateSigningCertificate operation.

Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS Access Key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

For information about rotating certificates, see Managing Keys and Certificates in Using AWS Identity and Access Management .

See Also:

AmazonIdentityManagement.updateSigningCertificate(UpdateSigningCertificateRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateSigningCertificateRequest() Default constructor for a new UpdateSigningCertificateRequest object.
UpdateSigningCertificateRequest(String certificateId, StatusType status) Constructs a new UpdateSigningCertificateRequest object.
UpdateSigningCertificateRequest(String certificateId, String status) Constructs a new UpdateSigningCertificateRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCertificateId() The ID of the signing certificate you want to update.
String	getStatus() The status you want to assign to the certificate.
String	getUserName() Name of the user the signing certificate belongs to.
int	hashCode()
void	setCertificateId(String certificateId) The ID of the signing certificate you want to update.
void	setStatus(StatusType status) The status you want to assign to the certificate.
void	setStatus(String status) The status you want to assign to the certificate.
void	setUserName(String userName) Name of the user the signing certificate belongs to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateSigningCertificateRequest	withCertificateId(String certificateId) The ID of the signing certificate you want to update.
UpdateSigningCertificateRequest	withStatus(StatusType status) The status you want to assign to the certificate.
UpdateSigningCertificateRequest	withStatus(String status) The status you want to assign to the certificate.
UpdateSigningCertificateRequest	withUserName(String userName) Name of the user the signing certificate belongs to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateSigningCertificateRequest

public UpdateSigningCertificateRequest()

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

UpdateSigningCertificateRequest

public UpdateSigningCertificateRequest(String certificateId,
                               String status)

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

Parameters:

certificateId - The ID of the signing certificate you want to update.

status - The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

UpdateSigningCertificateRequest

public UpdateSigningCertificateRequest(String certificateId,
                               StatusType status)

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

Parameters:

certificateId - The ID of the signing certificate you want to update.

status - The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

Method Detail

getUserName

public String getUserName()

Name of the user the signing certificate belongs to.

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

Returns:

Name of the user the signing certificate belongs to.

setUserName

public void setUserName(String userName)

Name of the user the signing certificate belongs to.

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

Parameters:

userName - Name of the user the signing certificate belongs to.

withUserName

public UpdateSigningCertificateRequest withUserName(String userName)

Name of the user the signing certificate belongs to.

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

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

Parameters:

userName - Name of the user the signing certificate belongs to.

Returns:

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

getCertificateId

public String getCertificateId()

The ID of the signing certificate you want to update.

Constraints:
Length: 24 - 128
Pattern: [\w]*

Returns:

The ID of the signing certificate you want to update.

setCertificateId

public void setCertificateId(String certificateId)

The ID of the signing certificate you want to update.

Constraints:
Length: 24 - 128
Pattern: [\w]*

Parameters:

certificateId - The ID of the signing certificate you want to update.

withCertificateId

public UpdateSigningCertificateRequest withCertificateId(String certificateId)

The ID of the signing certificate you want to update.

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

Constraints:
Length: 24 - 128
Pattern: [\w]*

Parameters:

certificateId - The ID of the signing certificate you want to update.

Returns:

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

getStatus

public String getStatus()

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

Constraints:
Allowed Values: Active, Inactive

Returns:

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

See Also:

StatusType

setStatus

public void setStatus(String status)

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

Constraints:
Allowed Values: Active, Inactive

Parameters:

status - The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

See Also:

StatusType

withStatus

public UpdateSigningCertificateRequest withStatus(String status)

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate 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 you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate 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 you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

Constraints:
Allowed Values: Active, Inactive

Parameters:

status - The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

See Also:

StatusType

withStatus

public UpdateSigningCertificateRequest withStatus(StatusType status)

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate 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 you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate 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