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

Class GenerateDataKeyResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kms.model.KmsResponse

software.amazon.awssdk.services.kms.model.GenerateDataKeyResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateDataKeyResponse.Builder,GenerateDataKeyResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateDataKeyResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GenerateDataKeyResponse.Builder	builder()
SdkBytes	ciphertextBlob()	The encrypted copy of the data key.
SdkBytes	ciphertextForRecipient()	The plaintext data key encrypted with the public key from the attestation document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
String	keyMaterialId()	The identifier of the key material used to encrypt the data key.
SdkBytes	plaintext()	The plaintext data key.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GenerateDataKeyResponse.Builder>	serializableBuilderClass()
GenerateDataKeyResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ciphertextBlob

public final SdkBytes ciphertextBlob()

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Returns:

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

plaintext

public final SdkBytes plaintext()

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

Returns:

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

keyId

public final String keyId()

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

Returns:

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

ciphertextForRecipient

public final SdkBytes ciphertextForRecipient()

The plaintext data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

Returns:

The plaintext data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

keyMaterialId

public final String keyMaterialId()

The identifier of the key material used to encrypt the data key. This field is omitted if the request includes the Recipient parameter.

Returns:

The identifier of the key material used to encrypt the data key. This field is omitted if the request includes the Recipient parameter.

toBuilder

public GenerateDataKeyResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateDataKeyResponse.Builder,GenerateDataKeyResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GenerateDataKeyResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo