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

Interface DecryptResponse.Builder

All Superinterfaces:

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

Enclosing class:

DecryptResponse

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

Method Summary

Modifier and Type	Method	Description
DecryptResponse.Builder	ciphertextForRecipient(SdkBytes ciphertextForRecipient)	The plaintext data encrypted with the public key from the attestation document.
DecryptResponse.Builder	encryptionAlgorithm(String encryptionAlgorithm)	The encryption algorithm that was used to decrypt the ciphertext.
DecryptResponse.Builder	encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)	The encryption algorithm that was used to decrypt the ciphertext.
DecryptResponse.Builder	keyId(String keyId)	The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
DecryptResponse.Builder	keyMaterialId(String keyMaterialId)	The identifier of the key material used to decrypt the ciphertext.
DecryptResponse.Builder	plaintext(SdkBytes plaintext)	Decrypted plaintext data.

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

keyId

DecryptResponse.Builder keyId(String keyId)

The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

Parameters:

keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

Returns:

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

plaintext

DecryptResponse.Builder plaintext(SdkBytes plaintext)

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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

Parameters:

plaintext - Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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.

encryptionAlgorithm

DecryptResponse.Builder encryptionAlgorithm(String encryptionAlgorithm)

The encryption algorithm that was used to decrypt the ciphertext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

Returns:

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

See Also:

EncryptionAlgorithmSpec, EncryptionAlgorithmSpec

encryptionAlgorithm

DecryptResponse.Builder encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)

The encryption algorithm that was used to decrypt the ciphertext.

Parameters:

encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

Returns:

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

See Also:

EncryptionAlgorithmSpec, EncryptionAlgorithmSpec

ciphertextForRecipient

DecryptResponse.Builder ciphertextForRecipient(SdkBytes ciphertextForRecipient)

The plaintext data 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.

Parameters:

ciphertextForRecipient - The plaintext data 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:

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

keyMaterialId

DecryptResponse.Builder keyMaterialId(String keyMaterialId)

The identifier of the key material used to decrypt the ciphertext. This field is present only when the operation uses a symmetric encryption KMS key. This field is omitted if the request includes the Recipient parameter.

Parameters:

keyMaterialId - The identifier of the key material used to decrypt the ciphertext. This field is present only when the operation uses a symmetric encryption KMS 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.