Interface GenerateRandomResponse.Builder

All Superinterfaces:

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

Enclosing class:

GenerateRandomResponse

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

Method Summary

Modifier and Type	Method	Description
GenerateRandomResponse.Builder	ciphertextForRecipient(SdkBytes ciphertextForRecipient)	The plaintext random bytes encrypted with the public key from the attestation document.
GenerateRandomResponse.Builder	plaintext(SdkBytes plaintext)	The random byte string.

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 Details

plaintext

GenerateRandomResponse.Builder plaintext(SdkBytes plaintext)

The random byte string. 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 - The random byte string. 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.

ciphertextForRecipient

GenerateRandomResponse.Builder ciphertextForRecipient(SdkBytes ciphertextForRecipient)

The plaintext random bytes 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 random bytes 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.