Package software.amazon.awssdk.services.kms.model

Class DescribeKeyRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kms.model.DescribeKeyRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeKeyRequest.Builder,DescribeKeyRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeKeyRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeKeyRequest.Builder,DescribeKeyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeKeyRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeKeyRequest.Builder	builder()
boolean	equals(Object obj)
List<String>	grantTokens()	A list of grant tokens.
int	hashCode()
String	keyId()	A unique identifier for the customer master key.
static Class<? extends DescribeKeyRequest.Builder>	serializableBuilderClass()
DescribeKeyRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

keyId

public 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

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

grantTokens

public List<String> grantTokens()

A list of grant tokens.

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

Returns:

A list of grant tokens.

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

toBuilder

public DescribeKeyRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeKeyRequest.Builder,DescribeKeyRequest>

Returns:

a builder for type T

builder

public static DescribeKeyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeKeyRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object