com.amazonaws.services.kms.model

Class DescribeKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DescribeKeyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeKeyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeKeyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getGrantTokens() A list of grant tokens.
String	getKeyId() A unique identifier for the customer master key.
int	hashCode()
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens.
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.
DescribeKeyRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens.
DescribeKeyRequest	withGrantTokens(String... grantTokens) A list of grant tokens.
DescribeKeyRequest	withKeyId(String keyId) A unique identifier for the customer master key.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeKeyRequest

public DescribeKeyRequest()

Method Detail

setKeyId

public void setKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

getKeyId

public String getKeyId()

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

Returns:

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

withKeyId

public DescribeKeyRequest withKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

Returns:

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

getGrantTokens

public List<String> getGrantTokens()

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

withGrantTokens

public DescribeKeyRequest withGrantTokens(String... grantTokens)

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use setGrantTokens(java.util.Collection) or withGrantTokens(java.util.Collection) if you want to override the existing values.

Parameters:

grantTokens - A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

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

withGrantTokens

public DescribeKeyRequest withGrantTokens(Collection<String> grantTokens)

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeKeyRequest 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()