Interface GenerateRandomRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GenerateRandomRequest.Builder,GenerateRandomRequest>, KmsRequest.Builder, SdkBuilder<GenerateRandomRequest.Builder,GenerateRandomRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GenerateRandomRequest
public static interface GenerateRandomRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateRandomRequest.Builder,GenerateRandomRequest>

  • Method Details

    • numberOfBytes

      GenerateRandomRequest.Builder numberOfBytes(Integer numberOfBytes)

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

      Parameters:
      numberOfBytes - The length of the random byte string. This parameter is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customKeyStoreId

      GenerateRandomRequest.Builder customKeyStoreId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recipient

      GenerateRandomRequest.Builder recipient(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recipient

      default GenerateRandomRequest.Builder recipient(Consumer<RecipientInfo.Builder> 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.

      This is a convenience method that creates an instance of the RecipientInfo.Builder avoiding the need to create one manually via RecipientInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recipient(RecipientInfo).

      Parameters:
      recipient - a consumer that will call methods on RecipientInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GenerateRandomRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GenerateRandomRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.