com.amazonaws.services.kms.model

Class DisableKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DisableKeyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DisableKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DisableKey operation.

Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

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
DisableKeyRequest	clone()
boolean	equals(Object obj)
String	getKeyId() A unique identifier for the customer master key.
int	hashCode()
void	setKeyId(String keyId) A unique identifier for the customer master key.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DisableKeyRequest	withKeyId(String keyId) A unique identifier for the customer master 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

DisableKeyRequest

public DisableKeyRequest()

Method Detail

getKeyId

public String getKeyId()

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Constraints:
Length: 1 - 256

Returns:

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

setKeyId

public void setKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

withKeyId

public DisableKeyRequest withKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

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

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

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

clone

public DisableKeyRequest clone()

Overrides:

clone in class AmazonWebServiceRequest