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

Class GenerateRandomRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.GenerateRandomRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateRandomRequest.Builder,GenerateRandomRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateRandomRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GenerateRandomRequest.Builder	builder()
String	customKeyStoreId()	Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfBytes()	The length of the random byte string.
RecipientInfo	recipient()	A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key.
List<SdkField<?>>	sdkFields()
static Class<? extends GenerateRandomRequest.Builder>	serializableBuilderClass()
GenerateRandomRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

numberOfBytes

public final Integer numberOfBytes()

The length of the random byte string. This parameter is required.

Returns:

The length of the random byte string. This parameter is required.

customKeyStoreId

public final String customKeyStoreId()

Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

External key store IDs are not valid for this parameter. If you specify the ID of an external key store, GenerateRandom throws an UnsupportedOperationException.

Returns:

Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

External key store IDs are not valid for this parameter. If you specify the ID of an external key store, GenerateRandom throws an UnsupportedOperationException.

recipient

public final RecipientInfo recipient()

A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

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:

A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

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.

toBuilder

public GenerateRandomRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateRandomRequest.Builder,GenerateRandomRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static GenerateRandomRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo