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

Interface GenerateDataKeyResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GenerateDataKeyResponse.Builder,GenerateDataKeyResponse>, KmsResponse.Builder, SdkBuilder<GenerateDataKeyResponse.Builder,GenerateDataKeyResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GenerateDataKeyResponse

@Mutable
@NotThreadSafe
public static interface GenerateDataKeyResponse.Builder
extends KmsResponse.Builder, SdkPojo, CopyableBuilder<GenerateDataKeyResponse.Builder,GenerateDataKeyResponse>

Method Summary

Modifier and Type	Method	Description
GenerateDataKeyResponse.Builder	ciphertextBlob(SdkBytes ciphertextBlob)	The encrypted copy of the data key.
GenerateDataKeyResponse.Builder	ciphertextForRecipient(SdkBytes ciphertextForRecipient)	The plaintext data key encrypted with the public key from the Nitro enclave.
GenerateDataKeyResponse.Builder	keyId(String keyId)	The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
GenerateDataKeyResponse.Builder	keyMaterialId(String keyMaterialId)	The identifier of the key material used to encrypt the data key.
GenerateDataKeyResponse.Builder	plaintext(SdkBytes plaintext)	The plaintext data key.

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

copy

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

ciphertextBlob

GenerateDataKeyResponse.Builder ciphertextBlob(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.

Parameters:

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:

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

plaintext

GenerateDataKeyResponse.Builder plaintext(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.

Parameters:

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:

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

keyId

GenerateDataKeyResponse.Builder keyId(String keyId)

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

Parameters:

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

Returns:

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

ciphertextForRecipient

GenerateDataKeyResponse.Builder ciphertextForRecipient(SdkBytes ciphertextForRecipient)

The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

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. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Parameters:

ciphertextForRecipient - The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

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. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Returns:

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

keyMaterialId

GenerateDataKeyResponse.Builder keyMaterialId(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.

Parameters:

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:

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