com.amazonaws.services.kms.model

Class DisableKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DisableKeyRequest

All Implemented Interfaces:

Serializable

public class DisableKeyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DisableKey operation.

Marks a key as disabled, thereby preventing its use.

See Also:

AWSKMS.disableKey(DisableKeyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DisableKeyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getKeyId() Unique identifier of the customer master key to be disabled.
int	hashCode()
void	setKeyId(String keyId) Unique identifier of the customer master key to be disabled.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DisableKeyRequest	withKeyId(String keyId) Unique identifier of the customer master key to be disabled.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DisableKeyRequest

public DisableKeyRequest()

Method Detail

getKeyId

public String getKeyId()

Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.

Constraints:
Length: 1 - 256

Returns:

Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.

setKeyId

public void setKeyId(String keyId)

Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.

withKeyId

public DisableKeyRequest withKeyId(String keyId)

Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.

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

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.

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